File: mail.html

package info (click to toggle)
libtmail-ruby 0.10.8-1
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 856 kB
  • ctags: 1,461
  • sloc: ruby: 8,406; ansic: 678; objc: 584; yacc: 305; makefile: 149
file content (737 lines) | stat: -rw-r--r-- 18,974 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html lang="en">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
  <meta http-equiv="Content-Language" content="en">
<title><code>class <a name="TMail%3a%3aMail">TMail::Mail</a> </code></title>
</head>
<body>

<h1><code>class <a name="TMail%3a%3aMail">TMail::Mail</a> </code></h1>

<h2>Class Methods</h2>

<dl>
<dt><a name="TMail%3a%3aMail-new"><code>new(port = TMail::StringPort.new, <var>config</var> = DEFAULT_CONFIG)</code></a> -&gt; <code><a href="mail.html#TMail%3a%3aMail">TMail::Mail</a></code></dt>
<dd>
<p>
port: <a href="port.html#TMail%3a%3aPort">TMail::Port</a><br>
config: <a href="config.html#TMail%3a%3aConfig">TMail::Config</a><br>
</p>

<p>
creates a new <code>TMail::Mail</code> object from PORT.
</p>

</dd>
<dt><a name="TMail%3a%3aMail-load"><code>load(filename)</code></a> -&gt; <code><a href="mail.html#TMail%3a%3aMail">TMail::Mail</a></code></dt>
<dd>
<p>
filename: String<br>
</p>

<p>
creates a new <code>TMail::Mail</code> object. FILENAME is the name of file
which contains just one mail (e.g. MH mail file).
</p>

</dd>
<dt><a name="TMail%3a%3aMail-parse"><code>parse(str)</code></a> -&gt; <code><a href="mail.html#TMail%3a%3aMail">TMail::Mail</a></code></dt>
<dd>
<p>
str: String<br>
</p>

<p>
parses STR and creates a new <code>TMail::Mail</code> object.
</p>

</dd>
</dl>
<h2>Instance Methods</h2>

<dl>
<dt><a name="TMail%3a%3aMail-port"><code>port</code></a> -&gt; <code><a href="port.html#TMail%3a%3aPort">TMail::Port</a></code></dt>
<dd>
<p>
the source port of this mail.
</p>

</dd>
<dt><a name="TMail%3a%3aMail-body_port"><code>body_port</code></a> -&gt; <code><a href="port.html#TMail%3a%3aPort">TMail::Port</a></code></dt>
<dd>
<p>
the port to save body of this mail.
</p>

</dd>
<dt><a name="TMail%3a%3aMail-each%20%7b%7cline%7c%20%2e%2e%2e%2e%20%7d"><code>each {|line| .... }</code></a></dt>
<dd>
<p>
line: String<br>
</p>

<p>
iterates for each lines of mail body.
</p>

</dd>
<dt><a name="TMail%3a%3aMail-body"><code>body</code></a> -&gt; <code>String</code></dt>
<dt><a name="TMail%3a%3aMail-preamble"><code>preamble</code></a> -&gt; <code>String</code></dt>
<dd>
<p>
the mail body. If the mail is a MIME multipart mail,
this attribute represents "preamble".
</p>

</dd>
<dt><a name="TMail%3a%3aMail-parts"><code>parts</code></a> -&gt; <code>[<a href="mail.html#TMail%3a%3aMail">TMail::Mail</a>]</code></dt>
<dd>
<p>
parts of this mail. (valid only if this mail is a MIME multipart mail)
</p>

</dd>
<dt><a name="TMail%3a%3aMail-epilogue"><code>epilogue</code></a> -&gt; <code>String</code></dt>
<dd>
<p>
If the mail was MIME multipart mail, this represent "epilogue" string.
Else, empty string.
</p>

</dd>
<dt><a name="TMail%3a%3aMail-multipart%3f"><code>multipart?</code></a></dt>
<dd>
<p>
true if the message is a multi-part mail.
</p>

</dd>
<dt><a name="TMail%3a%3aMail-encoded"><code>encoded(eol = "\n", <var>encoding</var> = 'j')</code></a> -&gt; <code>String</code></dt>
<dd>
<p>
eol: String<br>
encoding: String<br>
</p>

<p>
converts the mail object to a MIME encoded string.
</p>

</dd>
<dt><a name="TMail%3a%3aMail-decoded"><code>decoded(eol = "\n", <var>encoding</var> = 'e')</code></a> -&gt; <code>String</code></dt>
<dt><a name="TMail%3a%3aMail-to_s"><code>to_s(eol = "\n", <var>encoding</var> = 'e')</code></a> -&gt; <code>String</code></dt>
<dd>
<p>
eol: String<br>
encoding: String<br>
</p>

<p>
converts the mail object to a decoded string.
</p>

</dd>
<dt><a name="TMail%3a%3aMail-inspect"><code>inspect</code></a> -&gt; <code>String</code></dt>
<dd>
<p>
returns simple string representation like
<code>"#&lt;TMail::Mail port=&lt;StringPort:str=...&gt;&gt;"</code>
</p>

</dd>
<dt><a name="TMail%3a%3aMail-write_back"><code>write_back(eol = "\n", <var>encoding</var> = 'e')</code></a></dt>
<dd>
<p>
eol: String<br>
encoding: String<br>
</p>

<p>
converts this mail into string and write back to <code>body_port</code>,
setting line terminator to EOL.
</p>

</dd>
</dl>
<h3>Property Access Method</h3>

<dl>
<dt><a name="TMail%3a%3aMail-date"><code>date(default = nil)</code></a> -&gt; <code>Time</code></dt>
<dt><a name="TMail%3a%3aMail-date%3d"><code>date=(datetime)</code></a></dt>
<dd>
<p>
datetime: Time<br>
default: Object<br>
</p>

<p>
a Time object of Date: header field.
</p>

</dd>
<dt><a name="TMail%3a%3aMail-strftime"><code>strftime(format, <var>default</var> = nil)</code></a> -&gt; <code>String</code></dt>
<dd>
<p>
format: String<br>
default: Object<br>
</p>

<p>
is equals to <code>date.strftime(format)</code>.
If date is not exist, this method does nothing and
returns <var>default</var>.
</p>

</dd>
<dt><a name="TMail%3a%3aMail-to"><code>to(default = nil)</code></a> -&gt; <code>[String]</code></dt>
<dt><a name="TMail%3a%3aMail-to%3d"><code>to=(specs)</code></a></dt>
<dd>
<p>
specs: String | [String]<br>
default: Object<br>
</p>

<p>
address specs for To: header field.
</p>

</dd>
<dt><a name="TMail%3a%3aMail-to_addrs"><code>to_addrs(default = nil)</code></a> -&gt; <code>[<a href="address.html#TMail%3a%3aAddress">TMail::Address</a> | <a href="address.html#TMail%3a%3aAddressGroup">TMail::AddressGroup</a>]</code></dt>
<dt><a name="TMail%3a%3aMail-to_addrs%3d"><code>to_addrs=(addrs)</code></a></dt>
<dd>
<p>
addrs: <a href="address.html#TMail%3a%3aAddress">TMail::Address</a> | [<a href="address.html#TMail%3a%3aAddress">TMail::Address</a>]<br>
default: Object<br>
</p>

<p>
adresses which is represented in To: header field.
</p>

</dd>
<dt><a name="TMail%3a%3aMail-cc"><code>cc(default = nil)</code></a> -&gt; <code>[String]</code></dt>
<dt><a name="TMail%3a%3aMail-cc%3d"><code>cc=(specs)</code></a></dt>
<dd>
<p>
specs: String | [String]<br>
default: Object<br>
</p>

<p>
address specs for Cc: header field.
</p>

</dd>
<dt><a name="TMail%3a%3aMail-cc_addrs"><code>cc_addrs(default = nil)</code></a> -&gt; <code>[<a href="address.html#TMail%3a%3aAddress">TMail::Address</a>]</code></dt>
<dt><a name="TMail%3a%3aMail-cc_addrs%3d"><code>cc_addrs=(addrs)</code></a></dt>
<dd>
<p>
addrs: <a href="address.html#TMail%3a%3aAddress">TMail::Address</a> | [<a href="address.html#TMail%3a%3aAddress">TMail::Address</a>]<br>
default: Object<br>
</p>

<p>
addresses which is represented in Cc: header field.
</p>

</dd>
<dt><a name="TMail%3a%3aMail-bcc"><code>bcc(default = nil)</code></a> -&gt; <code>[String]</code></dt>
<dt><a name="TMail%3a%3aMail-bcc%3d"><code>bcc=(specs)</code></a></dt>
<dd>
<p>
specs: String | [String]<br>
default: Object<br>
</p>

<p>
address specs for Bcc: header field.
</p>

</dd>
<dt><a name="TMail%3a%3aMail-bcc_addrs"><code>bcc_addrs(default = nil)</code></a> -&gt; <code>[<a href="address.html#TMail%3a%3aAddress">TMail::Address</a>]</code></dt>
<dt><a name="TMail%3a%3aMail-bcc_addrs%3d"><code>bcc_addrs=(addrs)</code></a></dt>
<dd>
<p>
addrs: <a href="address.html#TMail%3a%3aAddress">TMail::Address</a> | [<a href="address.html#TMail%3a%3aAddress">TMail::Address</a>]<br>
default: Object<br>
</p>

<p>
adresses which is represented in Bcc: header field.
</p>

</dd>
<dt><a name="TMail%3a%3aMail-from"><code>from(default = nil)</code></a> -&gt; <code>[String]</code></dt>
<dt><a name="TMail%3a%3aMail-from%3d"><code>from=(specs)</code></a></dt>
<dd>
<p>
specs: String | [String]<br>
default: Object<br>
</p>

<p>
address specs for From: header field.
</p>

</dd>
<dt><a name="TMail%3a%3aMail-from_addrs"><code>from_addrs(default = nil)</code></a> -&gt; <code>[<a href="address.html#TMail%3a%3aAddress">TMail::Address</a>]</code></dt>
<dt><a name="TMail%3a%3aMail-from_addrs%3d"><code>from_addrs=(addrs)</code></a></dt>
<dd>
<p>
addrs: <a href="address.html#TMail%3a%3aAddress">TMail::Address</a> | [<a href="address.html#TMail%3a%3aAddress">TMail::Address</a>]<br>
default: Object<br>
</p>

<p>
adresses which is represented in From: header field.
</p>

</dd>
<dt><a name="TMail%3a%3aMail-friendly_from"><code>friendly_from(default = nil)</code></a> -&gt; <code>String</code></dt>
<dd>
<p>
default: Object<br>
</p>

<p>
a "phrase" part or address spec of the first From: address.
</p>

</dd>
<dt><a name="TMail%3a%3aMail-reply_to"><code>reply_to(default = nil)</code></a> -&gt; <code>[String]</code></dt>
<dt><a name="TMail%3a%3aMail-reply_to%3d"><code>reply_to=(specs)</code></a></dt>
<dd>
<p>
specs: String | [String]<br>
default: Object<br>
</p>

<p>
address specs of Reply-To: header field.
</p>

</dd>
<dt><a name="TMail%3a%3aMail-reply_to_addrs"><code>reply_to_addrs(default = nil)</code></a> -&gt; <code>[<a href="address.html#TMail%3a%3aAddress">TMail::Address</a>]</code></dt>
<dt><a name="TMail%3a%3aMail-reply_to_addrs%3d"><code>reply_to_addrs=(addrs)</code></a></dt>
<dd>
<p>
addrs: <a href="address.html#TMail%3a%3aAddress">TMail::Address</a> | [<a href="address.html#TMail%3a%3aAddress">TMail::Address</a>]<br>
default: Object<br>
</p>

<p>
adresses which is represented in Reply-To: header field.
</p>

</dd>
<dt><a name="TMail%3a%3aMail-sender"><code>sender(default = nil)</code></a> -&gt; <code>String</code></dt>
<dt><a name="TMail%3a%3aMail-sender%3d"><code>sender=(spec)</code></a></dt>
<dd>
<p>
spec: String<br>
</p>

<p>
address spec for Sender: header field.
</p>

</dd>
<dt><a name="TMail%3a%3aMail-sender_addr"><code>sender_addr(default = nil)</code></a> -&gt; <code><a href="address.html#TMail%3a%3aAddress">TMail::Address</a></code></dt>
<dt><a name="TMail%3a%3aMail-sender_addr%3d"><code>sender_addr=(addr)</code></a></dt>
<dd>
<p>
addr: <a href="address.html#TMail%3a%3aAddress">TMail::Address</a><br>
</p>

<p>
an address which is represented in Sender: header field.
</p>

</dd>
<dt><a name="TMail%3a%3aMail-subject"><code>subject(default = nil)</code></a> -&gt; <code>String</code></dt>
<dt><a name="TMail%3a%3aMail-subject%3d"><code>subject=(sbj)</code></a></dt>
<dd>
<p>
sbj: String<br>
</p>

<p>
the subject of the message.
</p>

</dd>
<dt><a name="TMail%3a%3aMail-message_id"><code>message_id(default = nil)</code></a> -&gt; <code>String</code></dt>
<dt><a name="TMail%3a%3aMail-message_id%3d"><code>message_id=(id)</code></a></dt>
<dd>
<p>
id: String<br>
</p>

<p>
message ID string.
</p>

</dd>
<dt><a name="TMail%3a%3aMail-in_reply_to"><code>in_reply_to(default = nil)</code></a> -&gt; <code>[String]</code></dt>
<dt><a name="TMail%3a%3aMail-in_reply_to%3d"><code>in_reply_to=(ids)</code></a></dt>
<dd>
<p>
ids: String | [String]<br>
</p>

<p>
message IDs of replying mails.
</p>

</dd>
<dt><a name="TMail%3a%3aMail-references"><code>references(default = nil)</code></a> -&gt; <code>[String]</code></dt>
<dt><a name="TMail%3a%3aMail-references%3d"><code>references=(ids)</code></a></dt>
<dd>
<p>
ids: String | [String]<br>
</p>

<p>
message IDs of all referencing (replying) mails.
</p>

</dd>
<dt><a name="TMail%3a%3aMail-mime_version"><code>mime_version(default = nil)</code></a> -&gt; <code>String</code></dt>
<dt><a name="TMail%3a%3aMail-mime_version%3d"><code>mime_version=(ver)</code></a></dt>
<dd>
<p>
ver: String<br>
</p>

<p>
MIME version.
If it does not exist, returns the DEFAULT.
</p>

</dd>
<dt><a name="TMail%3a%3aMail-set_mime_version"><code>set_mime_version(major, <var>minor</var>)</code></a></dt>
<dd>
<p>
major: Integer<br>
minor: Integer<br>
</p>

<p>
set MIME version from integers.
</p>

</dd>
<dt><a name="TMail%3a%3aMail-content_type"><code>content_type(default = nil)</code></a> -&gt; <code>String</code></dt>
<dd>
<p>
the content type of the mail message (e.g. "text/plain").
If it does not exist, returns the DEFAULT.
</p>

</dd>
<dt><a name="TMail%3a%3aMail-main_type"><code>main_type(default = nil)</code></a> -&gt; <code>String</code></dt>
<dd>
<p>
the main content type of the mail message. (e.g. "text")
If it does not exist, returns the DEFAULT.
</p>

</dd>
<dt><a name="TMail%3a%3aMail-sub_type"><code>sub_type(default = nil)</code></a> -&gt; <code>String</code></dt>
<dd>
<p>
the sub content type of the mail message. (e.g. "plain")
If it does not exist, returns the DEFAULT.
</p>

</dd>
<dt><a name="TMail%3a%3aMail-content_type%3d"><code>content_type=(ctype)</code></a></dt>
<dd>
<p>
ctype: String<br>
</p>

<p>
set content type to STR.
</p>

</dd>
<dt><a name="TMail%3a%3aMail-set_content_type"><code>set_content_type(main, <var>sub</var>, <var>params</var> = nil)</code></a></dt>
<dd>
<p>
main: String<br>
sub: String<br>
params: {String => String}<br>
</p>

<p>
set Content-type: header as "main/sub; param=val; param=val; ...".
</p>

</dd>
<dt><a name="TMail%3a%3aMail-type_param"><code>type_param(name, <var>default</var> = nil)</code></a> -&gt; <code>String</code></dt>
<dd>
<p>
name: String<br>
</p>

<p>
returns the value corresponding to the case-insensitive
NAME of Content-Type parameter.
If it does not exist, returns the <var>default</var>.
</p>
<pre>
# example
mail['Content-Type'] = 'text/plain; charset=iso-2022-jp'
p mail.type_param('charset')   # "iso-2022-jp"
</pre>

</dd>
<dt><a name="TMail%3a%3aMail-multipart%3f"><code>multipart?</code></a> -&gt; <code>true | false</code></dt>
<dd>
<p>
judge if this mail is MIME multi part mail,
by inspecting Content-Type: header field.
</p>

</dd>
<dt><a name="TMail%3a%3aMail-transfer_encoding"><code>transfer_encoding(default = nil)</code></a> -&gt; <code>String</code></dt>
<dt><a name="TMail%3a%3aMail-transfer_encoding%3d"><code>transfer_encoding=(encoding)</code></a></dt>
<dd>
<p>
encoding: String<br>
</p>
<p>
Content-Transfer-Encoding. (e.g. "7bit" "Base64")
</p>

</dd>
<dt><a name="TMail%3a%3aMail-disposition"><code>disposition(default = nil)</code></a> -&gt; <code>String</code></dt>
<dt><a name="TMail%3a%3aMail-disposition%3d"><code>disposition=(pos)</code></a></dt>
<dd>
<p>
pos: String<br>
</p>

<p>
Content-Disposition main value (e.g. "attachment").
If it does not exist, returns the DEFAULT.
</p>
<pre>
# example
mail['Content-Disposition'] = 'attachement; filename="test.rb"'
p mail.disposition   # "attachment"
</pre>

</dd>
<dt><a name="TMail%3a%3aMail-set_content_disposition"><code>set_content_disposition(pos, <var>params</var> = nil)</code></a></dt>
<dd>
<p>
pos: String<br>
params: {String => String}<br>
</p>

<p>
set content disposition.
</p>

</dd>
<dt><a name="TMail%3a%3aMail-disposition_param"><code>disposition_param(key, <var>default</var> = nil)</code></a> -&gt; <code>String</code></dt>
<dd>
<p>
key: String<br>
</p>

<p>
returns a value corresponding to the Content-Disposition
parameter NAME (e.g. filename).
If it does not exist, returns the <var>default</var>.
</p>
<pre>
# example
mail.disposition_param('filename')
</pre>

</dd>
<dt><a name="TMail%3a%3aMail-destinations"><code>destinations(default = nil)</code></a> -&gt; <code>[String]</code></dt>
<dd>
<p>
all address specs which are contained in To:, Cc: and
Bcc: header fields.
</p>

</dd>
<dt><a name="TMail%3a%3aMail-reply_addresses"><code>reply_addresses(default = nil)</code></a> -&gt; <code>[<a href="address.html#TMail%3a%3aAddress">TMail::Address</a>]</code></dt>
<dd>
<p>
addresses to we reply to.
</p>

</dd>
<dt><a name="TMail%3a%3aMail-error_reply_addresses"><code>error_reply_addresses(default = nil)</code></a> -&gt; <code>[<a href="address.html#TMail%3a%3aAddress">TMail::Address</a>]</code></dt>
<dd>
<p>
addresses to use when returning error message.
</p>

</dd>
</dl>
<h3>Direct Header Handling Methods</h3>

<dl>
<dt><a name="TMail%3a%3aMail-clear"><code>clear</code></a></dt>
<dd>
<p>
clears all header.
</p>

</dd>
<dt><a name="TMail%3a%3aMail-keys"><code>keys</code></a> -&gt; <code>[TMail::HeaderField]</code></dt>
<dd>
<p>
returns an array of contained header names.
</p>

</dd>
<dt><a name="TMail%3a%3aMail-%5b%5d"><code>[](name)</code></a> -&gt; <code>TMail::HeaderField</code></dt>
<dd>
<p>
name: String<br>
</p>

<p>
returns a header field object corresponding to the case-insensitive
key NAME. e.g. mail["To"]
</p>

</dd>
<dt><a name="TMail%3a%3aMail-%5b%5d%3d"><code>[]=(name, <var>field</var>)</code></a></dt>
<dd>
<p>
name: String<br>
field: TMail::HeaderField<br>
</p>

<p>
set NAME header field to <var>field</var>.
</p>

</dd>
<dt><a name="TMail%3a%3aMail-delete"><code>delete(name)</code></a></dt>
<dd>
<p>
name: String<br>
</p>
<p>
deletes header corresponding to case-insensitive key NAME.
</p>

</dd>
<dt><a name="TMail%3a%3aMail-delete_if%20%7b%7cname%2c%20field%7c%20%2e%2e%2e%2e%20%7d"><code>delete_if {|name, <var>field</var>| .... }</code></a></dt>
<dd>
<p>
name: String<br>
field: TMail::HeaderField<br>
</p>

<p>
evaluates block with a name of header and header field object,
and delete the header if block returns true.
</p>

</dd>
<dt><a name="TMail%3a%3aMail-each_header%20%7b%7cname%2c%20field%7c%20%2e%2e%2e%2e%20%7d"><code>each_header {|name, <var>field</var>| .... }</code></a></dt>
<dt><a name="TMail%3a%3aMail-each_pair%20%7b%7cname%2c%20field%7c%20%2e%2e%2e%2e%20%7d"><code>each_pair {|name, <var>field</var>| .... }</code></a></dt>
<dd>
<p>
name: String<br>
field: TMail::HeaderField<br>
</p>

<p>
iterates for each header name and its field object.
</p>

</dd>
<dt><a name="TMail%3a%3aMail-each_header_name%20%7b%7cname%7c%20%2e%2e%2e%2e%20%7d"><code>each_header_name {|name| .... }</code></a></dt>
<dt><a name="TMail%3a%3aMail-each_key%20%7b%7cname%7c%20%2e%2e%2e%2e%20%7d"><code>each_key {|name| .... }</code></a></dt>
<dd>
<p>
name: String<br>
</p>

<p>
iterates for each contained header names.
</p>

</dd>
<dt><a name="TMail%3a%3aMail-each_field%20%7b%7cfield%7c%20%2e%2e%2e%2e%20%7d"><code>each_field {|field| .... }</code></a></dt>
<dt><a name="TMail%3a%3aMail-each_value%20%7b%7cfield%7c%20%2e%2e%2e%2e%20%7d"><code>each_value {|field| .... }</code></a></dt>
<dd>
<p>
field: TMail::HeaderField<br>
</p>

<p>
iterates for each header field objects.
</p>

</dd>
<dt><a name="TMail%3a%3aMail-orderd_each%20%7b%7cname%2c%20field%7c%20%2e%2e%2e%2e%20%7d"><code>orderd_each {|name, <var>field</var>| .... }</code></a></dt>
<dd>
<p>
name: String<br>
field: TMail::HeaderField<br>
</p>

<p>
iterates for each header field objects, in canonical order.
</p>

</dd>
<dt><a name="TMail%3a%3aMail-key%3f"><code>key?(name)</code></a></dt>
<dd>
<p>
name: String<br>
</p>

<p>
returns true if the mail has NAME header.
</p>

</dd>
<dt><a name="TMail%3a%3aMail-value%3f"><code>value?(field)</code></a></dt>
<dd>
<p>
field: TMail::HeaderField<br>
</p>

<p>
returns true if the mail has FIELD header field object.
</p>

</dd>
<dt><a name="TMail%3a%3aMail-values_at"><code>values_at(*names)</code></a> -&gt; <code>[TMail::HeaderField]</code></dt>
<dt><a name="TMail%3a%3aMail-indexes"><code>indexes(*names)</code></a> -&gt; <code>[TMail::HeaderField]</code></dt>
<dt><a name="TMail%3a%3aMail-indices"><code>indices(*names)</code></a> -&gt; <code>[TMail::HeaderField]</code></dt>
<dd>
<p>
names: [String]<br>
</p>

<p>
equals to <code>names.collect {|k| mail[k] }</code>.
</p>

</dd>
<dt><a name="TMail%3a%3aMail-values"><code>values</code></a> -&gt; <code>[TMail::HeaderField]</code></dt>
<dd>
<p>
returns an array of all header field object.
</p>
</dd>
</dl>

</body>
</html>