rockdove 0.1.0 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,1054 @@
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
+ Class: Rockdove::ExchangeMail
8
+
9
+ &mdash; Documentation by YARD 0.8.2.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 (E)</a> &raquo;
35
+ <span class='title'><span class='object_link'><a href="../Rockdove.html" title="Rockdove (module)">Rockdove</a></span></span>
36
+ &raquo;
37
+ <span class="title">ExchangeMail</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>Class: Rockdove::ExchangeMail
67
+
68
+
69
+
70
+ </h1>
71
+
72
+ <dl class="box">
73
+
74
+ <dt class="r1">Inherits:</dt>
75
+ <dd class="r1">
76
+ <span class="inheritName">Object</span>
77
+
78
+ <ul class="fullTree">
79
+ <li>Object</li>
80
+
81
+ <li class="next">Rockdove::ExchangeMail</li>
82
+
83
+ </ul>
84
+ <a href="#" class="inheritanceTree">show all</a>
85
+
86
+ </dd>
87
+
88
+
89
+
90
+
91
+ <dt class="r2">Extended by:</dt>
92
+ <dd class="r2">Forwardable</dd>
93
+
94
+
95
+
96
+
97
+
98
+
99
+
100
+ <dt class="r1 last">Defined in:</dt>
101
+ <dd class="r1 last">lib/rockdove/exchange_mail.rb</dd>
102
+
103
+ </dl>
104
+ <div class="clear"></div>
105
+
106
+
107
+
108
+
109
+
110
+ <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
111
+ <ul class="summary">
112
+
113
+ <li class="public ">
114
+ <span class="summary_signature">
115
+
116
+ <a href="#connection-instance_method" title="#connection (instance method)">- (Object) <strong>connection</strong> </a>
117
+
118
+
119
+
120
+ </span>
121
+
122
+
123
+
124
+
125
+
126
+
127
+
128
+
129
+
130
+
131
+
132
+
133
+ <span class="summary_desc"><div class='inline'><p>
134
+ Returns the value of attribute connection.
135
+ </p>
136
+ </div></span>
137
+
138
+ </li>
139
+
140
+
141
+ </ul>
142
+
143
+
144
+
145
+
146
+
147
+ <h2>
148
+ Instance Method Summary
149
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
150
+ </h2>
151
+
152
+ <ul class="summary">
153
+
154
+ <li class="public ">
155
+ <span class="summary_signature">
156
+
157
+ <a href="#attachments-instance_method" title="#attachments (instance method)">- (Object) <strong>attachments</strong> </a>
158
+
159
+
160
+
161
+ </span>
162
+
163
+
164
+
165
+
166
+
167
+
168
+
169
+
170
+
171
+ <span class="summary_desc"><div class='inline'><p>
172
+ Retrieve collection of attachments by accessing Rockdove::ExchangeMail
173
+ @class_instance.attachments.
174
+ </p>
175
+ </div></span>
176
+
177
+ </li>
178
+
179
+
180
+ <li class="public ">
181
+ <span class="summary_signature">
182
+
183
+ <a href="#body-instance_method" title="#body (instance method)">- (Object) <strong>body</strong> </a>
184
+
185
+
186
+
187
+ </span>
188
+
189
+
190
+
191
+
192
+
193
+
194
+
195
+
196
+
197
+ <span class="summary_desc"><div class='inline'><p>
198
+ Retrieve parsed body content of the mail by accessing
199
+ Rockdove::ExchangeMail @class_instance.body.
200
+ </p>
201
+ </div></span>
202
+
203
+ </li>
204
+
205
+
206
+ <li class="public ">
207
+ <span class="summary_signature">
208
+
209
+ <a href="#cc_recipients-instance_method" title="#cc_recipients (instance method)">- (Object) <strong>cc_recipients</strong> </a>
210
+
211
+
212
+
213
+ </span>
214
+
215
+
216
+
217
+
218
+
219
+
220
+
221
+
222
+
223
+ <span class="summary_desc"><div class='inline'><p>
224
+ Get a list of cc recipients by accessing Rockdove::ExchangeMail
225
+ @class_instance.cc_recipients.
226
+ </p>
227
+ </div></span>
228
+
229
+ </li>
230
+
231
+
232
+ <li class="public ">
233
+ <span class="summary_signature">
234
+
235
+ <a href="#date_time_created-instance_method" title="#date_time_created (instance method)">- (Object) <strong>date_time_created</strong> </a>
236
+
237
+
238
+
239
+ </span>
240
+
241
+
242
+
243
+
244
+
245
+
246
+
247
+
248
+
249
+ <span class="summary_desc"><div class='inline'><p>
250
+ Retrieve date_time_created of the mail by accessing Rockdove::ExchangeMail
251
+ @class_instance.date_time_created.
252
+ </p>
253
+ </div></span>
254
+
255
+ </li>
256
+
257
+
258
+ <li class="public ">
259
+ <span class="summary_signature">
260
+
261
+ <a href="#date_time_sent-instance_method" title="#date_time_sent (instance method)">- (Object) <strong>date_time_sent</strong> </a>
262
+
263
+
264
+
265
+ </span>
266
+
267
+
268
+
269
+
270
+
271
+
272
+
273
+
274
+
275
+ <span class="summary_desc"><div class='inline'><p>
276
+ Retrieve date_time_sent of the mail by accessing Rockdove::ExchangeMail
277
+ @class_instance.date_time_sent.
278
+ </p>
279
+ </div></span>
280
+
281
+ </li>
282
+
283
+
284
+ <li class="public ">
285
+ <span class="summary_signature">
286
+
287
+ <a href="#from-instance_method" title="#from (instance method)">- (Object) <strong>from</strong> </a>
288
+
289
+
290
+
291
+ </span>
292
+
293
+
294
+
295
+
296
+
297
+
298
+
299
+
300
+
301
+ <span class="summary_desc"><div class='inline'><p>
302
+ Retrieve from email address by accessing Rockdove::ExchangeMail
303
+ @class_instance.from.
304
+ </p>
305
+ </div></span>
306
+
307
+ </li>
308
+
309
+
310
+ <li class="public ">
311
+ <span class="summary_signature">
312
+
313
+ <a href="#get_items-instance_method" title="#get_items (instance method)">- (Object) <strong>get_items</strong>(mail) </a>
314
+
315
+
316
+
317
+ </span>
318
+
319
+
320
+
321
+
322
+
323
+
324
+
325
+
326
+
327
+ <span class="summary_desc"><div class='inline'><p>
328
+ Retrieves the mail item with text type body content.
329
+ </p>
330
+ </div></span>
331
+
332
+ </li>
333
+
334
+
335
+ <li class="public ">
336
+ <span class="summary_signature">
337
+
338
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (ExchangeMail) <strong>initialize</strong>(mail_item, connection) </a>
339
+
340
+
341
+
342
+ </span>
343
+
344
+
345
+ <span class="note title constructor">constructor</span>
346
+
347
+
348
+
349
+
350
+
351
+
352
+
353
+
354
+ <span class="summary_desc"><div class='inline'><p>
355
+ A new instance of ExchangeMail.
356
+ </p>
357
+ </div></span>
358
+
359
+ </li>
360
+
361
+
362
+ <li class="public ">
363
+ <span class="summary_signature">
364
+
365
+ <a href="#parse_it-instance_method" title="#parse_it (instance method)">- (Object) <strong>parse_it</strong>(mail_body, type) </a>
366
+
367
+
368
+
369
+ </span>
370
+
371
+
372
+
373
+
374
+
375
+
376
+
377
+
378
+
379
+ <span class="summary_desc"><div class='inline'><p>
380
+ This method parses the mail content provided @params of body and body_type.
381
+ </p>
382
+ </div></span>
383
+
384
+ </li>
385
+
386
+
387
+ <li class="public ">
388
+ <span class="summary_signature">
389
+
390
+ <a href="#retrieve_text_type-instance_method" title="#retrieve_text_type (instance method)">- (Object) <strong>retrieve_text_type</strong> </a>
391
+
392
+
393
+
394
+ </span>
395
+
396
+
397
+
398
+
399
+
400
+
401
+
402
+
403
+
404
+ <span class="summary_desc"><div class='inline'><p>
405
+ Retrieves text type body content of the mail.
406
+ </p>
407
+ </div></span>
408
+
409
+ </li>
410
+
411
+
412
+ <li class="public ">
413
+ <span class="summary_signature">
414
+
415
+ <a href="#subject-instance_method" title="#subject (instance method)">- (Object) <strong>subject</strong> </a>
416
+
417
+
418
+
419
+ </span>
420
+
421
+
422
+
423
+
424
+
425
+
426
+
427
+
428
+
429
+ <span class="summary_desc"><div class='inline'><p>
430
+ Retrieve subject of the mail by accessing Rockdove::ExchangeMail
431
+ @class_instance.subject.
432
+ </p>
433
+ </div></span>
434
+
435
+ </li>
436
+
437
+
438
+ <li class="public ">
439
+ <span class="summary_signature">
440
+
441
+ <a href="#to_recipients-instance_method" title="#to_recipients (instance method)">- (Object) <strong>to_recipients</strong> </a>
442
+
443
+
444
+
445
+ </span>
446
+
447
+
448
+
449
+
450
+
451
+
452
+
453
+
454
+
455
+ <span class="summary_desc"><div class='inline'><p>
456
+ Get a list of to recipients by accessing Rockdove::ExchangeMail
457
+ @class_instance.to_recipients.
458
+ </p>
459
+ </div></span>
460
+
461
+ </li>
462
+
463
+
464
+ </ul>
465
+
466
+
467
+
468
+ <div id="constructor_details" class="method_details_list">
469
+ <h2>Constructor Details</h2>
470
+
471
+ <div class="method_details first">
472
+ <h3 class="signature first" id="initialize-instance_method">
473
+
474
+ - (<tt><span class='object_link'><a href="" title="Rockdove::ExchangeMail (class)">ExchangeMail</a></span></tt>) <strong>initialize</strong>(mail_item, connection)
475
+
476
+
477
+
478
+
479
+
480
+ </h3><div class="docstring">
481
+ <div class="discussion">
482
+ <p>
483
+ A new instance of ExchangeMail
484
+ </p>
485
+
486
+
487
+ </div>
488
+ </div>
489
+ <div class="tags">
490
+
491
+
492
+ </div><table class="source_code">
493
+ <tr>
494
+ <td>
495
+ <pre class="lines">
496
+
497
+
498
+ 15
499
+ 16
500
+ 17
501
+ 18</pre>
502
+ </td>
503
+ <td>
504
+ <pre class="code"><span class="info file"># File 'lib/rockdove/exchange_mail.rb', line 15</span>
505
+
506
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_mail_item'>mail_item</span><span class='comma'>,</span> <span class='id identifier rubyid_connection'>connection</span><span class='rparen'>)</span>
507
+ <span class='ivar'>@mail_item</span> <span class='op'>=</span> <span class='id identifier rubyid_mail_item'>mail_item</span>
508
+ <span class='ivar'>@connection</span> <span class='op'>=</span> <span class='id identifier rubyid_connection'>connection</span>
509
+ <span class='kw'>end</span></pre>
510
+ </td>
511
+ </tr>
512
+ </table>
513
+ </div>
514
+
515
+ </div>
516
+
517
+ <div id="instance_attr_details" class="attr_details">
518
+ <h2>Instance Attribute Details</h2>
519
+
520
+
521
+ <span id="connection=-instance_method"></span>
522
+ <div class="method_details first">
523
+ <h3 class="signature first" id="connection-instance_method">
524
+
525
+ - (<tt>Object</tt>) <strong>connection</strong>
526
+
527
+
528
+
529
+
530
+
531
+ </h3><div class="docstring">
532
+ <div class="discussion">
533
+ <p>
534
+ Returns the value of attribute connection
535
+ </p>
536
+
537
+
538
+ </div>
539
+ </div>
540
+ <div class="tags">
541
+
542
+
543
+ </div><table class="source_code">
544
+ <tr>
545
+ <td>
546
+ <pre class="lines">
547
+
548
+
549
+ 13
550
+ 14
551
+ 15</pre>
552
+ </td>
553
+ <td>
554
+ <pre class="code"><span class="info file"># File 'lib/rockdove/exchange_mail.rb', line 13</span>
555
+
556
+ <span class='kw'>def</span> <span class='id identifier rubyid_connection'>connection</span>
557
+ <span class='ivar'>@connection</span>
558
+ <span class='kw'>end</span></pre>
559
+ </td>
560
+ </tr>
561
+ </table>
562
+ </div>
563
+
564
+ </div>
565
+
566
+
567
+ <div id="instance_method_details" class="method_details_list">
568
+ <h2>Instance Method Details</h2>
569
+
570
+
571
+ <div class="method_details first">
572
+ <h3 class="signature first" id="attachments-instance_method">
573
+
574
+ - (<tt>Object</tt>) <strong>attachments</strong>
575
+
576
+
577
+
578
+
579
+
580
+ </h3><div class="docstring">
581
+ <div class="discussion">
582
+ <p>
583
+ Retrieve collection of attachments by accessing Rockdove::ExchangeMail
584
+ @class_instance.attachments
585
+ </p>
586
+
587
+
588
+ </div>
589
+ </div>
590
+ <div class="tags">
591
+
592
+
593
+ </div><table class="source_code">
594
+ <tr>
595
+ <td>
596
+ <pre class="lines">
597
+
598
+
599
+ 52
600
+ 53
601
+ 54</pre>
602
+ </td>
603
+ <td>
604
+ <pre class="code"><span class="info file"># File 'lib/rockdove/exchange_mail.rb', line 52</span>
605
+
606
+ <span class='kw'>def</span> <span class='id identifier rubyid_attachments'>attachments</span>
607
+ <span class='ivar'>@mail_item</span><span class='period'>.</span><span class='id identifier rubyid_attachments'>attachments</span>
608
+ <span class='kw'>end</span></pre>
609
+ </td>
610
+ </tr>
611
+ </table>
612
+ </div>
613
+
614
+ <div class="method_details ">
615
+ <h3 class="signature " id="body-instance_method">
616
+
617
+ - (<tt>Object</tt>) <strong>body</strong>
618
+
619
+
620
+
621
+
622
+
623
+ </h3><div class="docstring">
624
+ <div class="discussion">
625
+ <p>
626
+ Retrieve parsed body content of the mail by accessing
627
+ Rockdove::ExchangeMail @class_instance.body
628
+ </p>
629
+
630
+
631
+ </div>
632
+ </div>
633
+ <div class="tags">
634
+
635
+
636
+ </div><table class="source_code">
637
+ <tr>
638
+ <td>
639
+ <pre class="lines">
640
+
641
+
642
+ 41
643
+ 42
644
+ 43
645
+ 44</pre>
646
+ </td>
647
+ <td>
648
+ <pre class="code"><span class="info file"># File 'lib/rockdove/exchange_mail.rb', line 41</span>
649
+
650
+ <span class='kw'>def</span> <span class='id identifier rubyid_body'>body</span>
651
+ <span class='id identifier rubyid_mail'>mail</span> <span class='op'>=</span> <span class='id identifier rubyid_get_items'>get_items</span><span class='lparen'>(</span><span class='ivar'>@mail_item</span><span class='rparen'>)</span>
652
+ <span class='id identifier rubyid_parse_it'>parse_it</span><span class='lparen'>(</span><span class='id identifier rubyid_mail'>mail</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span><span class='comma'>,</span> <span class='id identifier rubyid_mail'>mail</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='period'>.</span><span class='id identifier rubyid_body_type'>body_type</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_mail'>mail</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
653
+ <span class='kw'>end</span></pre>
654
+ </td>
655
+ </tr>
656
+ </table>
657
+ </div>
658
+
659
+ <div class="method_details ">
660
+ <h3 class="signature " id="cc_recipients-instance_method">
661
+
662
+ - (<tt>Object</tt>) <strong>cc_recipients</strong>
663
+
664
+
665
+
666
+
667
+
668
+ </h3><div class="docstring">
669
+ <div class="discussion">
670
+ <p>
671
+ Get a list of cc recipients by accessing Rockdove::ExchangeMail
672
+ @class_instance.cc_recipients
673
+ </p>
674
+
675
+
676
+ </div>
677
+ </div>
678
+ <div class="tags">
679
+
680
+
681
+ </div><table class="source_code">
682
+ <tr>
683
+ <td>
684
+ <pre class="lines">
685
+
686
+
687
+ 26
688
+ 27
689
+ 28</pre>
690
+ </td>
691
+ <td>
692
+ <pre class="code"><span class="info file"># File 'lib/rockdove/exchange_mail.rb', line 26</span>
693
+
694
+ <span class='kw'>def</span> <span class='id identifier rubyid_cc_recipients'>cc_recipients</span>
695
+ <span class='ivar'>@mail_item</span><span class='period'>.</span><span class='id identifier rubyid_cc_recipients'>cc_recipients</span><span class='period'>.</span><span class='id identifier rubyid_collect'>collect</span> <span class='op'>&amp;</span><span class='symbol'>:email_address</span> <span class='kw'>if</span> <span class='ivar'>@mail_item</span><span class='period'>.</span><span class='id identifier rubyid_cc_recipients'>cc_recipients</span>
696
+ <span class='kw'>end</span></pre>
697
+ </td>
698
+ </tr>
699
+ </table>
700
+ </div>
701
+
702
+ <div class="method_details ">
703
+ <h3 class="signature " id="date_time_created-instance_method">
704
+
705
+ - (<tt>Object</tt>) <strong>date_time_created</strong>
706
+
707
+
708
+
709
+
710
+
711
+ </h3><div class="docstring">
712
+ <div class="discussion">
713
+ <p>
714
+ Retrieve date_time_created of the mail by accessing Rockdove::ExchangeMail
715
+ @class_instance.date_time_created
716
+ </p>
717
+
718
+
719
+ </div>
720
+ </div>
721
+ <div class="tags">
722
+
723
+
724
+ </div><table class="source_code">
725
+ <tr>
726
+ <td>
727
+ <pre class="lines">
728
+
729
+
730
+ 57
731
+ 58
732
+ 59</pre>
733
+ </td>
734
+ <td>
735
+ <pre class="code"><span class="info file"># File 'lib/rockdove/exchange_mail.rb', line 57</span>
736
+
737
+ <span class='kw'>def</span> <span class='id identifier rubyid_date_time_created'>date_time_created</span>
738
+ <span class='ivar'>@mail_item</span><span class='period'>.</span><span class='id identifier rubyid_date_time_created'>date_time_created</span>
739
+ <span class='kw'>end</span></pre>
740
+ </td>
741
+ </tr>
742
+ </table>
743
+ </div>
744
+
745
+ <div class="method_details ">
746
+ <h3 class="signature " id="date_time_sent-instance_method">
747
+
748
+ - (<tt>Object</tt>) <strong>date_time_sent</strong>
749
+
750
+
751
+
752
+
753
+
754
+ </h3><div class="docstring">
755
+ <div class="discussion">
756
+ <p>
757
+ Retrieve date_time_sent of the mail by accessing Rockdove::ExchangeMail
758
+ @class_instance.date_time_sent
759
+ </p>
760
+
761
+
762
+ </div>
763
+ </div>
764
+ <div class="tags">
765
+
766
+
767
+ </div><table class="source_code">
768
+ <tr>
769
+ <td>
770
+ <pre class="lines">
771
+
772
+
773
+ 62
774
+ 63
775
+ 64</pre>
776
+ </td>
777
+ <td>
778
+ <pre class="code"><span class="info file"># File 'lib/rockdove/exchange_mail.rb', line 62</span>
779
+
780
+ <span class='kw'>def</span> <span class='id identifier rubyid_date_time_sent'>date_time_sent</span>
781
+ <span class='ivar'>@mail_item</span><span class='period'>.</span><span class='id identifier rubyid_date_time_sent'>date_time_sent</span>
782
+ <span class='kw'>end</span></pre>
783
+ </td>
784
+ </tr>
785
+ </table>
786
+ </div>
787
+
788
+ <div class="method_details ">
789
+ <h3 class="signature " id="from-instance_method">
790
+
791
+ - (<tt>Object</tt>) <strong>from</strong>
792
+
793
+
794
+
795
+
796
+
797
+ </h3><div class="docstring">
798
+ <div class="discussion">
799
+ <p>
800
+ Retrieve from email address by accessing Rockdove::ExchangeMail
801
+ @class_instance.from
802
+ </p>
803
+
804
+
805
+ </div>
806
+ </div>
807
+ <div class="tags">
808
+
809
+
810
+ </div><table class="source_code">
811
+ <tr>
812
+ <td>
813
+ <pre class="lines">
814
+
815
+
816
+ 31
817
+ 32
818
+ 33</pre>
819
+ </td>
820
+ <td>
821
+ <pre class="code"><span class="info file"># File 'lib/rockdove/exchange_mail.rb', line 31</span>
822
+
823
+ <span class='kw'>def</span> <span class='id identifier rubyid_from'>from</span>
824
+ <span class='ivar'>@mail_item</span><span class='period'>.</span><span class='id identifier rubyid_from'>from</span><span class='period'>.</span><span class='id identifier rubyid_email_address'>email_address</span> <span class='kw'>if</span> <span class='ivar'>@mail_item</span><span class='period'>.</span><span class='id identifier rubyid_from'>from</span>
825
+ <span class='kw'>end</span></pre>
826
+ </td>
827
+ </tr>
828
+ </table>
829
+ </div>
830
+
831
+ <div class="method_details ">
832
+ <h3 class="signature " id="get_items-instance_method">
833
+
834
+ - (<tt>Object</tt>) <strong>get_items</strong>(mail)
835
+
836
+
837
+
838
+
839
+
840
+ </h3><div class="docstring">
841
+ <div class="discussion">
842
+ <p>
843
+ Retrieves the mail item with text type body content
844
+ </p>
845
+
846
+
847
+ </div>
848
+ </div>
849
+ <div class="tags">
850
+
851
+
852
+ </div><table class="source_code">
853
+ <tr>
854
+ <td>
855
+ <pre class="lines">
856
+
857
+
858
+ 47
859
+ 48
860
+ 49</pre>
861
+ </td>
862
+ <td>
863
+ <pre class="code"><span class="info file"># File 'lib/rockdove/exchange_mail.rb', line 47</span>
864
+
865
+ <span class='kw'>def</span> <span class='id identifier rubyid_get_items'>get_items</span><span class='lparen'>(</span><span class='id identifier rubyid_mail'>mail</span><span class='rparen'>)</span>
866
+ <span class='ivar'>@connection</span><span class='period'>.</span><span class='id identifier rubyid_get_items'>get_items</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='id identifier rubyid_mail'>mail</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='lbrace'>{</span><span class='symbol'>:item_shape</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_retrieve_text_type'>retrieve_text_type</span><span class='rbrace'>}</span><span class='rparen'>)</span>
867
+ <span class='kw'>end</span></pre>
868
+ </td>
869
+ </tr>
870
+ </table>
871
+ </div>
872
+
873
+ <div class="method_details ">
874
+ <h3 class="signature " id="parse_it-instance_method">
875
+
876
+ - (<tt>Object</tt>) <strong>parse_it</strong>(mail_body, type)
877
+
878
+
879
+
880
+
881
+
882
+ </h3><div class="docstring">
883
+ <div class="discussion">
884
+ <p>
885
+ This method parses the mail content provided @params of body and body_type
886
+ </p>
887
+
888
+
889
+ </div>
890
+ </div>
891
+ <div class="tags">
892
+
893
+
894
+ </div><table class="source_code">
895
+ <tr>
896
+ <td>
897
+ <pre class="lines">
898
+
899
+
900
+ 67
901
+ 68
902
+ 69</pre>
903
+ </td>
904
+ <td>
905
+ <pre class="code"><span class="info file"># File 'lib/rockdove/exchange_mail.rb', line 67</span>
906
+
907
+ <span class='kw'>def</span> <span class='id identifier rubyid_parse_it'>parse_it</span><span class='lparen'>(</span><span class='id identifier rubyid_mail_body'>mail_body</span><span class='comma'>,</span> <span class='id identifier rubyid_type'>type</span><span class='rparen'>)</span>
908
+ <span class='const'>Rockdove</span><span class='op'>::</span><span class='const'>EmailParser</span><span class='period'>.</span><span class='id identifier rubyid_parse_mail'>parse_mail</span><span class='lparen'>(</span><span class='id identifier rubyid_mail_body'>mail_body</span><span class='comma'>,</span> <span class='id identifier rubyid_type'>type</span><span class='rparen'>)</span>
909
+ <span class='kw'>end</span></pre>
910
+ </td>
911
+ </tr>
912
+ </table>
913
+ </div>
914
+
915
+ <div class="method_details ">
916
+ <h3 class="signature " id="retrieve_text_type-instance_method">
917
+
918
+ - (<tt>Object</tt>) <strong>retrieve_text_type</strong>
919
+
920
+
921
+
922
+
923
+
924
+ </h3><div class="docstring">
925
+ <div class="discussion">
926
+ <p>
927
+ Retrieves text type body content of the mail
928
+ </p>
929
+
930
+
931
+ </div>
932
+ </div>
933
+ <div class="tags">
934
+
935
+
936
+ </div><table class="source_code">
937
+ <tr>
938
+ <td>
939
+ <pre class="lines">
940
+
941
+
942
+ 72
943
+ 73
944
+ 74</pre>
945
+ </td>
946
+ <td>
947
+ <pre class="code"><span class="info file"># File 'lib/rockdove/exchange_mail.rb', line 72</span>
948
+
949
+ <span class='kw'>def</span> <span class='id identifier rubyid_retrieve_text_type'>retrieve_text_type</span>
950
+ <span class='lbrace'>{</span><span class='symbol'>:base_shape</span><span class='op'>=&gt;</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>AllProperties</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='symbol'>:body_type</span><span class='op'>=&gt;</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Text</span><span class='tstring_end'>&quot;</span></span><span class='rbrace'>}</span>
951
+ <span class='kw'>end</span></pre>
952
+ </td>
953
+ </tr>
954
+ </table>
955
+ </div>
956
+
957
+ <div class="method_details ">
958
+ <h3 class="signature " id="subject-instance_method">
959
+
960
+ - (<tt>Object</tt>) <strong>subject</strong>
961
+
962
+
963
+
964
+
965
+
966
+ </h3><div class="docstring">
967
+ <div class="discussion">
968
+ <p>
969
+ Retrieve subject of the mail by accessing Rockdove::ExchangeMail
970
+ @class_instance.subject
971
+ </p>
972
+
973
+
974
+ </div>
975
+ </div>
976
+ <div class="tags">
977
+
978
+
979
+ </div><table class="source_code">
980
+ <tr>
981
+ <td>
982
+ <pre class="lines">
983
+
984
+
985
+ 36
986
+ 37
987
+ 38</pre>
988
+ </td>
989
+ <td>
990
+ <pre class="code"><span class="info file"># File 'lib/rockdove/exchange_mail.rb', line 36</span>
991
+
992
+ <span class='kw'>def</span> <span class='id identifier rubyid_subject'>subject</span>
993
+ <span class='ivar'>@mail_item</span><span class='period'>.</span><span class='id identifier rubyid_subject'>subject</span>
994
+ <span class='kw'>end</span></pre>
995
+ </td>
996
+ </tr>
997
+ </table>
998
+ </div>
999
+
1000
+ <div class="method_details ">
1001
+ <h3 class="signature " id="to_recipients-instance_method">
1002
+
1003
+ - (<tt>Object</tt>) <strong>to_recipients</strong>
1004
+
1005
+
1006
+
1007
+
1008
+
1009
+ </h3><div class="docstring">
1010
+ <div class="discussion">
1011
+ <p>
1012
+ Get a list of to recipients by accessing Rockdove::ExchangeMail
1013
+ @class_instance.to_recipients
1014
+ </p>
1015
+
1016
+
1017
+ </div>
1018
+ </div>
1019
+ <div class="tags">
1020
+
1021
+
1022
+ </div><table class="source_code">
1023
+ <tr>
1024
+ <td>
1025
+ <pre class="lines">
1026
+
1027
+
1028
+ 21
1029
+ 22
1030
+ 23</pre>
1031
+ </td>
1032
+ <td>
1033
+ <pre class="code"><span class="info file"># File 'lib/rockdove/exchange_mail.rb', line 21</span>
1034
+
1035
+ <span class='kw'>def</span> <span class='id identifier rubyid_to_recipients'>to_recipients</span>
1036
+ <span class='ivar'>@mail_item</span><span class='period'>.</span><span class='id identifier rubyid_to_recipients'>to_recipients</span><span class='period'>.</span><span class='id identifier rubyid_collect'>collect</span> <span class='op'>&amp;</span><span class='symbol'>:email_address</span> <span class='kw'>if</span> <span class='ivar'>@mail_item</span><span class='period'>.</span><span class='id identifier rubyid_to_recipients'>to_recipients</span>
1037
+ <span class='kw'>end</span></pre>
1038
+ </td>
1039
+ </tr>
1040
+ </table>
1041
+ </div>
1042
+
1043
+ </div>
1044
+
1045
+ </div>
1046
+
1047
+ <div id="footer">
1048
+ Generated on Wed Jul 11 11:40:25 2012 by
1049
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1050
+ 0.8.2.1 (ruby-1.9.2).
1051
+ </div>
1052
+
1053
+ </body>
1054
+ </html>