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
|
<!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>Address Classes</title>
</head>
<body>
<h1>Address Classes</h1>
<h2><code>class <a name="TMail%3a%3aAddress">TMail::Address</a> </code></h2>
<h3>Class Methods</h3>
<dl>
<dt><a name="TMail%3a%3aAddress-parse"><code>parse(str)</code></a> -> <code><a href="address.html#TMail%3a%3aAddress">TMail::Address</a> | <a href="address.html#TMail%3a%3aAddressGroup">TMail::AddressGroup</a></code></dt>
<dd>
<p>
str: String<br>
</p>
<p>
parses STR and creates new <code>TMail::Address</code> object.
If STR did not follow the internet address format,
<code>TMail::SyntaxError</code> exception is raised.
</p>
</dd>
<dt><a name="TMail%3a%3aAddress-new"><code>new(locals, <var>domains</var>)</code></a> -> <code><a href="address.html#TMail%3a%3aAddress">TMail::Address</a> | <a href="address.html#TMail%3a%3aAddressGroup">TMail::AddressGroup</a></code></dt>
<dd>
<p>
locals: [String]<br>
domains: [String]<br>
</p>
<p>
creates new <code>TMail::Address</code> object consist from local part
LOCALS and domain part <var>domains</var>.
</p>
</dd>
</dl>
<h3>Instance Methods</h3>
<dl>
<dt><a name="TMail%3a%3aAddress-address_group%3f"><code>address_group?</code></a> -> <code>true | false</code></dt>
<dd>
<p>
returns false.
</p>
</dd>
<dt><a name="TMail%3a%3aAddress-spec"><code>spec</code></a> -> <code>String</code></dt>
<dd>
<p>
an address spec ("....@....").
</p>
</dd>
<dt><a name="TMail%3a%3aAddress-routes"><code>routes</code></a> -> <code>[String]</code></dt>
<dd>
<p>
delivery routes. Strings do not include character "@".
</p>
</dd>
<dt><a name="TMail%3a%3aAddress-name"><code>name</code></a> -> <code>String</code></dt>
<dt><a name="TMail%3a%3aAddress-phrase"><code>phrase</code></a> -> <code>String</code></dt>
<dd>
<p>
short description for this address (e.g. real name).
</p>
</dd>
<dt><a name="TMail%3a%3aAddress-encoded"><code>encoded(eol = "\r\n", <var>encoding</var> = 'j')</code></a> -> <code>String</code></dt>
<dd>
<p>
eol: String<br>
encoding: String<br>
</p>
<p>
converts this object into MIME-encoded string.
</p>
</dd>
<dt><a name="TMail%3a%3aAddress-to_s"><code>to_s(eol = "\n", <var>encoding</var> = 'e')</code></a> -> <code>String</code></dt>
<dt><a name="TMail%3a%3aAddress-decoded"><code>decoded(eol = "\n", <var>encoding</var> = 'e')</code></a> -> <code>String</code></dt>
<dd>
<p>
eol: String<br>
encoding: String<br>
</p>
<p>
converts this object into decoded string.
</p>
</dd>
<dt><a name="TMail%3a%3aAddress-%3d%3d"><code>==(other)</code></a> -> <code>true | false</code></dt>
<dd>
<p>
other: Object<br>
</p>
<p>
judge if self equals to other by inspecting addr-spec string (#spec).
#name and #routes never affects the return value.
</p>
</dd>
</dl>
<h2><code>class <a name="TMail%3a%3aAddressGroup">TMail::AddressGroup</a> </code></h2>
<h3>Class Methods</h3>
<dl>
<dt><a name="TMail%3a%3aAddressGroup-new"><code>new(name, <var>addrs</var>)</code></a> -> <code><a href="address.html#TMail%3a%3aAddressGroup">TMail::AddressGroup</a></code></dt>
<dd>
<p>
name: String<br>
addrs: [<a href="address.html#TMail%3a%3aAddress">TMail::Address</a> | <a href="address.html#TMail%3a%3aAddressGroup">TMail::AddressGroup</a>]<br>
</p>
<p>
creates new <code>TMail::AddressGroup</code> object.
NAME is the name of this group, <var>addrs</var> is addresses
which belongs to this group.
</p>
</dd>
</dl>
<h3>Instance Methods</h3>
<dl>
<dt><a name="TMail%3a%3aAddressGroup-address_group%3f"><code>address_group?</code></a> -> <code>true | false</code></dt>
<dd>
<p>
returns true.
</p>
</dd>
<dt><a name="TMail%3a%3aAddressGroup-name"><code>name</code></a> -> <code>String</code></dt>
<dd>
<p>
the human readable name of this group.
</p>
</dd>
<dt><a name="TMail%3a%3aAddressGroup-addresses"><code>addresses</code></a> -> <code>[<a href="address.html#TMail%3a%3aAddress">TMail::Address</a> | <a href="address.html#TMail%3a%3aAddressGroup">TMail::AddressGroup</a>]</code></dt>
<dd>
<p>
addresses which belongs to this group.
</p>
</dd>
<dt><a name="TMail%3a%3aAddressGroup-to_a"><code>to_a</code></a> -> <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%3aAddressGroup-to_ary"><code>to_ary</code></a> -> <code>[<a href="address.html#TMail%3a%3aAddress">TMail::Address</a> | <a href="address.html#TMail%3a%3aAddressGroup">TMail::AddressGroup</a>]</code></dt>
<dd>
<p>
equals to <code>addresses.dup</code>.
</p>
</dd>
<dt><a name="TMail%3a%3aAddressGroup-flatten"><code>flatten</code></a> -> <code>[<a href="address.html#TMail%3a%3aAddress">TMail::Address</a>]</code></dt>
<dd>
<p>
flatten this group into one level of array of <code>TMail::Address</code>.
</p>
</dd>
<dt><a name="TMail%3a%3aAddressGroup-add"><code>add(addr)</code></a></dt>
<dt><a name="TMail%3a%3aAddressGroup-push"><code>push(addr)</code></a></dt>
<dd>
<p>
addr: <a href="address.html#TMail%3a%3aAddress">TMail::Address</a> | <a href="address.html#TMail%3a%3aAddressGroup">TMail::AddressGroup</a><br>
</p>
<p>
adds an address or an address group to this group.
</p>
</dd>
<dt><a name="TMail%3a%3aAddressGroup-delete"><code>delete(addr)</code></a></dt>
<dd>
<p>
addr: <a href="address.html#TMail%3a%3aAddress">TMail::Address</a> | <a href="address.html#TMail%3a%3aAddressGroup">TMail::AddressGroup</a><br>
</p>
<p>
removes ADDR from this group.
</p>
</dd>
<dt><a name="TMail%3a%3aAddressGroup-each%20%7b%7ca%7c%20%2e%2e%2e%2e%20%7d"><code>each {|a| .... }</code></a></dt>
<dd>
<p>
a: <a href="address.html#TMail%3a%3aAddress">TMail::Address</a> | <a href="address.html#TMail%3a%3aAddressGroup">TMail::AddressGroup</a><br>
</p>
<p>
equals to <code>addresses.each {|a| .... }</code>.
</p>
</dd>
<dt><a name="TMail%3a%3aAddressGroup-each_address%20%7b%7ca%7c%20%2e%2e%2e%2e%20%7d"><code>each_address {|a| .... }</code></a></dt>
<dd>
<p>
a: <a href="address.html#TMail%3a%3aAddress">TMail::Address</a><br>
</p>
<p>
equals to <code>flatten.each {|a| .... }</code>
</p>
</dd>
<dt><a name="TMail%3a%3aAddressGroup-encoded"><code>encoded(eol = "\r\n", <var>encoding</var> = 'j')</code></a> -> <code>String</code></dt>
<dd>
<p>
eol: String<br>
encoding: String<br>
</p>
<p>
converts this object into MIME-encoded string.
</p>
</dd>
<dt><a name="TMail%3a%3aAddressGroup-decoded"><code>decoded(eol = "\n", <var>encoding</var> = 'e')</code></a> -> <code>String</code></dt>
<dd>
<p>
eol: String<br>
encoding: String<br>
</p>
<p>
converts this object into decoded string.
</p>
</dd>
<dt><a name="TMail%3a%3aAddressGroup-%3d%3d"><code>==(other)</code></a> -> <code>true | false</code></dt>
<dt><a name="TMail%3a%3aAddressGroup-eql%3f"><code>eql?(other)</code></a> -> <code>true | false</code></dt>
<dd>
<p>
other: Object<br>
</p>
<p>
judges if self is equal to OTHER, by comparing <code>self.addresses</code> and
<code>other.addresses</code>. (<code>self.name</code> is meanless)
</p>
</dd>
</dl>
</body>
</html>
|
