log4r 1.1.1 → 1.1.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (107) hide show
  1. data/README +3 -3
  2. data/Rakefile +3 -3
  3. data/doc/rdoc-log4r.css +696 -0
  4. data/examples/syslogcustom.rb +6 -1
  5. data/src/doc/Log4r.html +392 -0
  6. data/src/doc/Log4r/BasicFormatter.html +370 -0
  7. data/src/doc/Log4r/ConfigError.html +207 -0
  8. data/src/doc/Log4r/Configurator.html +1050 -0
  9. data/src/doc/Log4r/DateFileOutputter.html +454 -0
  10. data/src/doc/Log4r/DefaultFormatter.html +205 -0
  11. data/src/doc/Log4r/EmailOutputter.html +636 -0
  12. data/src/doc/Log4r/FileOutputter.html +321 -0
  13. data/src/doc/Log4r/Formatter.html +291 -0
  14. data/src/doc/Log4r/IOOutputter.html +392 -0
  15. data/src/doc/Log4r/Log4rConfig.html +193 -0
  16. data/src/doc/Log4r/Log4rTools.html +370 -0
  17. data/src/doc/Log4r/LogEvent.html +360 -0
  18. data/src/doc/Log4r/LogServer.html +322 -0
  19. data/src/doc/Log4r/Logger.html +1132 -0
  20. data/src/doc/Log4r/Logger/LoggerFactory.html +200 -0
  21. data/src/doc/Log4r/Logger/Repository.html +207 -0
  22. data/src/doc/Log4r/ObjectFormatter.html +262 -0
  23. data/src/doc/Log4r/Outputter.html +910 -0
  24. data/src/doc/Log4r/Outputter/OutputterFactory.html +200 -0
  25. data/src/doc/Log4r/Outputter/consoleoutputters_rb.html +57 -0
  26. data/src/doc/Log4r/Outputter/datefileoutputter_rb.html +93 -0
  27. data/src/doc/Log4r/Outputter/emailoutputter_rb.html +179 -0
  28. data/src/doc/Log4r/Outputter/fileoutputter_rb.html +64 -0
  29. data/src/doc/Log4r/Outputter/iooutputter_rb.html +59 -0
  30. data/src/doc/Log4r/Outputter/outputter_rb.html +222 -0
  31. data/src/doc/Log4r/Outputter/outputterfactory_rb.html +62 -0
  32. data/src/doc/Log4r/Outputter/remoteoutputter_rb.html +59 -0
  33. data/src/doc/Log4r/Outputter/rollingfileoutputter_rb.html +66 -0
  34. data/src/doc/Log4r/Outputter/staticoutputter_rb.html +55 -0
  35. data/src/doc/Log4r/Outputter/syslogoutputter_rb.html +110 -0
  36. data/src/doc/Log4r/Outputter/tst_rb.html +54 -0
  37. data/src/doc/Log4r/PatternFormatter.html +422 -0
  38. data/src/doc/Log4r/ROMPClient.html +193 -0
  39. data/src/doc/Log4r/ROMPServer.html +193 -0
  40. data/src/doc/Log4r/RemoteOutputter.html +384 -0
  41. data/src/doc/Log4r/RollingFileOutputter.html +528 -0
  42. data/src/doc/Log4r/RootLogger.html +512 -0
  43. data/src/doc/Log4r/SimpleFormatter.html +258 -0
  44. data/src/doc/Log4r/StderrOutputter.html +250 -0
  45. data/src/doc/Log4r/StdoutOutputter.html +250 -0
  46. data/src/doc/Log4r/SyslogOutputter.html +533 -0
  47. data/src/doc/Log4r/YamlConfigurator.html +948 -0
  48. data/src/doc/Log4r/base_rb.html +57 -0
  49. data/src/doc/Log4r/config_rb.html +76 -0
  50. data/src/doc/Log4r/configurator_rb.html +370 -0
  51. data/src/doc/Log4r/formatter/formatter_rb.html +121 -0
  52. data/src/doc/Log4r/formatter/patternformatter_rb.html +233 -0
  53. data/src/doc/Log4r/lib/drbloader_rb.html +57 -0
  54. data/src/doc/Log4r/lib/xmlloader_rb.html +57 -0
  55. data/src/doc/Log4r/logevent_rb.html +55 -0
  56. data/src/doc/Log4r/logger_rb.html +293 -0
  57. data/src/doc/Log4r/loggerfactory_rb.html +66 -0
  58. data/src/doc/Log4r/logserver_rb.html +161 -0
  59. data/src/doc/Log4r/rdoc/configurator.html +444 -0
  60. data/src/doc/Log4r/rdoc/emailoutputter.html +261 -0
  61. data/src/doc/Log4r/rdoc/formatter.html +200 -0
  62. data/src/doc/Log4r/rdoc/log4r.html +268 -0
  63. data/src/doc/Log4r/rdoc/logger.html +364 -0
  64. data/src/doc/Log4r/rdoc/logserver.html +247 -0
  65. data/src/doc/Log4r/rdoc/outputter.html +295 -0
  66. data/src/doc/Log4r/rdoc/patternformatter.html +313 -0
  67. data/src/doc/Log4r/rdoc/syslogoutputter.html +179 -0
  68. data/src/doc/Log4r/rdoc/yamlconfigurator.html +169 -0
  69. data/src/doc/Log4r/repository_rb.html +62 -0
  70. data/src/doc/Log4r/staticlogger_rb.html +55 -0
  71. data/src/doc/Log4r/yamlconfigurator_rb.html +95 -0
  72. data/src/doc/REXML.html +193 -0
  73. data/src/doc/created.rid +1 -0
  74. data/src/doc/images/brick.png +0 -0
  75. data/src/doc/images/brick_link.png +0 -0
  76. data/src/doc/images/bug.png +0 -0
  77. data/src/doc/images/bullet_black.png +0 -0
  78. data/src/doc/images/bullet_toggle_minus.png +0 -0
  79. data/src/doc/images/bullet_toggle_plus.png +0 -0
  80. data/src/doc/images/date.png +0 -0
  81. data/src/doc/images/find.png +0 -0
  82. data/src/doc/images/loadingAnimation.gif +0 -0
  83. data/src/doc/images/macFFBgHack.png +0 -0
  84. data/src/doc/images/package.png +0 -0
  85. data/src/doc/images/page_green.png +0 -0
  86. data/src/doc/images/page_white_text.png +0 -0
  87. data/src/doc/images/page_white_width.png +0 -0
  88. data/src/doc/images/plugin.png +0 -0
  89. data/src/doc/images/ruby.png +0 -0
  90. data/src/doc/images/tag_green.png +0 -0
  91. data/src/doc/images/wrench.png +0 -0
  92. data/src/doc/images/wrench_orange.png +0 -0
  93. data/src/doc/images/zoom.png +0 -0
  94. data/src/doc/index.html +384 -0
  95. data/src/doc/js/darkfish.js +116 -0
  96. data/src/doc/js/jquery.js +32 -0
  97. data/src/doc/js/quicksearch.js +114 -0
  98. data/src/doc/js/thickbox-compressed.js +10 -0
  99. data/src/doc/rdoc.css +696 -0
  100. data/src/log4r.rb +2 -2
  101. data/src/log4r/formatter/patternformatter.rb +18 -2
  102. data/src/log4r/logger.rb +2 -2
  103. data/src/log4r/outputter/emailoutputter.rb +2 -0
  104. data/src/log4r/outputter/syslogoutputter.rb +29 -9
  105. data/src/log4r/outputter/tst.rb +8 -0
  106. metadata +99 -3
  107. data/examples/logs/simple.log +0 -1
@@ -0,0 +1,205 @@
1
+ <?xml version="1.0" encoding="utf-8"?>
2
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
3
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5
+ <head>
6
+ <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
7
+
8
+ <title>Class: Log4r::DefaultFormatter</title>
9
+
10
+ <link rel="stylesheet" href="../rdoc.css" type="text/css" media="screen" />
11
+
12
+ <script src="../js/jquery.js" type="text/javascript"
13
+ charset="utf-8"></script>
14
+ <script src="../js/thickbox-compressed.js" type="text/javascript"
15
+ charset="utf-8"></script>
16
+ <script src="../js/quicksearch.js" type="text/javascript"
17
+ charset="utf-8"></script>
18
+ <script src="../js/darkfish.js" type="text/javascript"
19
+ charset="utf-8"></script>
20
+
21
+ </head>
22
+ <body class="class">
23
+
24
+ <div id="metadata">
25
+ <div id="file-metadata">
26
+ <div id="file-list-section" class="section">
27
+ <h3 class="section-header">In Files</h3>
28
+ <div class="section-body">
29
+ <ul>
30
+
31
+ <li><a href="../log4r/formatter/formatter_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
32
+ class="thickbox" title="log4r/formatter/formatter.rb">log4r/formatter/formatter.rb</a></li>
33
+
34
+ </ul>
35
+ </div>
36
+ </div>
37
+
38
+
39
+ </div>
40
+
41
+ <div id="class-metadata">
42
+
43
+ <!-- Parent Class -->
44
+
45
+ <div id="parent-class-section" class="section">
46
+ <h3 class="section-header">Parent</h3>
47
+
48
+ <p class="link">BasicFormatter</p>
49
+
50
+ </div>
51
+
52
+
53
+ <!-- Namespace Contents -->
54
+
55
+
56
+ <!-- Method Quickref -->
57
+
58
+
59
+ <!-- Included Modules -->
60
+
61
+ </div>
62
+
63
+ <div id="project-metadata">
64
+
65
+
66
+ <div id="fileindex-section" class="section project-section">
67
+ <h3 class="section-header">Files</h3>
68
+ <ul>
69
+
70
+ <li class="file"><a href="../log4r/rdoc/configurator.html">configurator</a></li>
71
+
72
+ <li class="file"><a href="../log4r/rdoc/emailoutputter.html">emailoutputter</a></li>
73
+
74
+ <li class="file"><a href="../log4r/rdoc/formatter.html">formatter</a></li>
75
+
76
+ <li class="file"><a href="../log4r/rdoc/log4r.html">log4r</a></li>
77
+
78
+ <li class="file"><a href="../log4r/rdoc/logger.html">logger</a></li>
79
+
80
+ <li class="file"><a href="../log4r/rdoc/logserver.html">logserver</a></li>
81
+
82
+ <li class="file"><a href="../log4r/rdoc/outputter.html">outputter</a></li>
83
+
84
+ <li class="file"><a href="../log4r/rdoc/patternformatter.html">patternformatter</a></li>
85
+
86
+ <li class="file"><a href="../log4r/rdoc/syslogoutputter.html">syslogoutputter</a></li>
87
+
88
+ <li class="file"><a href="../log4r/rdoc/yamlconfigurator.html">yamlconfigurator</a></li>
89
+
90
+ </ul>
91
+ </div>
92
+
93
+
94
+ <div id="classindex-section" class="section project-section">
95
+ <h3 class="section-header">Class Index
96
+ <span class="search-toggle"><img src="../images/find.png"
97
+ height="16" width="16" alt="[+]"
98
+ title="show/hide quicksearch" /></span></h3>
99
+ <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
100
+ <fieldset>
101
+ <legend>Quicksearch</legend>
102
+ <input type="text" name="quicksearch" value=""
103
+ class="quicksearch-field" />
104
+ </fieldset>
105
+ </form>
106
+
107
+ <ul class="link-list">
108
+
109
+ <li><a href="../Log4r.html">Log4r</a></li>
110
+
111
+ <li><a href="../Log4r/BasicFormatter.html">Log4r::BasicFormatter</a></li>
112
+
113
+ <li><a href="../Log4r/ConfigError.html">Log4r::ConfigError</a></li>
114
+
115
+ <li><a href="../Log4r/Configurator.html">Log4r::Configurator</a></li>
116
+
117
+ <li><a href="../Log4r/DateFileOutputter.html">Log4r::DateFileOutputter</a></li>
118
+
119
+ <li><a href="../Log4r/DefaultFormatter.html">Log4r::DefaultFormatter</a></li>
120
+
121
+ <li><a href="../Log4r/EmailOutputter.html">Log4r::EmailOutputter</a></li>
122
+
123
+ <li><a href="../Log4r/FileOutputter.html">Log4r::FileOutputter</a></li>
124
+
125
+ <li><a href="../Log4r/Formatter.html">Log4r::Formatter</a></li>
126
+
127
+ <li><a href="../Log4r/IOOutputter.html">Log4r::IOOutputter</a></li>
128
+
129
+ <li><a href="../Log4r/Log4rTools.html">Log4r::Log4rTools</a></li>
130
+
131
+ <li><a href="../Log4r/LogEvent.html">Log4r::LogEvent</a></li>
132
+
133
+ <li><a href="../Log4r/LogServer.html">Log4r::LogServer</a></li>
134
+
135
+ <li><a href="../Log4r/Logger.html">Log4r::Logger</a></li>
136
+
137
+ <li><a href="../Log4r/ObjectFormatter.html">Log4r::ObjectFormatter</a></li>
138
+
139
+ <li><a href="../Log4r/Outputter.html">Log4r::Outputter</a></li>
140
+
141
+ <li><a href="../Log4r/PatternFormatter.html">Log4r::PatternFormatter</a></li>
142
+
143
+ <li><a href="../Log4r/RemoteOutputter.html">Log4r::RemoteOutputter</a></li>
144
+
145
+ <li><a href="../Log4r/RollingFileOutputter.html">Log4r::RollingFileOutputter</a></li>
146
+
147
+ <li><a href="../Log4r/RootLogger.html">Log4r::RootLogger</a></li>
148
+
149
+ <li><a href="../Log4r/SimpleFormatter.html">Log4r::SimpleFormatter</a></li>
150
+
151
+ <li><a href="../Log4r/StderrOutputter.html">Log4r::StderrOutputter</a></li>
152
+
153
+ <li><a href="../Log4r/StdoutOutputter.html">Log4r::StdoutOutputter</a></li>
154
+
155
+ <li><a href="../Log4r/SyslogOutputter.html">Log4r::SyslogOutputter</a></li>
156
+
157
+ <li><a href="../Log4r/YamlConfigurator.html">Log4r::YamlConfigurator</a></li>
158
+
159
+ </ul>
160
+ <div id="no-class-search-results" style="display: none;">No matching classes.</div>
161
+ </div>
162
+
163
+
164
+ </div>
165
+ </div>
166
+
167
+ <div id="documentation">
168
+ <h1 class="class">Log4r::DefaultFormatter</h1>
169
+
170
+ <div id="description">
171
+ <p>
172
+ Outputters that don&#8217;t define a <a href="Formatter.html">Formatter</a>
173
+ will get this, which is currently <a
174
+ href="BasicFormatter.html">BasicFormatter</a>
175
+ </p>
176
+
177
+ </div>
178
+
179
+ <!-- Constants -->
180
+
181
+
182
+ <!-- Attributes -->
183
+
184
+
185
+ <!-- Methods -->
186
+
187
+
188
+ </div>
189
+
190
+
191
+ <div id="rdoc-debugging-section-dump" class="debugging-section">
192
+
193
+ <p>Disabled; run with --debug to generate this.</p>
194
+
195
+ </div>
196
+
197
+ <div id="validator-badges">
198
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
199
+ <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
200
+ Rdoc Generator</a> 1.1.6</small>.</p>
201
+ </div>
202
+
203
+ </body>
204
+ </html>
205
+
@@ -0,0 +1,636 @@
1
+ <?xml version="1.0" encoding="utf-8"?>
2
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
3
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5
+ <head>
6
+ <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
7
+
8
+ <title>Class: Log4r::EmailOutputter</title>
9
+
10
+ <link rel="stylesheet" href="../rdoc.css" type="text/css" media="screen" />
11
+
12
+ <script src="../js/jquery.js" type="text/javascript"
13
+ charset="utf-8"></script>
14
+ <script src="../js/thickbox-compressed.js" type="text/javascript"
15
+ charset="utf-8"></script>
16
+ <script src="../js/quicksearch.js" type="text/javascript"
17
+ charset="utf-8"></script>
18
+ <script src="../js/darkfish.js" type="text/javascript"
19
+ charset="utf-8"></script>
20
+
21
+ </head>
22
+ <body class="class">
23
+
24
+ <div id="metadata">
25
+ <div id="file-metadata">
26
+ <div id="file-list-section" class="section">
27
+ <h3 class="section-header">In Files</h3>
28
+ <div class="section-body">
29
+ <ul>
30
+
31
+ <li><a href="../log4r/outputter/emailoutputter_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
32
+ class="thickbox" title="log4r/outputter/emailoutputter.rb">log4r/outputter/emailoutputter.rb</a></li>
33
+
34
+ </ul>
35
+ </div>
36
+ </div>
37
+
38
+
39
+ </div>
40
+
41
+ <div id="class-metadata">
42
+
43
+ <!-- Parent Class -->
44
+
45
+ <div id="parent-class-section" class="section">
46
+ <h3 class="section-header">Parent</h3>
47
+
48
+ <p class="link">Outputter</p>
49
+
50
+ </div>
51
+
52
+
53
+ <!-- Namespace Contents -->
54
+
55
+
56
+ <!-- Method Quickref -->
57
+
58
+ <div id="method-list-section" class="section">
59
+ <h3 class="section-header">Methods</h3>
60
+ <ul class="link-list">
61
+
62
+ <li><a href="#M000066">::new</a></li>
63
+
64
+ <li><a href="#M000072">#canonical_log</a></li>
65
+
66
+ <li><a href="#M000069">#decode_immediate_at</a></li>
67
+
68
+ <li><a href="#M000067">#flush</a></li>
69
+
70
+ <li><a href="#M000073">#send_mail</a></li>
71
+
72
+ <li><a href="#M000068">#validate</a></li>
73
+
74
+ <li><a href="#M000071">#validate_smtp_params</a></li>
75
+
76
+ </ul>
77
+ </div>
78
+
79
+
80
+ <!-- Included Modules -->
81
+
82
+ </div>
83
+
84
+ <div id="project-metadata">
85
+
86
+
87
+ <div id="fileindex-section" class="section project-section">
88
+ <h3 class="section-header">Files</h3>
89
+ <ul>
90
+
91
+ <li class="file"><a href="../log4r/rdoc/configurator.html">configurator</a></li>
92
+
93
+ <li class="file"><a href="../log4r/rdoc/emailoutputter.html">emailoutputter</a></li>
94
+
95
+ <li class="file"><a href="../log4r/rdoc/formatter.html">formatter</a></li>
96
+
97
+ <li class="file"><a href="../log4r/rdoc/log4r.html">log4r</a></li>
98
+
99
+ <li class="file"><a href="../log4r/rdoc/logger.html">logger</a></li>
100
+
101
+ <li class="file"><a href="../log4r/rdoc/logserver.html">logserver</a></li>
102
+
103
+ <li class="file"><a href="../log4r/rdoc/outputter.html">outputter</a></li>
104
+
105
+ <li class="file"><a href="../log4r/rdoc/patternformatter.html">patternformatter</a></li>
106
+
107
+ <li class="file"><a href="../log4r/rdoc/syslogoutputter.html">syslogoutputter</a></li>
108
+
109
+ <li class="file"><a href="../log4r/rdoc/yamlconfigurator.html">yamlconfigurator</a></li>
110
+
111
+ </ul>
112
+ </div>
113
+
114
+
115
+ <div id="classindex-section" class="section project-section">
116
+ <h3 class="section-header">Class Index
117
+ <span class="search-toggle"><img src="../images/find.png"
118
+ height="16" width="16" alt="[+]"
119
+ title="show/hide quicksearch" /></span></h3>
120
+ <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
121
+ <fieldset>
122
+ <legend>Quicksearch</legend>
123
+ <input type="text" name="quicksearch" value=""
124
+ class="quicksearch-field" />
125
+ </fieldset>
126
+ </form>
127
+
128
+ <ul class="link-list">
129
+
130
+ <li><a href="../Log4r.html">Log4r</a></li>
131
+
132
+ <li><a href="../Log4r/BasicFormatter.html">Log4r::BasicFormatter</a></li>
133
+
134
+ <li><a href="../Log4r/ConfigError.html">Log4r::ConfigError</a></li>
135
+
136
+ <li><a href="../Log4r/Configurator.html">Log4r::Configurator</a></li>
137
+
138
+ <li><a href="../Log4r/DateFileOutputter.html">Log4r::DateFileOutputter</a></li>
139
+
140
+ <li><a href="../Log4r/DefaultFormatter.html">Log4r::DefaultFormatter</a></li>
141
+
142
+ <li><a href="../Log4r/EmailOutputter.html">Log4r::EmailOutputter</a></li>
143
+
144
+ <li><a href="../Log4r/FileOutputter.html">Log4r::FileOutputter</a></li>
145
+
146
+ <li><a href="../Log4r/Formatter.html">Log4r::Formatter</a></li>
147
+
148
+ <li><a href="../Log4r/IOOutputter.html">Log4r::IOOutputter</a></li>
149
+
150
+ <li><a href="../Log4r/Log4rTools.html">Log4r::Log4rTools</a></li>
151
+
152
+ <li><a href="../Log4r/LogEvent.html">Log4r::LogEvent</a></li>
153
+
154
+ <li><a href="../Log4r/LogServer.html">Log4r::LogServer</a></li>
155
+
156
+ <li><a href="../Log4r/Logger.html">Log4r::Logger</a></li>
157
+
158
+ <li><a href="../Log4r/ObjectFormatter.html">Log4r::ObjectFormatter</a></li>
159
+
160
+ <li><a href="../Log4r/Outputter.html">Log4r::Outputter</a></li>
161
+
162
+ <li><a href="../Log4r/PatternFormatter.html">Log4r::PatternFormatter</a></li>
163
+
164
+ <li><a href="../Log4r/RemoteOutputter.html">Log4r::RemoteOutputter</a></li>
165
+
166
+ <li><a href="../Log4r/RollingFileOutputter.html">Log4r::RollingFileOutputter</a></li>
167
+
168
+ <li><a href="../Log4r/RootLogger.html">Log4r::RootLogger</a></li>
169
+
170
+ <li><a href="../Log4r/SimpleFormatter.html">Log4r::SimpleFormatter</a></li>
171
+
172
+ <li><a href="../Log4r/StderrOutputter.html">Log4r::StderrOutputter</a></li>
173
+
174
+ <li><a href="../Log4r/StdoutOutputter.html">Log4r::StdoutOutputter</a></li>
175
+
176
+ <li><a href="../Log4r/SyslogOutputter.html">Log4r::SyslogOutputter</a></li>
177
+
178
+ <li><a href="../Log4r/YamlConfigurator.html">Log4r::YamlConfigurator</a></li>
179
+
180
+ </ul>
181
+ <div id="no-class-search-results" style="display: none;">No matching classes.</div>
182
+ </div>
183
+
184
+
185
+ </div>
186
+ </div>
187
+
188
+ <div id="documentation">
189
+ <h1 class="class">Log4r::EmailOutputter</h1>
190
+
191
+ <div id="description">
192
+
193
+ </div>
194
+
195
+ <!-- Constants -->
196
+
197
+
198
+ <!-- Attributes -->
199
+
200
+ <div id="attribute-method-details" class="method-section section">
201
+ <h3 class="section-header">Attributes</h3>
202
+
203
+
204
+ <div id="server-attribute-method" class="method-detail">
205
+ <a name="server"></a>
206
+
207
+ <div class="method-heading attribute-method-heading">
208
+ <span class="method-name">server</span><span
209
+ class="attribute-access-type">[R]</span>
210
+ </div>
211
+
212
+ <div class="method-description">
213
+
214
+ <p class="missing-docs">(Not documented)</p>
215
+
216
+ </div>
217
+ </div>
218
+
219
+ <div id="port-attribute-method" class="method-detail">
220
+ <a name="port"></a>
221
+
222
+ <div class="method-heading attribute-method-heading">
223
+ <span class="method-name">port</span><span
224
+ class="attribute-access-type">[R]</span>
225
+ </div>
226
+
227
+ <div class="method-description">
228
+
229
+ <p class="missing-docs">(Not documented)</p>
230
+
231
+ </div>
232
+ </div>
233
+
234
+ <div id="domain-attribute-method" class="method-detail">
235
+ <a name="domain"></a>
236
+
237
+ <div class="method-heading attribute-method-heading">
238
+ <span class="method-name">domain</span><span
239
+ class="attribute-access-type">[R]</span>
240
+ </div>
241
+
242
+ <div class="method-description">
243
+
244
+ <p class="missing-docs">(Not documented)</p>
245
+
246
+ </div>
247
+ </div>
248
+
249
+ <div id="acct-attribute-method" class="method-detail">
250
+ <a name="acct"></a>
251
+
252
+ <div class="method-heading attribute-method-heading">
253
+ <span class="method-name">acct</span><span
254
+ class="attribute-access-type">[R]</span>
255
+ </div>
256
+
257
+ <div class="method-description">
258
+
259
+ <p class="missing-docs">(Not documented)</p>
260
+
261
+ </div>
262
+ </div>
263
+
264
+ <div id="authtype-attribute-method" class="method-detail">
265
+ <a name="authtype"></a>
266
+
267
+ <div class="method-heading attribute-method-heading">
268
+ <span class="method-name">authtype</span><span
269
+ class="attribute-access-type">[R]</span>
270
+ </div>
271
+
272
+ <div class="method-description">
273
+
274
+ <p class="missing-docs">(Not documented)</p>
275
+
276
+ </div>
277
+ </div>
278
+
279
+ <div id="subject-attribute-method" class="method-detail">
280
+ <a name="subject"></a>
281
+
282
+ <div class="method-heading attribute-method-heading">
283
+ <span class="method-name">subject</span><span
284
+ class="attribute-access-type">[R]</span>
285
+ </div>
286
+
287
+ <div class="method-description">
288
+
289
+ <p class="missing-docs">(Not documented)</p>
290
+
291
+ </div>
292
+ </div>
293
+
294
+ </div>
295
+
296
+
297
+ <!-- Methods -->
298
+
299
+ <div id="public-class-method-details" class="method-section section">
300
+ <h3 class="section-header">Public Class Methods</h3>
301
+
302
+
303
+ <div id="new-method" class="method-detail ">
304
+ <a name="M000066"></a>
305
+
306
+ <div class="method-heading">
307
+
308
+ <span class="method-name">new</span><span
309
+ class="method-args">(_name, hash={})</span>
310
+ <span class="method-click-advice">click to toggle source</span>
311
+
312
+ </div>
313
+
314
+ <div class="method-description">
315
+
316
+ <p class="missing-docs">(Not documented)</p>
317
+
318
+
319
+
320
+ <div class="method-source-code"
321
+ id="new-source">
322
+ <pre>
323
+ <span class="ruby-comment cmt"># File log4r/outputter/emailoutputter.rb, line 12</span>
324
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">_name</span>, <span class="ruby-identifier">hash</span>={})
325
+ <span class="ruby-keyword kw">super</span>(<span class="ruby-identifier">_name</span>, <span class="ruby-identifier">hash</span>)
326
+ <span class="ruby-identifier">validate</span>(<span class="ruby-identifier">hash</span>)
327
+ <span class="ruby-ivar">@buff</span> = []
328
+ <span class="ruby-keyword kw">begin</span>
329
+ <span class="ruby-constant">Logger</span>.<span class="ruby-identifier">log_internal</span> {
330
+ <span class="ruby-node">&quot;EmailOutputter '#{@name}' running SMTP client on #{@server}:#{@port}&quot;</span>
331
+ }
332
+ <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">e</span>
333
+ <span class="ruby-constant">Logger</span>.<span class="ruby-identifier">log_internal</span>(<span class="ruby-value">-2</span>) {
334
+ <span class="ruby-node">&quot;EmailOutputter '#{@name}' failed to start SMTP client!&quot;</span>
335
+ }
336
+ <span class="ruby-constant">Logger</span>.<span class="ruby-identifier">log_internal</span> {<span class="ruby-identifier">e</span>}
337
+ <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">level</span> = <span class="ruby-constant">OFF</span>
338
+ <span class="ruby-identifier">raise</span> <span class="ruby-identifier">e</span>
339
+ <span class="ruby-keyword kw">end</span>
340
+ <span class="ruby-keyword kw">end</span></pre>
341
+ </div>
342
+
343
+ </div>
344
+
345
+
346
+ </div>
347
+
348
+
349
+ </div>
350
+
351
+ <div id="public-instance-method-details" class="method-section section">
352
+ <h3 class="section-header">Public Instance Methods</h3>
353
+
354
+
355
+ <div id="flush-method" class="method-detail ">
356
+ <a name="M000067"></a>
357
+
358
+ <div class="method-heading">
359
+
360
+ <span class="method-name">flush</span><span
361
+ class="method-args">()</span>
362
+ <span class="method-click-advice">click to toggle source</span>
363
+
364
+ </div>
365
+
366
+ <div class="method-description">
367
+
368
+ <p>
369
+ send out an email with the current buffer
370
+ </p>
371
+
372
+
373
+
374
+ <div class="method-source-code"
375
+ id="flush-source">
376
+ <pre>
377
+ <span class="ruby-comment cmt"># File log4r/outputter/emailoutputter.rb, line 31</span>
378
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">flush</span>
379
+ <span class="ruby-identifier">synch</span> { <span class="ruby-identifier">send_mail</span> }
380
+ <span class="ruby-constant">Logger</span>.<span class="ruby-identifier">log_internal</span> {<span class="ruby-node">&quot;Flushed EmailOutputter '#{@name}'&quot;</span>}
381
+ <span class="ruby-keyword kw">end</span></pre>
382
+ </div>
383
+
384
+ </div>
385
+
386
+
387
+ </div>
388
+
389
+
390
+ </div>
391
+
392
+ <div id="private-instance-method-details" class="method-section section">
393
+ <h3 class="section-header">Private Instance Methods</h3>
394
+
395
+
396
+ <div id="canonical-log-method" class="method-detail ">
397
+ <a name="M000072"></a>
398
+
399
+ <div class="method-heading">
400
+
401
+ <span class="method-name">canonical_log</span><span
402
+ class="method-args">(event)</span>
403
+ <span class="method-click-advice">click to toggle source</span>
404
+
405
+ </div>
406
+
407
+ <div class="method-description">
408
+
409
+ <p class="missing-docs">(Not documented)</p>
410
+
411
+
412
+
413
+ <div class="method-source-code"
414
+ id="canonical-log-source">
415
+ <pre>
416
+ <span class="ruby-comment cmt"># File log4r/outputter/emailoutputter.rb, line 77</span>
417
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">canonical_log</span>(<span class="ruby-identifier">event</span>)
418
+ <span class="ruby-identifier">synch</span> {
419
+ <span class="ruby-ivar">@buff</span>.<span class="ruby-identifier">push</span> <span class="ruby-keyword kw">case</span> <span class="ruby-ivar">@formatfirst</span>
420
+ <span class="ruby-keyword kw">when</span> <span class="ruby-keyword kw">true</span> <span class="ruby-keyword kw">then</span> <span class="ruby-ivar">@formatter</span>.<span class="ruby-identifier">format</span> <span class="ruby-identifier">event</span>
421
+ <span class="ruby-keyword kw">else</span> <span class="ruby-identifier">event</span>
422
+ <span class="ruby-keyword kw">end</span>
423
+ <span class="ruby-identifier">send_mail</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@buff</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">&gt;=</span> <span class="ruby-ivar">@buffsize</span> <span class="ruby-keyword kw">or</span> <span class="ruby-ivar">@immediate</span>[<span class="ruby-identifier">event</span>.<span class="ruby-identifier">level</span>]
424
+ }
425
+ <span class="ruby-keyword kw">end</span></pre>
426
+ </div>
427
+
428
+ </div>
429
+
430
+
431
+ </div>
432
+
433
+
434
+ <div id="decode-immediate-at-method" class="method-detail ">
435
+ <a name="M000069"></a>
436
+
437
+ <div class="method-heading">
438
+
439
+ <span class="method-name">decode_immediate_at</span><span
440
+ class="method-args">(hash)</span>
441
+ <span class="method-click-advice">click to toggle source</span>
442
+
443
+ </div>
444
+
445
+ <div class="method-description">
446
+
447
+ <p class="missing-docs">(Not documented)</p>
448
+
449
+
450
+
451
+ <div class="method-source-code"
452
+ id="decode-immediate-at-source">
453
+ <pre>
454
+ <span class="ruby-comment cmt"># File log4r/outputter/emailoutputter.rb, line 45</span>
455
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">decode_immediate_at</span>(<span class="ruby-identifier">hash</span>)
456
+ <span class="ruby-ivar">@immediate</span> = <span class="ruby-constant">Hash</span>.<span class="ruby-identifier">new</span>
457
+ <span class="ruby-identifier">_at</span> = (<span class="ruby-identifier">hash</span>[<span class="ruby-identifier">:immediate_at</span>] <span class="ruby-keyword kw">or</span> <span class="ruby-identifier">hash</span>[<span class="ruby-value str">'immediate_at'</span>])
458
+ <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">_at</span>.<span class="ruby-identifier">nil?</span>
459
+ <span class="ruby-constant">Log4rTools</span>.<span class="ruby-identifier">comma_split</span>(<span class="ruby-identifier">_at</span>).<span class="ruby-identifier">each</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">lname</span><span class="ruby-operator">|</span>
460
+ <span class="ruby-identifier">level</span> = <span class="ruby-constant">LNAMES</span>.<span class="ruby-identifier">index</span>(<span class="ruby-identifier">lname</span>)
461
+ <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">level</span>.<span class="ruby-identifier">nil?</span>
462
+ <span class="ruby-constant">Logger</span>.<span class="ruby-identifier">log_internal</span>(<span class="ruby-value">-2</span>) <span class="ruby-keyword kw">do</span>
463
+ <span class="ruby-node">&quot;EmailOutputter: skipping bad immediate_at level name '#{lname}'&quot;</span>
464
+ <span class="ruby-keyword kw">end</span>
465
+ <span class="ruby-keyword kw">next</span>
466
+ <span class="ruby-keyword kw">end</span>
467
+ <span class="ruby-ivar">@immediate</span>[<span class="ruby-identifier">level</span>] = <span class="ruby-keyword kw">true</span>
468
+ }
469
+ <span class="ruby-keyword kw">end</span></pre>
470
+ </div>
471
+
472
+ </div>
473
+
474
+
475
+ </div>
476
+
477
+
478
+ <div id="send-mail-method" class="method-detail ">
479
+ <a name="M000073"></a>
480
+
481
+ <div class="method-heading">
482
+
483
+ <span class="method-name">send_mail</span><span
484
+ class="method-args">()</span>
485
+ <span class="method-click-advice">click to toggle source</span>
486
+
487
+ </div>
488
+
489
+ <div class="method-description">
490
+
491
+ <p class="missing-docs">(Not documented)</p>
492
+
493
+
494
+
495
+ <div class="method-source-code"
496
+ id="send-mail-source">
497
+ <pre>
498
+ <span class="ruby-comment cmt"># File log4r/outputter/emailoutputter.rb, line 87</span>
499
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">send_mail</span>
500
+ <span class="ruby-identifier">msg</span> =
501
+ <span class="ruby-keyword kw">case</span> <span class="ruby-ivar">@formatfirst</span>
502
+ <span class="ruby-keyword kw">when</span> <span class="ruby-keyword kw">true</span> <span class="ruby-keyword kw">then</span> <span class="ruby-ivar">@buff</span>.<span class="ruby-identifier">join</span>
503
+ <span class="ruby-keyword kw">else</span> <span class="ruby-ivar">@buff</span>.<span class="ruby-identifier">collect</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">e</span><span class="ruby-operator">|</span> <span class="ruby-ivar">@formatter</span>.<span class="ruby-identifier">format</span> <span class="ruby-identifier">e</span>}.<span class="ruby-identifier">join</span>
504
+ <span class="ruby-keyword kw">end</span>
505
+
506
+ <span class="ruby-comment cmt">### build a mail header for RFC 822</span>
507
+ <span class="ruby-identifier">rfc822msg</span> =
508
+ <span class="ruby-node">&quot;From: #{@from}\n&quot;</span> <span class="ruby-operator">+</span>
509
+ <span class="ruby-node">&quot;To: #{@to}\n&quot;</span> <span class="ruby-operator">+</span>
510
+ <span class="ruby-node">&quot;Subject: #{@subject}\n&quot;</span> <span class="ruby-operator">+</span>
511
+ <span class="ruby-node">&quot;Date: #{Time.now.strftime( &quot;%a, %d %b %Y %H:%M:%S %z %Z&quot;)}\n&quot;</span> <span class="ruby-operator">+</span>
512
+ <span class="ruby-node">&quot;Message-Id: &lt;#{&quot;%.8f&quot; % Time.now.to_f}@#{@domain}&gt;\n\n&quot;</span> <span class="ruby-operator">+</span>
513
+ <span class="ruby-node">&quot;#{msg}&quot;</span>
514
+
515
+ <span class="ruby-comment cmt">### send email</span>
516
+ <span class="ruby-keyword kw">begin</span> <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">SMTP</span>.<span class="ruby-identifier">start</span>(<span class="ruby-operator">*</span><span class="ruby-ivar">@params</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">smtp</span><span class="ruby-operator">|</span>
517
+ <span class="ruby-identifier">smtp</span>.<span class="ruby-identifier">sendmail</span>(<span class="ruby-identifier">rfc822msg</span>, <span class="ruby-ivar">@from</span>, <span class="ruby-ivar">@to</span>)
518
+ <span class="ruby-keyword kw">end</span>
519
+ <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">e</span>
520
+ <span class="ruby-constant">Logger</span>.<span class="ruby-identifier">log_internal</span>(<span class="ruby-value">-2</span>) {
521
+ <span class="ruby-node">&quot;EmailOutputter '#{@name}' couldn't send email!&quot;</span>
522
+ }
523
+ <span class="ruby-constant">Logger</span>.<span class="ruby-identifier">log_internal</span> {<span class="ruby-identifier">e</span>}
524
+ <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">level</span> = <span class="ruby-constant">OFF</span>
525
+ <span class="ruby-identifier">raise</span> <span class="ruby-identifier">e</span>
526
+ <span class="ruby-keyword kw">ensure</span> <span class="ruby-ivar">@buff</span>.<span class="ruby-identifier">clear</span>
527
+ <span class="ruby-keyword kw">end</span>
528
+ <span class="ruby-keyword kw">end</span></pre>
529
+ </div>
530
+
531
+ </div>
532
+
533
+
534
+ </div>
535
+
536
+
537
+ <div id="validate-method" class="method-detail ">
538
+ <a name="M000068"></a>
539
+
540
+ <div class="method-heading">
541
+
542
+ <span class="method-name">validate</span><span
543
+ class="method-args">(hash)</span>
544
+ <span class="method-click-advice">click to toggle source</span>
545
+
546
+ </div>
547
+
548
+ <div class="method-description">
549
+
550
+ <p class="missing-docs">(Not documented)</p>
551
+
552
+
553
+
554
+ <div class="method-source-code"
555
+ id="validate-source">
556
+ <pre>
557
+ <span class="ruby-comment cmt"># File log4r/outputter/emailoutputter.rb, line 38</span>
558
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">validate</span>(<span class="ruby-identifier">hash</span>)
559
+ <span class="ruby-ivar">@buffsize</span> = (<span class="ruby-identifier">hash</span>[<span class="ruby-identifier">:buffsize</span>] <span class="ruby-keyword kw">or</span> <span class="ruby-identifier">hash</span>[<span class="ruby-value str">'buffsize'</span>] <span class="ruby-keyword kw">or</span> <span class="ruby-value">100</span>).<span class="ruby-identifier">to_i</span>
560
+ <span class="ruby-ivar">@formatfirst</span> = <span class="ruby-constant">Log4rTools</span>.<span class="ruby-identifier">decode_bool</span>(<span class="ruby-identifier">hash</span>, <span class="ruby-identifier">:formatfirst</span>, <span class="ruby-keyword kw">false</span>)
561
+ <span class="ruby-identifier">decode_immediate_at</span>(<span class="ruby-identifier">hash</span>)
562
+ <span class="ruby-identifier">validate_smtp_params</span>(<span class="ruby-identifier">hash</span>)
563
+ <span class="ruby-keyword kw">end</span></pre>
564
+ </div>
565
+
566
+ </div>
567
+
568
+
569
+ </div>
570
+
571
+
572
+ <div id="validate-smtp-params-method" class="method-detail ">
573
+ <a name="M000071"></a>
574
+
575
+ <div class="method-heading">
576
+
577
+ <span class="method-name">validate_smtp_params</span><span
578
+ class="method-args">(hash)</span>
579
+ <span class="method-click-advice">click to toggle source</span>
580
+
581
+ </div>
582
+
583
+ <div class="method-description">
584
+
585
+ <p class="missing-docs">(Not documented)</p>
586
+
587
+
588
+
589
+ <div class="method-source-code"
590
+ id="validate-smtp-params-source">
591
+ <pre>
592
+ <span class="ruby-comment cmt"># File log4r/outputter/emailoutputter.rb, line 61</span>
593
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">validate_smtp_params</span>(<span class="ruby-identifier">hash</span>)
594
+ <span class="ruby-ivar">@from</span> = (<span class="ruby-identifier">hash</span>[<span class="ruby-identifier">:from</span>] <span class="ruby-keyword kw">or</span> <span class="ruby-identifier">hash</span>[<span class="ruby-value str">'from'</span>])
595
+ <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-value str">&quot;Must specify from address&quot;</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@from</span>.<span class="ruby-identifier">nil?</span>
596
+ <span class="ruby-identifier">_to</span> = (<span class="ruby-identifier">hash</span>[<span class="ruby-identifier">:to</span>] <span class="ruby-keyword kw">or</span> <span class="ruby-identifier">hash</span>[<span class="ruby-value str">'to'</span>] <span class="ruby-keyword kw">or</span> <span class="ruby-value str">&quot;&quot;</span>)
597
+ <span class="ruby-ivar">@to</span> = <span class="ruby-constant">Log4rTools</span>.<span class="ruby-identifier">comma_split</span>(<span class="ruby-identifier">_to</span>)
598
+ <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-value str">&quot;Must specify recepients&quot;</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@to</span>.<span class="ruby-identifier">empty?</span>
599
+ <span class="ruby-ivar">@server</span> = (<span class="ruby-identifier">hash</span>[<span class="ruby-identifier">:server</span>] <span class="ruby-keyword kw">or</span> <span class="ruby-identifier">hash</span>[<span class="ruby-value str">'server'</span>] <span class="ruby-keyword kw">or</span> <span class="ruby-value str">'localhost'</span>)
600
+ <span class="ruby-ivar">@port</span> = (<span class="ruby-identifier">hash</span>[<span class="ruby-identifier">:port</span>] <span class="ruby-keyword kw">or</span> <span class="ruby-identifier">hash</span>[<span class="ruby-value str">'port'</span>] <span class="ruby-keyword kw">or</span> <span class="ruby-value">25</span>).<span class="ruby-identifier">to_i</span>
601
+ <span class="ruby-ivar">@domain</span> = (<span class="ruby-identifier">hash</span>[<span class="ruby-identifier">:domain</span>] <span class="ruby-keyword kw">or</span> <span class="ruby-identifier">hash</span>[<span class="ruby-value str">'domain'</span>] <span class="ruby-keyword kw">or</span> <span class="ruby-constant">ENV</span>[<span class="ruby-value str">'HOSTNAME'</span>])
602
+ <span class="ruby-ivar">@acct</span> = (<span class="ruby-identifier">hash</span>[<span class="ruby-identifier">:acct</span>] <span class="ruby-keyword kw">or</span> <span class="ruby-identifier">hash</span>[<span class="ruby-value str">'acct'</span>])
603
+ <span class="ruby-ivar">@passwd</span> = (<span class="ruby-identifier">hash</span>[<span class="ruby-identifier">:passwd</span>] <span class="ruby-keyword kw">or</span> <span class="ruby-identifier">hash</span>[<span class="ruby-value str">'passwd'</span>])
604
+ <span class="ruby-ivar">@authtype</span> = (<span class="ruby-identifier">hash</span>[<span class="ruby-identifier">:authtype</span>] <span class="ruby-keyword kw">or</span> <span class="ruby-identifier">hash</span>[<span class="ruby-value str">'authtype'</span>] <span class="ruby-keyword kw">or</span> <span class="ruby-identifier">:cram_md5</span>).<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">intern</span>
605
+ <span class="ruby-ivar">@subject</span> = (<span class="ruby-identifier">hash</span>[<span class="ruby-identifier">:subject</span>] <span class="ruby-keyword kw">or</span> <span class="ruby-identifier">hash</span>[<span class="ruby-value str">'subject'</span>] <span class="ruby-keyword kw">or</span> <span class="ruby-node">&quot;Message of #{$0}&quot;</span>)
606
+ <span class="ruby-ivar">@params</span> = [<span class="ruby-ivar">@server</span>, <span class="ruby-ivar">@port</span>, <span class="ruby-ivar">@domain</span>, <span class="ruby-ivar">@acct</span>, <span class="ruby-ivar">@passwd</span>, <span class="ruby-ivar">@authtype</span>]
607
+ <span class="ruby-keyword kw">end</span></pre>
608
+ </div>
609
+
610
+ </div>
611
+
612
+
613
+ </div>
614
+
615
+
616
+ </div>
617
+
618
+
619
+ </div>
620
+
621
+
622
+ <div id="rdoc-debugging-section-dump" class="debugging-section">
623
+
624
+ <p>Disabled; run with --debug to generate this.</p>
625
+
626
+ </div>
627
+
628
+ <div id="validator-badges">
629
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
630
+ <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
631
+ Rdoc Generator</a> 1.1.6</small>.</p>
632
+ </div>
633
+
634
+ </body>
635
+ </html>
636
+