vendor/tmail-1.2.3.1/site/reference/address.html

   1 <h1>Address Classes</h1>
   2
   3 <h2><code>class <a name="TMail%3a%3aAddress">TMail::Address</a> </code></h2>
   4
   5 <h3>Class Methods</h3>
   6
   7 <dl>
   8 <dt><a name="TMail%3a%3aAddress-parse"><code>parse(str)</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>
   9 <dd>
  10 <p>
  11 str: String<br>
  12 </p>
  13
  14 <p>
  15 parses the string and creates a new <code>TMail::Address</code> object.
  16 If the string does not follow the standard internet address format, a
  17 <code>TMail::SyntaxError</code> exception is raised.
  18 </p>
  19
  20 </dd>
  21 <dt><a name="TMail%3a%3aAddress-new"><code>new(locals, <var>domains</var>)</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>
  22 <dd>
  23 <p>
  24 locals: [String]<br>
  25 domains: [String]<br>
  26 </p>
  27
  28 <p>
  29 creates a new <code>TMail::Address</code> object consisting of the local part,
  30 LOCALS and domain part <var>domains</var>.
  31 </p>
  32
  33 </dd>
  34 </dl>
  35 <h3>Instance Methods</h3>
  36
  37 <dl>
  38 <dt><a name="TMail%3a%3aAddress-address_group%3f"><code>address_group?</code></a> -&gt; <code>true | false</code></dt>
  39 <dd>
  40 <p>
  41 returns false.
  42 </p>
  43
  44 </dd>
  45 <dt><a name="TMail%3a%3aAddress-spec"><code>spec</code></a> -&gt; <code>String</code></dt>
  46 <dd>
  47 <p>
  48 an address spec ("....@....").
  49 </p>
  50
  51 </dd>
  52 <dt><a name="TMail%3a%3aAddress-routes"><code>routes</code></a> -&gt; <code>[String]</code></dt>
  53 <dd>
  54 <p>
  55 delivery routes. Strings do not include character "@".
  56 </p>
  57
  58 </dd>
  59 <dt><a name="TMail%3a%3aAddress-name"><code>name</code></a> -&gt; <code>String</code></dt>
  60 <dt><a name="TMail%3a%3aAddress-phrase"><code>phrase</code></a> -&gt; <code>String</code></dt>
  61 <dd>
  62 <p>
  63 short description for this address (e.g. real name).
  64 </p>
  65
  66 </dd>
  67 <dt><a name="TMail%3a%3aAddress-encoded"><code>encoded(eol = "\r\n", <var>encoding</var> = 'j')</code></a> -&gt; <code>String</code></dt>
  68 <dd>
  69 <p>
  70 eol: String<br>
  71 encoding: String<br>
  72 </p>
  73
  74 <p>
  75 converts this object into MIME-encoded string.
  76 </p>
  77
  78 </dd>
  79 <dt><a name="TMail%3a%3aAddress-to_s"><code>to_s(eol = "\n", <var>encoding</var> = 'e')</code></a> -&gt; <code>String</code></dt>
  80 <dt><a name="TMail%3a%3aAddress-decoded"><code>decoded(eol = "\n", <var>encoding</var> = 'e')</code></a> -&gt; <code>String</code></dt>
  81 <dd>
  82 <p>
  83 eol: String<br>
  84 encoding: String<br>
  85 </p>
  86
  87 <p>
  88 converts this object into decoded string.
  89 </p>
  90
  91 </dd>
  92 <dt><a name="TMail%3a%3aAddress-%3d%3d"><code>==(other)</code></a> -&gt; <code>true | false</code></dt>
  93 <dd>
  94 <p>
  95 other: Object<br>
  96 </p>
  97
  98 <p>
  99 judge if self equals to other by inspecting addr-spec string (#spec).
 100 #name and #routes never affects the return value.
 101 </p>
 102
 103
 104 </dd>
 105 </dl>
 106 <h2><code>class <a name="TMail%3a%3aAddressGroup">TMail::AddressGroup</a> </code></h2>
 107
 108 <h3>Class Methods</h3>
 109
 110 <dl>
 111 <dt><a name="TMail%3a%3aAddressGroup-new"><code>new(name, <var>addrs</var>)</code></a> -&gt; <code><a href="address.html#TMail%3a%3aAddressGroup">TMail::AddressGroup</a></code></dt>
 112 <dd>
 113 <p>
 114 name: String<br>
 115 addrs: [<a href="address.html#TMail%3a%3aAddress">TMail::Address</a> | <a href="address.html#TMail%3a%3aAddressGroup">TMail::AddressGroup</a>]<br>
 116 </p>
 117
 118 <p>
 119 creates new <code>TMail::AddressGroup</code> object.
 120 NAME is the name of this group, <var>addrs</var> is addresses
 121 which belongs to this group.
 122 </p>
 123
 124 </dd>
 125 </dl>
 126 <h3>Instance Methods</h3>
 127
 128 <dl>
 129 <dt><a name="TMail%3a%3aAddressGroup-address_group%3f"><code>address_group?</code></a> -&gt; <code>true | false</code></dt>
 130 <dd>
 131 <p>
 132 returns true.
 133 </p>
 134
 135 </dd>
 136 <dt><a name="TMail%3a%3aAddressGroup-name"><code>name</code></a> -&gt; <code>String</code></dt>
 137 <dd>
 138 <p>
 139 the human readable name of this group.
 140 </p>
 141
 142 </dd>
 143 <dt><a name="TMail%3a%3aAddressGroup-addresses"><code>addresses</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>
 144 <dd>
 145 <p>
 146 addresses which belongs to this group.
 147 </p>
 148
 149 </dd>
 150 <dt><a name="TMail%3a%3aAddressGroup-to_a"><code>to_a</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>
 151 <dt><a name="TMail%3a%3aAddressGroup-to_ary"><code>to_ary</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>
 152 <dd>
 153 <p>
 154 equals to <code>addresses.dup</code>.
 155 </p>
 156
 157 </dd>
 158 <dt><a name="TMail%3a%3aAddressGroup-flatten"><code>flatten</code></a> -&gt; <code>[<a href="address.html#TMail%3a%3aAddress">TMail::Address</a>]</code></dt>
 159 <dd>
 160 <p>
 161 flatten this group into one level of array of <code>TMail::Address</code>.
 162 </p>
 163
 164 </dd>
 165 <dt><a name="TMail%3a%3aAddressGroup-add"><code>add(addr)</code></a></dt>
 166 <dt><a name="TMail%3a%3aAddressGroup-push"><code>push(addr)</code></a></dt>
 167 <dd>
 168 <p>
 169 addr: <a href="address.html#TMail%3a%3aAddress">TMail::Address</a> | <a href="address.html#TMail%3a%3aAddressGroup">TMail::AddressGroup</a><br>
 170 </p>
 171
 172 <p>
 173 adds an address or an address group to this group.
 174 </p>
 175
 176 </dd>
 177 <dt><a name="TMail%3a%3aAddressGroup-delete"><code>delete(addr)</code></a></dt>
 178 <dd>
 179 <p>
 180 addr: <a href="address.html#TMail%3a%3aAddress">TMail::Address</a> | <a href="address.html#TMail%3a%3aAddressGroup">TMail::AddressGroup</a><br>
 181 </p>
 182
 183 <p>
 184 removes ADDR from this group.
 185 </p>
 186
 187 </dd>
 188 <dt><a name="TMail%3a%3aAddressGroup-each%20%7b%7ca%7c%20%2e%2e%2e%2e%20%7d"><code>each {|a| .... }</code></a></dt>
 189 <dd>
 190 <p>
 191 a: <a href="address.html#TMail%3a%3aAddress">TMail::Address</a> | <a href="address.html#TMail%3a%3aAddressGroup">TMail::AddressGroup</a><br>
 192 </p>
 193
 194 <p>
 195 equals to <code>addresses.each {|a| .... }</code>.
 196 </p>
 197
 198 </dd>
 199 <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>
 200 <dd>
 201 <p>
 202 a: <a href="address.html#TMail%3a%3aAddress">TMail::Address</a><br>
 203 </p>
 204
 205 <p>
 206 equals to <code>flatten.each {|a| .... }</code>
 207 </p>
 208
 209 </dd>
 210 <dt><a name="TMail%3a%3aAddressGroup-encoded"><code>encoded(eol = "\r\n", <var>encoding</var> = 'j')</code></a> -&gt; <code>String</code></dt>
 211 <dd>
 212 <p>
 213 eol: String<br>
 214 encoding: String<br>
 215 </p>
 216
 217 <p>
 218 converts this object into MIME-encoded string.
 219 </p>
 220
 221 </dd>
 222 <dt><a name="TMail%3a%3aAddressGroup-decoded"><code>decoded(eol = "\n", <var>encoding</var> = 'e')</code></a> -&gt; <code>String</code></dt>
 223 <dd>
 224 <p>
 225 eol: String<br>
 226 encoding: String<br>
 227 </p>
 228
 229 <p>
 230 converts this object into decoded string.
 231 </p>
 232
 233 </dd>
 234 <dt><a name="TMail%3a%3aAddressGroup-%3d%3d"><code>==(other)</code></a> -&gt; <code>true | false</code></dt>
 235 <dt><a name="TMail%3a%3aAddressGroup-eql%3f"><code>eql?(other)</code></a> -&gt; <code>true | false</code></dt>
 236 <dd>
 237 <p>
 238 other: Object<br>
 239 </p>
 240
 241 <p>
 242 judges if self is equal to OTHER, by comparing <code>self.addresses</code> and
 243 <code>other.addresses</code>. (<code>self.name</code> is meanless)
 244 </p>
 245 </dd>
 246 </dl>
 247