mailer 0.0.4

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,511 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6
+ <title>
7
+ Module: Mailer::Config
8
+
9
+ &mdash; Documentation by YARD 0.8.1
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ hasFrames = window.top.frames.main ? true : false;
19
+ relpath = '../';
20
+ framesUrl = "../frames.html#!" + escape(window.location.href);
21
+ </script>
22
+
23
+
24
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
25
+
26
+ <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
27
+
28
+
29
+ </head>
30
+ <body>
31
+ <div id="header">
32
+ <div id="menu">
33
+
34
+ <a href="../_index.html">Index (C)</a> &raquo;
35
+ <span class='title'><span class='object_link'><a href="../Mailer.html" title="Mailer (module)">Mailer</a></span></span>
36
+ &raquo;
37
+ <span class="title">Config</span>
38
+
39
+
40
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
41
+ </div>
42
+
43
+ <div id="search">
44
+
45
+ <a class="full_list_link" id="class_list_link"
46
+ href="../class_list.html">
47
+ Class List
48
+ </a>
49
+
50
+ <a class="full_list_link" id="method_list_link"
51
+ href="../method_list.html">
52
+ Method List
53
+ </a>
54
+
55
+ <a class="full_list_link" id="file_list_link"
56
+ href="../file_list.html">
57
+ File List
58
+ </a>
59
+
60
+ </div>
61
+ <div class="clear"></div>
62
+ </div>
63
+
64
+ <iframe id="search_frame"></iframe>
65
+
66
+ <div id="content"><h1>Module: Mailer::Config
67
+
68
+
69
+
70
+ </h1>
71
+
72
+ <dl class="box">
73
+
74
+
75
+
76
+
77
+
78
+
79
+
80
+ <dt class="r1">Included in:</dt>
81
+ <dd class="r1"><span class='object_link'><a href="../Mailer.html" title="Mailer (module)">Mailer</a></span></dd>
82
+
83
+
84
+
85
+ <dt class="r2 last">Defined in:</dt>
86
+ <dd class="r2 last">lib/mailer/config.rb</dd>
87
+
88
+ </dl>
89
+ <div class="clear"></div>
90
+
91
+
92
+ <h2>Constant Summary</h2>
93
+
94
+ <dl class="constants">
95
+
96
+ <dt id="DEFAULT_API_DOMAIN-constant" class="">DEFAULT_API_DOMAIN =
97
+ <div class="docstring">
98
+ <div class="discussion">
99
+
100
+ <p>Defaultapi domain</p>
101
+
102
+
103
+ </div>
104
+ </div>
105
+ <div class="tags">
106
+
107
+
108
+ </div>
109
+ </dt>
110
+ <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>http://127.0.0.1:80/api/</span><span class='tstring_end'>'</span></span></pre></dd>
111
+
112
+ <dt id="DEFAULT_API_TOKEN-constant" class="">DEFAULT_API_TOKEN =
113
+ <div class="docstring">
114
+ <div class="discussion">
115
+
116
+ <p>Defailt api token</p>
117
+
118
+
119
+ </div>
120
+ </div>
121
+ <div class="tags">
122
+
123
+
124
+ </div>
125
+ </dt>
126
+ <dd><pre class="code"><span class='kw'>nil</span></pre></dd>
127
+
128
+ <dt id="VALID_OPTIONS_KEYS-constant" class="">VALID_OPTIONS_KEYS =
129
+ <div class="docstring">
130
+ <div class="discussion">
131
+
132
+ <p>Valid options keys</p>
133
+
134
+
135
+ </div>
136
+ </div>
137
+ <div class="tags">
138
+
139
+
140
+ </div>
141
+ </dt>
142
+ <dd><pre class="code"><span class='lbracket'>[</span>
143
+ <span class='symbol'>:api_token</span><span class='comma'>,</span>
144
+ <span class='symbol'>:api_domain</span>
145
+ <span class='rbracket'>]</span></pre></dd>
146
+
147
+ </dl>
148
+
149
+
150
+
151
+
152
+
153
+
154
+
155
+
156
+
157
+ <h2>
158
+ Class Method Summary
159
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
160
+ </h2>
161
+
162
+ <ul class="summary">
163
+
164
+ <li class="public ">
165
+ <span class="summary_signature">
166
+
167
+ <a href="#extended-class_method" title="extended (class method)">+ (Object) <strong>extended</strong>(base) </a>
168
+
169
+
170
+
171
+ </span>
172
+
173
+
174
+
175
+
176
+
177
+
178
+
179
+
180
+
181
+ <span class="summary_desc"><div class='inline'></div></span>
182
+
183
+ </li>
184
+
185
+
186
+ </ul>
187
+
188
+ <h2>
189
+ Instance Method Summary
190
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
191
+ </h2>
192
+
193
+ <ul class="summary">
194
+
195
+ <li class="public ">
196
+ <span class="summary_signature">
197
+
198
+ <a href="#configure-instance_method" title="#configure (instance method)">- (Object) <strong>configure</strong> {|_self| ... }</a>
199
+
200
+
201
+
202
+ </span>
203
+
204
+
205
+
206
+
207
+
208
+
209
+
210
+
211
+
212
+ <span class="summary_desc"><div class='inline'></div></span>
213
+
214
+ </li>
215
+
216
+
217
+ <li class="public ">
218
+ <span class="summary_signature">
219
+
220
+ <a href="#options-instance_method" title="#options (instance method)">- (Hash) <strong>options</strong> </a>
221
+
222
+
223
+
224
+ </span>
225
+
226
+
227
+
228
+
229
+
230
+
231
+
232
+
233
+
234
+ <span class="summary_desc"><div class='inline'>
235
+ <p>Create a hash of options and their values.</p>
236
+ </div></span>
237
+
238
+ </li>
239
+
240
+
241
+ <li class="public ">
242
+ <span class="summary_signature">
243
+
244
+ <a href="#reset-instance_method" title="#reset (instance method)">- (self) <strong>reset</strong> </a>
245
+
246
+
247
+
248
+ </span>
249
+
250
+
251
+
252
+
253
+
254
+
255
+
256
+
257
+
258
+ <span class="summary_desc"><div class='inline'>
259
+ <p>Reset config.</p>
260
+ </div></span>
261
+
262
+ </li>
263
+
264
+
265
+ </ul>
266
+
267
+
268
+
269
+
270
+ <div id="class_method_details" class="method_details_list">
271
+ <h2>Class Method Details</h2>
272
+
273
+
274
+ <div class="method_details first">
275
+ <h3 class="signature first" id="extended-class_method">
276
+
277
+ + (<tt>Object</tt>) <strong>extended</strong>(base)
278
+
279
+
280
+
281
+
282
+
283
+ </h3><table class="source_code">
284
+ <tr>
285
+ <td>
286
+ <pre class="lines">
287
+
288
+
289
+ 19
290
+ 20
291
+ 21</pre>
292
+ </td>
293
+ <td>
294
+ <pre class="code"><span class="info file"># File 'lib/mailer/config.rb', line 19</span>
295
+
296
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_extended'>extended</span><span class='lparen'>(</span><span class='id identifier rubyid_base'>base</span><span class='rparen'>)</span>
297
+ <span class='id identifier rubyid_base'>base</span><span class='period'>.</span><span class='id identifier rubyid_reset'>reset</span>
298
+ <span class='kw'>end</span></pre>
299
+ </td>
300
+ </tr>
301
+ </table>
302
+ </div>
303
+
304
+ </div>
305
+
306
+ <div id="instance_method_details" class="method_details_list">
307
+ <h2>Instance Method Details</h2>
308
+
309
+
310
+ <div class="method_details first">
311
+ <h3 class="signature first" id="configure-instance_method">
312
+
313
+ - (<tt>Object</tt>) <strong>configure</strong> {|_self| ... }
314
+
315
+
316
+
317
+
318
+
319
+ </h3><div class="docstring">
320
+ <div class="discussion">
321
+
322
+
323
+ </div>
324
+ </div>
325
+ <div class="tags">
326
+
327
+ <p class="tag_title">Yields:</p>
328
+ <ul class="yield">
329
+
330
+ <li>
331
+
332
+
333
+ <span class='type'>(<tt>_self</tt>)</span>
334
+
335
+
336
+
337
+ </li>
338
+
339
+ </ul>
340
+ <p class="tag_title">Yield Parameters:</p>
341
+ <ul class="yieldparam">
342
+
343
+ <li>
344
+
345
+ <span class='name'>_self</span>
346
+
347
+
348
+ <span class='type'>(<tt><span class='object_link'><a href="" title="Mailer::Config (module)">Mailer::Config</a></span></tt>)</span>
349
+
350
+
351
+
352
+ &mdash;
353
+ <div class='inline'>
354
+ <p>the object that the method was called on</p>
355
+ </div>
356
+
357
+ </li>
358
+
359
+ </ul>
360
+
361
+ </div><table class="source_code">
362
+ <tr>
363
+ <td>
364
+ <pre class="lines">
365
+
366
+
367
+ 23
368
+ 24
369
+ 25
370
+ 26</pre>
371
+ </td>
372
+ <td>
373
+ <pre class="code"><span class="info file"># File 'lib/mailer/config.rb', line 23</span>
374
+
375
+ <span class='kw'>def</span> <span class='id identifier rubyid_configure'>configure</span>
376
+ <span class='kw'>yield</span> <span class='kw'>self</span>
377
+ <span class='kw'>self</span>
378
+ <span class='kw'>end</span></pre>
379
+ </td>
380
+ </tr>
381
+ </table>
382
+ </div>
383
+
384
+ <div class="method_details ">
385
+ <h3 class="signature " id="options-instance_method">
386
+
387
+ - (<tt>Hash</tt>) <strong>options</strong>
388
+
389
+
390
+
391
+
392
+
393
+ </h3><div class="docstring">
394
+ <div class="discussion">
395
+
396
+ <p>Create a hash of options and their values</p>
397
+
398
+
399
+ </div>
400
+ </div>
401
+ <div class="tags">
402
+
403
+ <p class="tag_title">Returns:</p>
404
+ <ul class="return">
405
+
406
+ <li>
407
+
408
+
409
+ <span class='type'>(<tt>Hash</tt>)</span>
410
+
411
+
412
+
413
+ </li>
414
+
415
+ </ul>
416
+
417
+ </div><table class="source_code">
418
+ <tr>
419
+ <td>
420
+ <pre class="lines">
421
+
422
+
423
+ 31
424
+ 32
425
+ 33
426
+ 34
427
+ 35</pre>
428
+ </td>
429
+ <td>
430
+ <pre class="code"><span class="info file"># File 'lib/mailer/config.rb', line 31</span>
431
+
432
+ <span class='kw'>def</span> <span class='id identifier rubyid_options'>options</span>
433
+ <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
434
+ <span class='const'>VALID_OPTIONS_KEYS</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span><span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_k'>k</span><span class='op'>|</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='id identifier rubyid_k'>k</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='id identifier rubyid_k'>k</span><span class='rparen'>)</span><span class='rbrace'>}</span>
435
+ <span class='id identifier rubyid_options'>options</span>
436
+ <span class='kw'>end</span></pre>
437
+ </td>
438
+ </tr>
439
+ </table>
440
+ </div>
441
+
442
+ <div class="method_details ">
443
+ <h3 class="signature " id="reset-instance_method">
444
+
445
+ - (<tt>self</tt>) <strong>reset</strong>
446
+
447
+
448
+
449
+
450
+
451
+ </h3><div class="docstring">
452
+ <div class="discussion">
453
+
454
+ <p>Reset config</p>
455
+
456
+
457
+ </div>
458
+ </div>
459
+ <div class="tags">
460
+
461
+ <p class="tag_title">Returns:</p>
462
+ <ul class="return">
463
+
464
+ <li>
465
+
466
+
467
+ <span class='type'>(<tt>self</tt>)</span>
468
+
469
+
470
+
471
+ </li>
472
+
473
+ </ul>
474
+
475
+ </div><table class="source_code">
476
+ <tr>
477
+ <td>
478
+ <pre class="lines">
479
+
480
+
481
+ 40
482
+ 41
483
+ 42
484
+ 43
485
+ 44</pre>
486
+ </td>
487
+ <td>
488
+ <pre class="code"><span class="info file"># File 'lib/mailer/config.rb', line 40</span>
489
+
490
+ <span class='kw'>def</span> <span class='id identifier rubyid_reset'>reset</span>
491
+ <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_api_token'>api_token</span> <span class='op'>=</span> <span class='const'>DEFAULT_API_TOKEN</span>
492
+ <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_api_domain'>api_domain</span> <span class='op'>=</span> <span class='const'>DEFAULT_API_DOMAIN</span>
493
+ <span class='kw'>self</span>
494
+ <span class='kw'>end</span></pre>
495
+ </td>
496
+ </tr>
497
+ </table>
498
+ </div>
499
+
500
+ </div>
501
+
502
+ </div>
503
+
504
+ <div id="footer">
505
+ Generated on Tue May 29 13:58:48 2012 by
506
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
507
+ 0.8.1 (ruby-1.9.3).
508
+ </div>
509
+
510
+ </body>
511
+ </html>