Path: | doc.en/address.html |
Last Update: | Fri Feb 20 01:45:52 CET 2004 |
<!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>class <a name="TMail%3a%3aAddress">TMail::Address</a> </h2>
<h3>Class Methods</h3>
<dl> <dt><a name="TMail%3a%3aAddress-parse">parse(str)</a> -> <a href="address.html#TMail%3a%3aAddress">TMail::Address</a> | <a href="address.html#TMail%3a%3aAddressGroup">TMail::AddressGroup</a></dt> <dd> <p> str: String<br> </p>
<p> parses STR and creates new TMail::Address object. If STR did not follow the internet address format, TMail::SyntaxError exception is raised. </p>
</dd> <dt><a name="TMail%3a%3aAddress-new">new(locals, <var>domains</var>)</a> -> <a href="address.html#TMail%3a%3aAddress">TMail::Address</a> | <a href="address.html#TMail%3a%3aAddressGroup">TMail::AddressGroup</a></dt> <dd> <p> locals: [String]<br> domains: [String]<br> </p>
<p> creates new TMail::Address 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">address_group?</a> -> true | false</dt> <dd> <p> returns false. </p>
</dd> <dt><a name="TMail%3a%3aAddress-spec">spec</a> -> String</dt> <dd> <p> an address spec (".…@.…"). </p>
</dd> <dt><a name="TMail%3a%3aAddress-routes">routes</a> -> [String]</dt> <dd> <p> delivery routes. Strings do not include character "@". </p>
</dd> <dt><a name="TMail%3a%3aAddress-name">name</a> -> String</dt> <dt><a name="TMail%3a%3aAddress-phrase">phrase</a> -> String</dt> <dd> <p> short description for this address (e.g. real name). </p>
</dd> <dt><a name="TMail%3a%3aAddress-encoded">encoded(eol = "\r\n", <var>encoding</var> = ‘j’)</a> -> String</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">to_s(eol = "\n", <var>encoding</var> = ‘e’)</a> -> String</dt> <dt><a name="TMail%3a%3aAddress-decoded">decoded(eol = "\n", <var>encoding</var> = ‘e’)</a> -> String</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">==(other)</a> -> true | false</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>class <a name="TMail%3a%3aAddressGroup">TMail::AddressGroup</a> </h2>
<h3>Class Methods</h3>
<dl> <dt><a name="TMail%3a%3aAddressGroup-new">new(name, <var>addrs</var>)</a> -> <a href="address.html#TMail%3a%3aAddressGroup">TMail::AddressGroup</a></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 TMail::AddressGroup 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">address_group?</a> -> true | false</dt> <dd> <p> returns true. </p>
</dd> <dt><a name="TMail%3a%3aAddressGroup-name">name</a> -> String</dt> <dd> <p> the human readable name of this group. </p>
</dd> <dt><a name="TMail%3a%3aAddressGroup-addresses">addresses</a> -> [<a href="address.html#TMail%3a%3aAddress">TMail::Address</a> | <a href="address.html#TMail%3a%3aAddressGroup">TMail::AddressGroup</a>]</dt> <dd> <p> addresses which belongs to this group. </p>
</dd> <dt><a name="TMail%3a%3aAddressGroup-to_a">to_a</a> -> [<a href="address.html#TMail%3a%3aAddress">TMail::Address</a> | <a href="address.html#TMail%3a%3aAddressGroup">TMail::AddressGroup</a>]</dt> <dt><a name="TMail%3a%3aAddressGroup-to_ary">to_ary</a> -> [<a href="address.html#TMail%3a%3aAddress">TMail::Address</a> | <a href="address.html#TMail%3a%3aAddressGroup">TMail::AddressGroup</a>]</dt> <dd> <p> equals to addresses.dup. </p>
</dd> <dt><a name="TMail%3a%3aAddressGroup-flatten">flatten</a> -> [<a href="address.html#TMail%3a%3aAddress">TMail::Address</a>]</dt> <dd> <p> flatten this group into one level of array of TMail::Address. </p>
</dd> <dt><a name="TMail%3a%3aAddressGroup-add">add(addr)</a></dt> <dt><a name="TMail%3a%3aAddressGroup-push">push(addr)</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">delete(addr)</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">each {|a| .… }</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 addresses.each {|a| .… }. </p>
</dd> <dt><a name="TMail%3a%3aAddressGroup-each_address%20%7b%7ca%7c%20%2e%2e%2e%2e%20%7d">each_address {|a| .… }</a></dt> <dd> <p> a: <a href="address.html#TMail%3a%3aAddress">TMail::Address</a><br> </p>
<p> equals to flatten.each {|a| .… } </p>
</dd> <dt><a name="TMail%3a%3aAddressGroup-encoded">encoded(eol = "\r\n", <var>encoding</var> = ‘j’)</a> -> String</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">decoded(eol = "\n", <var>encoding</var> = ‘e’)</a> -> String</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">==(other)</a> -> true | false</dt> <dt><a name="TMail%3a%3aAddressGroup-eql%3f">eql?(other)</a> -> true | false</dt> <dd> <p> other: Object<br> </p>
<p> judges if self is equal to OTHER, by comparing self.addresses and other.addresses. (self.name is meanless) </p> </dd> </dl>
</body> </html>