You are viewing a plain text version of this content. The canonical link for it is here.
Posted to site-dev@james.apache.org by rd...@apache.org on 2008/08/21 22:15:13 UTC
svn commit: r687845 [10/11] - in /james/site/trunk/www/mailet/api: ./
apidocs/ apidocs/org/ apidocs/org/apache/ apidocs/org/apache/mailet/
apidocs/org/apache/mailet/class-use/ apidocs/resources/ css/ images/
stylesheets/ testapidocs/ testapidocs/org/ t...
Added: james/site/trunk/www/mailet/api/xref/org/apache/mailet/MailAddress.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/mailet/api/xref/org/apache/mailet/MailAddress.html?rev=687845&view=auto
==============================================================================
--- james/site/trunk/www/mailet/api/xref/org/apache/mailet/MailAddress.html (added)
+++ james/site/trunk/www/mailet/api/xref/org/apache/mailet/MailAddress.html Thu Aug 21 13:15:10 2008
@@ -0,0 +1,519 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
+<title>MailAddress xref</title>
+<link type="text/css" rel="stylesheet" href="../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../apidocs/org/apache/mailet/MailAddress.html">View Javadoc</a></div><pre>
+
+<a name="1" href="#1">1</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment">**************************************************************</em>
+<a name="2" href="#2">2</a> <em class="jxr_javadoccomment"> * Licensed to the Apache Software Foundation (ASF) under one *</em>
+<a name="3" href="#3">3</a> <em class="jxr_javadoccomment"> * or more contributor license agreements. See the NOTICE file *</em>
+<a name="4" href="#4">4</a> <em class="jxr_javadoccomment"> * distributed with this work for additional information *</em>
+<a name="5" href="#5">5</a> <em class="jxr_javadoccomment"> * regarding copyright ownership. The ASF licenses this file *</em>
+<a name="6" href="#6">6</a> <em class="jxr_javadoccomment"> * to you under the Apache License, Version 2.0 (the *</em>
+<a name="7" href="#7">7</a> <em class="jxr_javadoccomment"> * "License"); you may not use this file except in compliance *</em>
+<a name="8" href="#8">8</a> <em class="jxr_javadoccomment"> * with the License. You may obtain a copy of the License at *</em>
+<a name="9" href="#9">9</a> <em class="jxr_javadoccomment"> * *</em>
+<a name="10" href="#10">10</a> <em class="jxr_javadoccomment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a> *</em>
+<a name="11" href="#11">11</a> <em class="jxr_javadoccomment"> * *</em>
+<a name="12" href="#12">12</a> <em class="jxr_javadoccomment"> * Unless required by applicable law or agreed to in writing, *</em>
+<a name="13" href="#13">13</a> <em class="jxr_javadoccomment"> * software distributed under the License is distributed on an *</em>
+<a name="14" href="#14">14</a> <em class="jxr_javadoccomment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY *</em>
+<a name="15" href="#15">15</a> <em class="jxr_javadoccomment"> * KIND, either express or implied. See the License for the *</em>
+<a name="16" href="#16">16</a> <em class="jxr_javadoccomment"> * specific language governing permissions and limitations *</em>
+<a name="17" href="#17">17</a> <em class="jxr_javadoccomment"> * under the License. *</em>
+<a name="18" href="#18">18</a> <em class="jxr_javadoccomment"> ****************************************************************/</em>
+<a name="19" href="#19">19</a>
+<a name="20" href="#20">20</a>
+<a name="21" href="#21">21</a> <strong class="jxr_keyword">package</strong> org.apache.mailet;
+<a name="22" href="#22">22</a>
+<a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> java.util.Locale;
+<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> javax.mail.internet.AddressException;
+<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> javax.mail.internet.InternetAddress;
+<a name="26" href="#26">26</a>
+<a name="27" href="#27">27</a> <em class="jxr_javadoccomment">/**</em>
+<a name="28" href="#28">28</a> <em class="jxr_javadoccomment"> * A representation of an email address.</em>
+<a name="29" href="#29">29</a> <em class="jxr_javadoccomment"> * <p>This class encapsulates functionalities to access to different</em>
+<a name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * parts of an email address without dealing with its parsing.</p></em>
+<a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> *</em>
+<a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * <p>A MailAddress is an address specified in the MAIL FROM and</em>
+<a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * RCPT TO commands in SMTP sessions. These are either passed by</em>
+<a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * an external server to the mailet-compliant SMTP server, or they</em>
+<a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * are created programmatically by the mailet-compliant server to</em>
+<a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * send to another (external) SMTP server. Mailets and matchers</em>
+<a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * use the MailAddress for the purpose of evaluating the sender</em>
+<a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * and recipient(s) of a message.</p></em>
+<a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> *</em>
+<a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * <p>MailAddress parses an email address as defined in RFC 821</em>
+<a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * (SMTP) p. 30 and 31 where addresses are defined in BNF convention.</em>
+<a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * As the mailet API does not support the aged "SMTP-relayed mail"</em>
+<a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * addressing protocol, this leaves all addresses to be a <mailbox>,</em>
+<a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * as per the spec. </em>
+<a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> *</em>
+<a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * <p>This class is a good way to validate email addresses as there are</em>
+<a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * some valid addresses which would fail with a simpler approach</em>
+<a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * to parsing address. It also removes parsing burden from</em>
+<a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * mailets and matchers that might not realize the flexibility of an</em>
+<a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * SMTP address. For instance, "serge@home"@lokitech.com is a valid</em>
+<a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * SMTP address (the quoted text serge@home is the local-part and</em>
+<a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * lokitech.com is the domain). This means all current parsing to date</em>
+<a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * is incorrect as we just find the first @ and use that to separate</em>
+<a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * local-part from domain.</p></em>
+<a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> *</em>
+<a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * <p>This parses an address as per the BNF specification for <mailbox></em>
+<a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * from RFC 821 on page 30 and 31, section 4.1.2. COMMAND SYNTAX.</em>
+<a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * <a href="http://www.freesoft.org/CIE/RFC/821/15.htm</p>" target="alexandria_uri">http://www.freesoft.org/CIE/RFC/821/15.htm</p></a></em>
+<a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> *</em>
+<a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * @version 1.0</em>
+<a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> */</em>
+<a name="62" href="#62">62</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../org/apache/mailet/MailAddress.html">MailAddress</a> implements java.io.Serializable {
+<a name="63" href="#63">63</a> <em class="jxr_javadoccomment">/**</em>
+<a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * We hardcode the serialVersionUID </em>
+<a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * This version (2779163542539434916L) retains compatibility back to Mailet version 1.2 (James 1.2) so that MailAddress will be deserializable and mail doesn't get lost after an upgrade.</em>
+<a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> */</em>
+<a name="67" href="#67">67</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> serialVersionUID = 2779163542539434916L;
+<a name="68" href="#68">68</a>
+<a name="69" href="#69">69</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">char</strong>[] SPECIAL =
+<a name="70" href="#70">70</a> {'<', '>', '(', ')', '[', ']', '\\', '.', ',', ';', ':', '@', '\"'};
+<a name="71" href="#71">71</a>
+<a name="72" href="#72">72</a> <strong class="jxr_keyword">private</strong> String localPart = <strong class="jxr_keyword">null</strong>;
+<a name="73" href="#73">73</a> <strong class="jxr_keyword">private</strong> String domain = <strong class="jxr_keyword">null</strong>;
+<a name="74" href="#74">74</a> <em class="jxr_comment">//Used for parsing</em>
+<a name="75" href="#75">75</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> pos = 0;
+<a name="76" href="#76">76</a>
+<a name="77" href="#77">77</a> <em class="jxr_javadoccomment">/**</em>
+<a name="78" href="#78">78</a> <em class="jxr_javadoccomment"> * strip source routing, according to RFC-2821 it is an allowed approach to handle mails</em>
+<a name="79" href="#79">79</a> <em class="jxr_javadoccomment"> * contaning RFC-821 source-route information</em>
+<a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> */</em>
+<a name="81" href="#81">81</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> stripSourceRoute(String address) {
+<a name="82" href="#82">82</a> <strong class="jxr_keyword">if</strong> (pos < address.length()) {
+<a name="83" href="#83">83</a> <strong class="jxr_keyword">if</strong>(address.charAt(pos)=='@') {
+<a name="84" href="#84">84</a> <strong class="jxr_keyword">int</strong> i = address.indexOf(':');
+<a name="85" href="#85">85</a> <strong class="jxr_keyword">if</strong>(i != -1) {
+<a name="86" href="#86">86</a> pos = i+1;
+<a name="87" href="#87">87</a> }
+<a name="88" href="#88">88</a> }
+<a name="89" href="#89">89</a> }
+<a name="90" href="#90">90</a> }
+<a name="91" href="#91">91</a>
+<a name="92" href="#92">92</a> <em class="jxr_javadoccomment">/**</em>
+<a name="93" href="#93">93</a> <em class="jxr_javadoccomment"> * <p>Construct a MailAddress parsing the provided <code>String</code> object.</p></em>
+<a name="94" href="#94">94</a> <em class="jxr_javadoccomment"> *</em>
+<a name="95" href="#95">95</a> <em class="jxr_javadoccomment"> * <p>The <code>personal</code> variable is left empty.</p></em>
+<a name="96" href="#96">96</a> <em class="jxr_javadoccomment"> *</em>
+<a name="97" href="#97">97</a> <em class="jxr_javadoccomment"> * @param address the email address compliant to the RFC2822 3.4.1. Addr-spec specification</em>
+<a name="98" href="#98">98</a> <em class="jxr_javadoccomment"> * @throws AddressException if the parse failed</em>
+<a name="99" href="#99">99</a> <em class="jxr_javadoccomment"> */</em>
+<a name="100" href="#100">100</a> <strong class="jxr_keyword">public</strong> <a href="../../../org/apache/mailet/MailAddress.html">MailAddress</a>(String address) <strong class="jxr_keyword">throws</strong> AddressException {
+<a name="101" href="#101">101</a> address = address.trim();
+<a name="102" href="#102">102</a>
+<a name="103" href="#103">103</a> <em class="jxr_comment">// Test if mail address has source routing information (RFC-821) and get rid of it!!</em>
+<a name="104" href="#104">104</a> <em class="jxr_comment">//must be called first!! (or at least prior to updating pos)</em>
+<a name="105" href="#105">105</a> stripSourceRoute(address);
+<a name="106" href="#106">106</a>
+<a name="107" href="#107">107</a> StringBuffer localPartSB = <strong class="jxr_keyword">new</strong> StringBuffer();
+<a name="108" href="#108">108</a> StringBuffer domainSB = <strong class="jxr_keyword">new</strong> StringBuffer();
+<a name="109" href="#109">109</a> <em class="jxr_comment">//Begin parsing</em>
+<a name="110" href="#110">110</a> <em class="jxr_comment">//<mailbox> ::= <local-part> "@" <domain></em>
+<a name="111" href="#111">111</a>
+<a name="112" href="#112">112</a> <strong class="jxr_keyword">try</strong> {
+<a name="113" href="#113">113</a> <em class="jxr_comment">//parse local-part</em>
+<a name="114" href="#114">114</a> <em class="jxr_comment">//<local-part> ::= <dot-string> | <quoted-string></em>
+<a name="115" href="#115">115</a> <strong class="jxr_keyword">if</strong> (address.charAt(pos) == '\"') {
+<a name="116" href="#116">116</a> localPartSB.append(parseQuotedLocalPart(address));
+<a name="117" href="#117">117</a> <strong class="jxr_keyword">if</strong> (localPartSB.toString().length() == 2) {
+<a name="118" href="#118">118</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> AddressException(<span class="jxr_string">"No quoted local-part (user account) found at position "</span> + (pos + 2) + <span class="jxr_string">" in '"</span> + address + <span class="jxr_string">"'"</span>,address,pos+2);
+<a name="119" href="#119">119</a> }
+<a name="120" href="#120">120</a> } <strong class="jxr_keyword">else</strong> {
+<a name="121" href="#121">121</a> localPartSB.append(parseUnquotedLocalPart(address));
+<a name="122" href="#122">122</a> <strong class="jxr_keyword">if</strong> (localPartSB.toString().length() == 0) {
+<a name="123" href="#123">123</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> AddressException(<span class="jxr_string">"No local-part (user account) found at position "</span> + (pos + 1) + <span class="jxr_string">" in '"</span> + address + <span class="jxr_string">"'"</span>,address,pos+1);
+<a name="124" href="#124">124</a> }
+<a name="125" href="#125">125</a> }
+<a name="126" href="#126">126</a>
+<a name="127" href="#127">127</a> <em class="jxr_comment">//find @</em>
+<a name="128" href="#128">128</a> <strong class="jxr_keyword">if</strong> (pos >= address.length() || address.charAt(pos) != '@') {
+<a name="129" href="#129">129</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> AddressException(<span class="jxr_string">"Did not find @ between local-part and domain at position "</span> + (pos + 1) + <span class="jxr_string">" in '"</span> + address + <span class="jxr_string">"'"</span>,address,pos+1);
+<a name="130" href="#130">130</a> }
+<a name="131" href="#131">131</a> pos++;
+<a name="132" href="#132">132</a>
+<a name="133" href="#133">133</a> <em class="jxr_comment">//parse domain</em>
+<a name="134" href="#134">134</a> <em class="jxr_comment">//<domain> ::= <element> | <element> "." <domain></em>
+<a name="135" href="#135">135</a> <em class="jxr_comment">//<element> ::= <name> | "#" <number> | "[" <dotnum> "]"</em>
+<a name="136" href="#136">136</a> <strong class="jxr_keyword">while</strong> (<strong class="jxr_keyword">true</strong>) {
+<a name="137" href="#137">137</a> <strong class="jxr_keyword">if</strong> (address.charAt(pos) == '#') {
+<a name="138" href="#138">138</a> domainSB.append(parseNumber(address));
+<a name="139" href="#139">139</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (address.charAt(pos) == '[') {
+<a name="140" href="#140">140</a> domainSB.append(parseDomainLiteral(address));
+<a name="141" href="#141">141</a> } <strong class="jxr_keyword">else</strong> {
+<a name="142" href="#142">142</a> domainSB.append(parseDomain(address));
+<a name="143" href="#143">143</a> }
+<a name="144" href="#144">144</a> <strong class="jxr_keyword">if</strong> (pos >= address.length()) {
+<a name="145" href="#145">145</a> <strong class="jxr_keyword">break</strong>;
+<a name="146" href="#146">146</a> }
+<a name="147" href="#147">147</a> <strong class="jxr_keyword">if</strong> (address.charAt(pos) == '.') {
+<a name="148" href="#148">148</a> domainSB.append('.');
+<a name="149" href="#149">149</a> pos++;
+<a name="150" href="#150">150</a> <strong class="jxr_keyword">continue</strong>;
+<a name="151" href="#151">151</a> }
+<a name="152" href="#152">152</a> <strong class="jxr_keyword">break</strong>;
+<a name="153" href="#153">153</a> }
+<a name="154" href="#154">154</a>
+<a name="155" href="#155">155</a> <strong class="jxr_keyword">if</strong> (domainSB.toString().length() == 0) {
+<a name="156" href="#156">156</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> AddressException(<span class="jxr_string">"No domain found at position "</span> + (pos + 1) + <span class="jxr_string">" in '"</span> + address + <span class="jxr_string">"'"</span>,address,pos+1);
+<a name="157" href="#157">157</a> }
+<a name="158" href="#158">158</a> } <strong class="jxr_keyword">catch</strong> (IndexOutOfBoundsException ioobe) {
+<a name="159" href="#159">159</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> AddressException(<span class="jxr_string">"Out of data at position "</span> + (pos + 1) + <span class="jxr_string">" in '"</span> + address + <span class="jxr_string">"'"</span>,address,pos+1);
+<a name="160" href="#160">160</a> }
+<a name="161" href="#161">161</a>
+<a name="162" href="#162">162</a> localPart = localPartSB.toString();
+<a name="163" href="#163">163</a> domain = domainSB.toString();
+<a name="164" href="#164">164</a> }
+<a name="165" href="#165">165</a>
+<a name="166" href="#166">166</a> <em class="jxr_javadoccomment">/**</em>
+<a name="167" href="#167">167</a> <em class="jxr_javadoccomment"> * Construct a MailAddress with the provided personal name and email</em>
+<a name="168" href="#168">168</a> <em class="jxr_javadoccomment"> * address.</em>
+<a name="169" href="#169">169</a> <em class="jxr_javadoccomment"> *</em>
+<a name="170" href="#170">170</a> <em class="jxr_javadoccomment"> * @param localPart The local-part portion is a domain dependent string. In addresses, it is simply interpreted on the particular host as a name of a particular mailbox. per RFC2822 3.4.1. Addr-spec specification</em>
+<a name="171" href="#171">171</a> <em class="jxr_javadoccomment"> * @param domain The domain portion identifies the point to which the mail is delivered per RFC2822 3.4.1. Addr-spec specification</em>
+<a name="172" href="#172">172</a> <em class="jxr_javadoccomment"> * @throws AddressException if the parse failed</em>
+<a name="173" href="#173">173</a> <em class="jxr_javadoccomment"> */</em>
+<a name="174" href="#174">174</a> <strong class="jxr_keyword">public</strong> <a href="../../../org/apache/mailet/MailAddress.html">MailAddress</a>(String localPart, String domain) <strong class="jxr_keyword">throws</strong> AddressException {
+<a name="175" href="#175">175</a> <strong class="jxr_keyword">this</strong>(<strong class="jxr_keyword">new</strong> InternetAddress(localPart+<span class="jxr_string">"@"</span>+domain));
+<a name="176" href="#176">176</a> }
+<a name="177" href="#177">177</a>
+<a name="178" href="#178">178</a> <em class="jxr_javadoccomment">/**</em>
+<a name="179" href="#179">179</a> <em class="jxr_javadoccomment"> * Constructs a MailAddress from a JavaMail InternetAddress, using only the</em>
+<a name="180" href="#180">180</a> <em class="jxr_javadoccomment"> * email address portion, discarding the personal name. (an "addr-spec" not a "name-addr" as defined in RFC2822 3.4. Address Specification</em>
+<a name="181" href="#181">181</a> <em class="jxr_javadoccomment"> * @param address </em>
+<a name="182" href="#182">182</a> <em class="jxr_javadoccomment"> * @throws AddressException </em>
+<a name="183" href="#183">183</a> <em class="jxr_javadoccomment"> */</em>
+<a name="184" href="#184">184</a> <strong class="jxr_keyword">public</strong> <a href="../../../org/apache/mailet/MailAddress.html">MailAddress</a>(InternetAddress address) <strong class="jxr_keyword">throws</strong> AddressException {
+<a name="185" href="#185">185</a> <strong class="jxr_keyword">this</strong>(address.getAddress());
+<a name="186" href="#186">186</a> }
+<a name="187" href="#187">187</a>
+<a name="188" href="#188">188</a> <em class="jxr_javadoccomment">/**</em>
+<a name="189" href="#189">189</a> <em class="jxr_javadoccomment"> * Return the host part.</em>
+<a name="190" href="#190">190</a> <em class="jxr_javadoccomment"> *</em>
+<a name="191" href="#191">191</a> <em class="jxr_javadoccomment"> * @return a <code>String</code> object representing the host part</em>
+<a name="192" href="#192">192</a> <em class="jxr_javadoccomment"> * of this email address. If the host is of the dotNum form</em>
+<a name="193" href="#193">193</a> <em class="jxr_javadoccomment"> * (e.g. [yyy.yyy.yyy.yyy]) then strip the braces first.</em>
+<a name="194" href="#194">194</a> <em class="jxr_javadoccomment"> * @deprecated use getDomain() - name change to align with RFC2822 3.4.1. Addr-spec specification</em>
+<a name="195" href="#195">195</a> <em class="jxr_javadoccomment"> */</em>
+<a name="196" href="#196">196</a> <strong class="jxr_keyword">public</strong> String getHost() {
+<a name="197" href="#197">197</a> <strong class="jxr_keyword">return</strong> getDomain();
+<a name="198" href="#198">198</a> }
+<a name="199" href="#199">199</a>
+<a name="200" href="#200">200</a> <em class="jxr_javadoccomment">/**</em>
+<a name="201" href="#201">201</a> <em class="jxr_javadoccomment"> * Return the domain part per RFC2822 3.4.1. Addr-spec specification</em>
+<a name="202" href="#202">202</a> <em class="jxr_javadoccomment"> *</em>
+<a name="203" href="#203">203</a> <em class="jxr_javadoccomment"> * @return a <code>String</code> object representing the domain part</em>
+<a name="204" href="#204">204</a> <em class="jxr_javadoccomment"> * of this email address. If the domain is of the domain-literal form (e.g. [yyy.yyy.yyy.yyy]) the braces will have been stripped returning the raw IP address.</em>
+<a name="205" href="#205">205</a> <em class="jxr_javadoccomment"> */</em>
+<a name="206" href="#206">206</a> <strong class="jxr_keyword">public</strong> String getDomain() {
+<a name="207" href="#207">207</a> <strong class="jxr_keyword">if</strong> (!(domain.startsWith(<span class="jxr_string">"["</span>) && domain.endsWith(<span class="jxr_string">"]"</span>))) {
+<a name="208" href="#208">208</a> <strong class="jxr_keyword">return</strong> domain;
+<a name="209" href="#209">209</a> }
+<a name="210" href="#210">210</a> <strong class="jxr_keyword">return</strong> domain.substring(1, domain.length() -1);
+<a name="211" href="#211">211</a>
+<a name="212" href="#212">212</a> }
+<a name="213" href="#213">213</a>
+<a name="214" href="#214">214</a> <em class="jxr_javadoccomment">/**</em>
+<a name="215" href="#215">215</a> <em class="jxr_javadoccomment"> * Return the user part.</em>
+<a name="216" href="#216">216</a> <em class="jxr_javadoccomment"> *</em>
+<a name="217" href="#217">217</a> <em class="jxr_javadoccomment"> * @return a <code>String</code> object representing the user part</em>
+<a name="218" href="#218">218</a> <em class="jxr_javadoccomment"> * of this email address.</em>
+<a name="219" href="#219">219</a> <em class="jxr_javadoccomment"> * @throws AddressException if the parse failed</em>
+<a name="220" href="#220">220</a> <em class="jxr_javadoccomment"> * @deprecated use getLocalPart() - name change to align with RFC2822 3.4.1. Addr-spec specification</em>
+<a name="221" href="#221">221</a> <em class="jxr_javadoccomment"> */</em>
+<a name="222" href="#222">222</a> <strong class="jxr_keyword">public</strong> String getUser() {
+<a name="223" href="#223">223</a> <strong class="jxr_keyword">return</strong> getLocalPart();
+<a name="224" href="#224">224</a> }
+<a name="225" href="#225">225</a>
+<a name="226" href="#226">226</a> <em class="jxr_javadoccomment">/**</em>
+<a name="227" href="#227">227</a> <em class="jxr_javadoccomment"> * Return the local-part per RFC2822 3.4.1. Addr-spec specification</em>
+<a name="228" href="#228">228</a> <em class="jxr_javadoccomment"> *</em>
+<a name="229" href="#229">229</a> <em class="jxr_javadoccomment"> * @return a <code>String</code> object representing the local-part</em>
+<a name="230" href="#230">230</a> <em class="jxr_javadoccomment"> * of this email address as defined by RFC2822 3.4.1. Addr-spec specification. </em>
+<a name="231" href="#231">231</a> <em class="jxr_javadoccomment"> * The local-part portion is a domain dependent string. In addresses, it is simply interpreted on the particular host as a name of a particular mailbox.</em>
+<a name="232" href="#232">232</a> <em class="jxr_javadoccomment"> * It is the part before the "@"</em>
+<a name="233" href="#233">233</a> <em class="jxr_javadoccomment"> * @throws AddressException if the parse failed</em>
+<a name="234" href="#234">234</a> <em class="jxr_javadoccomment"> */</em>
+<a name="235" href="#235">235</a> <strong class="jxr_keyword">public</strong> String getLocalPart() {
+<a name="236" href="#236">236</a> <strong class="jxr_keyword">return</strong> localPart;
+<a name="237" href="#237">237</a> }
+<a name="238" href="#238">238</a>
+<a name="239" href="#239">239</a> <strong class="jxr_keyword">public</strong> String toString() {
+<a name="240" href="#240">240</a> StringBuffer addressBuffer =
+<a name="241" href="#241">241</a> <strong class="jxr_keyword">new</strong> StringBuffer(128)
+<a name="242" href="#242">242</a> .append(localPart)
+<a name="243" href="#243">243</a> .append(<span class="jxr_string">"@"</span>)
+<a name="244" href="#244">244</a> .append(domain);
+<a name="245" href="#245">245</a> <strong class="jxr_keyword">return</strong> addressBuffer.toString();
+<a name="246" href="#246">246</a> }
+<a name="247" href="#247">247</a>
+<a name="248" href="#248">248</a>
+<a name="249" href="#249">249</a> <em class="jxr_javadoccomment">/**</em>
+<a name="250" href="#250">250</a> <em class="jxr_javadoccomment"> * Return MailAddress as InternetAddress</em>
+<a name="251" href="#251">251</a> <em class="jxr_javadoccomment"> * </em>
+<a name="252" href="#252">252</a> <em class="jxr_javadoccomment"> * @return the address</em>
+<a name="253" href="#253">253</a> <em class="jxr_javadoccomment"> */</em>
+<a name="254" href="#254">254</a> <strong class="jxr_keyword">public</strong> InternetAddress toInternetAddress() {
+<a name="255" href="#255">255</a> <strong class="jxr_keyword">try</strong> {
+<a name="256" href="#256">256</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> InternetAddress(toString());
+<a name="257" href="#257">257</a> } <strong class="jxr_keyword">catch</strong> (javax.mail.internet.AddressException ae) {
+<a name="258" href="#258">258</a> <em class="jxr_comment">//impossible really</em>
+<a name="259" href="#259">259</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
+<a name="260" href="#260">260</a> }
+<a name="261" href="#261">261</a> }
+<a name="262" href="#262">262</a>
+<a name="263" href="#263">263</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> equals(Object obj) {
+<a name="264" href="#264">264</a> <strong class="jxr_keyword">if</strong> (obj == <strong class="jxr_keyword">null</strong>) {
+<a name="265" href="#265">265</a> <strong class="jxr_keyword">return</strong> false;
+<a name="266" href="#266">266</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (obj instanceof String) {
+<a name="267" href="#267">267</a> String theString = (String)obj;
+<a name="268" href="#268">268</a> <strong class="jxr_keyword">return</strong> toString().equalsIgnoreCase(theString);
+<a name="269" href="#269">269</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (obj instanceof MailAddress) {
+<a name="270" href="#270">270</a> <a href="../../../org/apache/mailet/MailAddress.html">MailAddress</a> addr = (MailAddress)obj;
+<a name="271" href="#271">271</a> <strong class="jxr_keyword">return</strong> getLocalPart().equalsIgnoreCase(addr.getLocalPart()) && getDomain().equalsIgnoreCase(addr.getDomain());
+<a name="272" href="#272">272</a> }
+<a name="273" href="#273">273</a> <strong class="jxr_keyword">return</strong> false;
+<a name="274" href="#274">274</a> }
+<a name="275" href="#275">275</a>
+<a name="276" href="#276">276</a> <em class="jxr_javadoccomment">/**</em>
+<a name="277" href="#277">277</a> <em class="jxr_javadoccomment"> * Return a hashCode for this object which should be identical for addresses</em>
+<a name="278" href="#278">278</a> <em class="jxr_javadoccomment"> * which are equivalent. This is implemented by obtaining the default</em>
+<a name="279" href="#279">279</a> <em class="jxr_javadoccomment"> * hashcode of the String representation of the MailAddress. Without this</em>
+<a name="280" href="#280">280</a> <em class="jxr_javadoccomment"> * explicit definition, the default hashCode will create different hashcodes</em>
+<a name="281" href="#281">281</a> <em class="jxr_javadoccomment"> * for separate object instances.</em>
+<a name="282" href="#282">282</a> <em class="jxr_javadoccomment"> *</em>
+<a name="283" href="#283">283</a> <em class="jxr_javadoccomment"> * @return the hashcode.</em>
+<a name="284" href="#284">284</a> <em class="jxr_javadoccomment"> */</em>
+<a name="285" href="#285">285</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> hashCode() {
+<a name="286" href="#286">286</a> <strong class="jxr_keyword">return</strong> toString().toLowerCase(Locale.US).hashCode();
+<a name="287" href="#287">287</a> }
+<a name="288" href="#288">288</a>
+<a name="289" href="#289">289</a> <strong class="jxr_keyword">private</strong> String parseQuotedLocalPart(String address) <strong class="jxr_keyword">throws</strong> AddressException {
+<a name="290" href="#290">290</a> StringBuffer resultSB = <strong class="jxr_keyword">new</strong> StringBuffer();
+<a name="291" href="#291">291</a> resultSB.append('\"');
+<a name="292" href="#292">292</a> pos++;
+<a name="293" href="#293">293</a> <em class="jxr_comment">//<quoted-string> ::= """ <qtext> """</em>
+<a name="294" href="#294">294</a> <em class="jxr_comment">//<qtext> ::= "\" <x> | "\" <x> <qtext> | <q> | <q> <qtext></em>
+<a name="295" href="#295">295</a> <strong class="jxr_keyword">while</strong> (<strong class="jxr_keyword">true</strong>) {
+<a name="296" href="#296">296</a> <strong class="jxr_keyword">if</strong> (address.charAt(pos) == '\"') {
+<a name="297" href="#297">297</a> resultSB.append('\"');
+<a name="298" href="#298">298</a> <em class="jxr_comment">//end of quoted string... move forward</em>
+<a name="299" href="#299">299</a> pos++;
+<a name="300" href="#300">300</a> <strong class="jxr_keyword">break</strong>;
+<a name="301" href="#301">301</a> }
+<a name="302" href="#302">302</a> <strong class="jxr_keyword">if</strong> (address.charAt(pos) == '\\') {
+<a name="303" href="#303">303</a> resultSB.append('\\');
+<a name="304" href="#304">304</a> pos++;
+<a name="305" href="#305">305</a> <em class="jxr_comment">//<x> ::= any one of the 128 ASCII characters (no exceptions)</em>
+<a name="306" href="#306">306</a> <strong class="jxr_keyword">char</strong> x = address.charAt(pos);
+<a name="307" href="#307">307</a> <strong class="jxr_keyword">if</strong> (x < 0 || x > 127) {
+<a name="308" href="#308">308</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> AddressException(<span class="jxr_string">"Invalid \\ syntaxed character at position "</span> + (pos + 1) + <span class="jxr_string">" in '"</span> + address + <span class="jxr_string">"'"</span>,address,pos+1);
+<a name="309" href="#309">309</a> }
+<a name="310" href="#310">310</a> resultSB.append(x);
+<a name="311" href="#311">311</a> pos++;
+<a name="312" href="#312">312</a> } <strong class="jxr_keyword">else</strong> {
+<a name="313" href="#313">313</a> <em class="jxr_comment">//<q> ::= any one of the 128 ASCII characters except <CR>,</em>
+<a name="314" href="#314">314</a> <em class="jxr_comment">//<LF>, quote ("), or backslash (\)</em>
+<a name="315" href="#315">315</a> <strong class="jxr_keyword">char</strong> q = address.charAt(pos);
+<a name="316" href="#316">316</a> <strong class="jxr_keyword">if</strong> (q <= 0 || q == '\n' || q == '\r' || q == '\"' || q == '\\') {
+<a name="317" href="#317">317</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> AddressException(<span class="jxr_string">"Unquoted local-part (user account) must be one of the 128 ASCI characters exception <CR>, <LF>, quote (\"), or backslash (\\) at position "</span> + (pos + 1) + <span class="jxr_string">" in '"</span> + address + <span class="jxr_string">"'"</span>);
+<a name="318" href="#318">318</a> }
+<a name="319" href="#319">319</a> resultSB.append(q);
+<a name="320" href="#320">320</a> pos++;
+<a name="321" href="#321">321</a> }
+<a name="322" href="#322">322</a> }
+<a name="323" href="#323">323</a> <strong class="jxr_keyword">return</strong> resultSB.toString();
+<a name="324" href="#324">324</a> }
+<a name="325" href="#325">325</a>
+<a name="326" href="#326">326</a> <strong class="jxr_keyword">private</strong> String parseUnquotedLocalPart(String address) <strong class="jxr_keyword">throws</strong> AddressException {
+<a name="327" href="#327">327</a> StringBuffer resultSB = <strong class="jxr_keyword">new</strong> StringBuffer();
+<a name="328" href="#328">328</a> <em class="jxr_comment">//<dot-string> ::= <string> | <string> "." <dot-string></em>
+<a name="329" href="#329">329</a> <strong class="jxr_keyword">boolean</strong> lastCharDot = false;
+<a name="330" href="#330">330</a> <strong class="jxr_keyword">while</strong> (<strong class="jxr_keyword">true</strong>) {
+<a name="331" href="#331">331</a> <em class="jxr_comment">//<string> ::= <char> | <char> <string></em>
+<a name="332" href="#332">332</a> <em class="jxr_comment">//<char> ::= <c> | "\" <x></em>
+<a name="333" href="#333">333</a> <strong class="jxr_keyword">if</strong> (address.charAt(pos) == '\\') {
+<a name="334" href="#334">334</a> resultSB.append('\\');
+<a name="335" href="#335">335</a> pos++;
+<a name="336" href="#336">336</a> <em class="jxr_comment">//<x> ::= any one of the 128 ASCII characters (no exceptions)</em>
+<a name="337" href="#337">337</a> <strong class="jxr_keyword">char</strong> x = address.charAt(pos);
+<a name="338" href="#338">338</a> <strong class="jxr_keyword">if</strong> (x < 0 || x > 127) {
+<a name="339" href="#339">339</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> AddressException(<span class="jxr_string">"Invalid \\ syntaxed character at position "</span> + (pos + 1) + <span class="jxr_string">" in '"</span> + address + <span class="jxr_string">"'"</span>,address,pos+1);
+<a name="340" href="#340">340</a> }
+<a name="341" href="#341">341</a> resultSB.append(x);
+<a name="342" href="#342">342</a> pos++;
+<a name="343" href="#343">343</a> lastCharDot = false;
+<a name="344" href="#344">344</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (address.charAt(pos) == '.') {
+<a name="345" href="#345">345</a> resultSB.append('.');
+<a name="346" href="#346">346</a> pos++;
+<a name="347" href="#347">347</a> lastCharDot = <strong class="jxr_keyword">true</strong>;
+<a name="348" href="#348">348</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (address.charAt(pos) == '@') {
+<a name="349" href="#349">349</a> <em class="jxr_comment">//End of local-part</em>
+<a name="350" href="#350">350</a> <strong class="jxr_keyword">break</strong>;
+<a name="351" href="#351">351</a> } <strong class="jxr_keyword">else</strong> {
+<a name="352" href="#352">352</a> <em class="jxr_comment">//<c> ::= any one of the 128 ASCII characters, but not any</em>
+<a name="353" href="#353">353</a> <em class="jxr_comment">// <special> or <SP></em>
+<a name="354" href="#354">354</a> <em class="jxr_comment">//<special> ::= "<" | ">" | "(" | ")" | "[" | "]" | "\" | "."</em>
+<a name="355" href="#355">355</a> <em class="jxr_comment">// | "," | ";" | ":" | "@" """ | the control</em>
+<a name="356" href="#356">356</a> <em class="jxr_comment">// characters (ASCII codes 0 through 31 inclusive and</em>
+<a name="357" href="#357">357</a> <em class="jxr_comment">// 127)</em>
+<a name="358" href="#358">358</a> <em class="jxr_comment">//<SP> ::= the space character (ASCII code 32)</em>
+<a name="359" href="#359">359</a> <strong class="jxr_keyword">char</strong> c = address.charAt(pos);
+<a name="360" href="#360">360</a> <strong class="jxr_keyword">if</strong> (c <= 31 || c >= 127 || c == ' ') {
+<a name="361" href="#361">361</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> AddressException(<span class="jxr_string">"Invalid character in local-part (user account) at position "</span> + (pos + 1) + <span class="jxr_string">" in '"</span> + address + <span class="jxr_string">"'"</span>,address,pos+1);
+<a name="362" href="#362">362</a> }
+<a name="363" href="#363">363</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i < SPECIAL.length; i++) {
+<a name="364" href="#364">364</a> <strong class="jxr_keyword">if</strong> (c == SPECIAL[i]) {
+<a name="365" href="#365">365</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> AddressException(<span class="jxr_string">"Invalid character in local-part (user account) at position "</span> + (pos + 1) + <span class="jxr_string">" in '"</span> + address + <span class="jxr_string">"'"</span>,address,pos+1);
+<a name="366" href="#366">366</a> }
+<a name="367" href="#367">367</a> }
+<a name="368" href="#368">368</a> resultSB.append(c);
+<a name="369" href="#369">369</a> pos++;
+<a name="370" href="#370">370</a> lastCharDot = false;
+<a name="371" href="#371">371</a> }
+<a name="372" href="#372">372</a> }
+<a name="373" href="#373">373</a> <strong class="jxr_keyword">if</strong> (lastCharDot) {
+<a name="374" href="#374">374</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> AddressException(<span class="jxr_string">"local-part (user account) ended with a \".\", which is invalid in address '"</span> + address + <span class="jxr_string">"'"</span>,address,pos);
+<a name="375" href="#375">375</a> }
+<a name="376" href="#376">376</a> <strong class="jxr_keyword">return</strong> resultSB.toString();
+<a name="377" href="#377">377</a> }
+<a name="378" href="#378">378</a>
+<a name="379" href="#379">379</a> <strong class="jxr_keyword">private</strong> String parseNumber(String address) <strong class="jxr_keyword">throws</strong> AddressException {
+<a name="380" href="#380">380</a> <em class="jxr_comment">//<number> ::= <d> | <d> <number></em>
+<a name="381" href="#381">381</a>
+<a name="382" href="#382">382</a> StringBuffer resultSB = <strong class="jxr_keyword">new</strong> StringBuffer();
+<a name="383" href="#383">383</a> <em class="jxr_comment">//We keep the position from the class level pos field</em>
+<a name="384" href="#384">384</a> <strong class="jxr_keyword">while</strong> (<strong class="jxr_keyword">true</strong>) {
+<a name="385" href="#385">385</a> <strong class="jxr_keyword">if</strong> (pos >= address.length()) {
+<a name="386" href="#386">386</a> <strong class="jxr_keyword">break</strong>;
+<a name="387" href="#387">387</a> }
+<a name="388" href="#388">388</a> <em class="jxr_comment">//<d> ::= any one of the ten digits 0 through 9</em>
+<a name="389" href="#389">389</a> <strong class="jxr_keyword">char</strong> d = address.charAt(pos);
+<a name="390" href="#390">390</a> <strong class="jxr_keyword">if</strong> (d == '.') {
+<a name="391" href="#391">391</a> <strong class="jxr_keyword">break</strong>;
+<a name="392" href="#392">392</a> }
+<a name="393" href="#393">393</a> <strong class="jxr_keyword">if</strong> (d < '0' || d > '9') {
+<a name="394" href="#394">394</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> AddressException(<span class="jxr_string">"In domain, did not find a number in # address at position "</span> + (pos + 1) + <span class="jxr_string">" in '"</span> + address + <span class="jxr_string">"'"</span>,address,pos+1);
+<a name="395" href="#395">395</a> }
+<a name="396" href="#396">396</a> resultSB.append(d);
+<a name="397" href="#397">397</a> pos++;
+<a name="398" href="#398">398</a> }
+<a name="399" href="#399">399</a> <strong class="jxr_keyword">return</strong> resultSB.toString();
+<a name="400" href="#400">400</a> }
+<a name="401" href="#401">401</a>
+<a name="402" href="#402">402</a> <strong class="jxr_keyword">private</strong> String parseDomainLiteral(String address) <strong class="jxr_keyword">throws</strong> AddressException {
+<a name="403" href="#403">403</a> <em class="jxr_comment">//throw away all irrelevant '\' they're not necessary for escaping of '.' or digits, and are illegal as part of the domain-literal</em>
+<a name="404" href="#404">404</a> <strong class="jxr_keyword">while</strong>(address.indexOf(<span class="jxr_string">"\\"</span>)>-1){
+<a name="405" href="#405">405</a> address= address.substring(0,address.indexOf(<span class="jxr_string">"\\"</span>)) + address.substring(address.indexOf(<span class="jxr_string">"\\"</span>)+1);
+<a name="406" href="#406">406</a> }
+<a name="407" href="#407">407</a> StringBuffer resultSB = <strong class="jxr_keyword">new</strong> StringBuffer();
+<a name="408" href="#408">408</a> <em class="jxr_comment">//we were passed the string with pos pointing the the [ char.</em>
+<a name="409" href="#409">409</a> <em class="jxr_comment">// take the first char ([), put it in the result buffer and increment pos</em>
+<a name="410" href="#410">410</a> resultSB.append(address.charAt(pos));
+<a name="411" href="#411">411</a> pos++;
+<a name="412" href="#412">412</a>
+<a name="413" href="#413">413</a> <em class="jxr_comment">//<dotnum> ::= <snum> "." <snum> "." <snum> "." <snum></em>
+<a name="414" href="#414">414</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> octet = 0; octet < 4; octet++) {
+<a name="415" href="#415">415</a> <em class="jxr_comment">//<snum> ::= one, two, or three digits representing a decimal</em>
+<a name="416" href="#416">416</a> <em class="jxr_comment">// integer value in the range 0 through 255</em>
+<a name="417" href="#417">417</a> <em class="jxr_comment">//<d> ::= any one of the ten digits 0 through 9</em>
+<a name="418" href="#418">418</a> StringBuffer snumSB = <strong class="jxr_keyword">new</strong> StringBuffer();
+<a name="419" href="#419">419</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> digits = 0; digits < 3; digits++) {
+<a name="420" href="#420">420</a> <strong class="jxr_keyword">char</strong> d = address.charAt(pos);
+<a name="421" href="#421">421</a> <strong class="jxr_keyword">if</strong> (d == '.') {
+<a name="422" href="#422">422</a> <strong class="jxr_keyword">break</strong>;
+<a name="423" href="#423">423</a> }
+<a name="424" href="#424">424</a> <strong class="jxr_keyword">if</strong> (d == ']') {
+<a name="425" href="#425">425</a> <strong class="jxr_keyword">break</strong>;
+<a name="426" href="#426">426</a> }
+<a name="427" href="#427">427</a> <strong class="jxr_keyword">if</strong> (d < '0' || d > '9') {
+<a name="428" href="#428">428</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> AddressException(<span class="jxr_string">"Invalid number at position "</span> + (pos + 1) + <span class="jxr_string">" in '"</span> + address + <span class="jxr_string">"'"</span>,address,pos+1);
+<a name="429" href="#429">429</a> }
+<a name="430" href="#430">430</a> snumSB.append(d);
+<a name="431" href="#431">431</a> pos++;
+<a name="432" href="#432">432</a> }
+<a name="433" href="#433">433</a> <strong class="jxr_keyword">if</strong> (snumSB.toString().length() == 0) {
+<a name="434" href="#434">434</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> AddressException(<span class="jxr_string">"Number not found at position "</span> + (pos + 1) + <span class="jxr_string">" in '"</span> + address + <span class="jxr_string">"'"</span>,address,pos+1);
+<a name="435" href="#435">435</a> }
+<a name="436" href="#436">436</a> <strong class="jxr_keyword">try</strong> {
+<a name="437" href="#437">437</a> <strong class="jxr_keyword">int</strong> snum = Integer.parseInt(snumSB.toString());
+<a name="438" href="#438">438</a> <strong class="jxr_keyword">if</strong> (snum > 255) {
+<a name="439" href="#439">439</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> AddressException(<span class="jxr_string">"Invalid number at position "</span> + (pos + 1) + <span class="jxr_string">" in '"</span> + address + <span class="jxr_string">"'"</span>,address,pos+1);
+<a name="440" href="#440">440</a> }
+<a name="441" href="#441">441</a> } <strong class="jxr_keyword">catch</strong> (NumberFormatException nfe) {
+<a name="442" href="#442">442</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> AddressException(<span class="jxr_string">"Invalid number at position "</span> + (pos + 1) + <span class="jxr_string">" in '"</span> + address + <span class="jxr_string">"'"</span>,address,pos+1);
+<a name="443" href="#443">443</a> }
+<a name="444" href="#444">444</a> resultSB.append(snumSB.toString());
+<a name="445" href="#445">445</a> <strong class="jxr_keyword">if</strong> (address.charAt(pos) == ']') {
+<a name="446" href="#446">446</a> <strong class="jxr_keyword">if</strong> (octet < 3) {
+<a name="447" href="#447">447</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> AddressException(<span class="jxr_string">"End of number reached too quickly at "</span> + (pos + 1) + <span class="jxr_string">" in '"</span> + address + <span class="jxr_string">"'"</span>,address,pos+1);
+<a name="448" href="#448">448</a> }
+<a name="449" href="#449">449</a> <strong class="jxr_keyword">break</strong>;
+<a name="450" href="#450">450</a> }
+<a name="451" href="#451">451</a> <strong class="jxr_keyword">if</strong> (address.charAt(pos) == '.') {
+<a name="452" href="#452">452</a> resultSB.append('.');
+<a name="453" href="#453">453</a> pos++;
+<a name="454" href="#454">454</a> }
+<a name="455" href="#455">455</a> }
+<a name="456" href="#456">456</a> <strong class="jxr_keyword">if</strong> (address.charAt(pos) != ']') {
+<a name="457" href="#457">457</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> AddressException(<span class="jxr_string">"Did not find closing bracket \"]\" in domain at position "</span> + (pos + 1) + <span class="jxr_string">" in '"</span> + address + <span class="jxr_string">"'"</span>,address,pos+1);
+<a name="458" href="#458">458</a> }
+<a name="459" href="#459">459</a> resultSB.append(']');
+<a name="460" href="#460">460</a> pos++;
+<a name="461" href="#461">461</a> <strong class="jxr_keyword">return</strong> resultSB.toString();
+<a name="462" href="#462">462</a> }
+<a name="463" href="#463">463</a>
+<a name="464" href="#464">464</a> <strong class="jxr_keyword">private</strong> String parseDomain(String address) <strong class="jxr_keyword">throws</strong> AddressException {
+<a name="465" href="#465">465</a> StringBuffer resultSB = <strong class="jxr_keyword">new</strong> StringBuffer();
+<a name="466" href="#466">466</a> <em class="jxr_comment">//<name> ::= <a> <ldh-str> <let-dig></em>
+<a name="467" href="#467">467</a> <em class="jxr_comment">//<ldh-str> ::= <let-dig-hyp> | <let-dig-hyp> <ldh-str></em>
+<a name="468" href="#468">468</a> <em class="jxr_comment">//<let-dig> ::= <a> | <d></em>
+<a name="469" href="#469">469</a> <em class="jxr_comment">//<let-dig-hyp> ::= <a> | <d> | "-"</em>
+<a name="470" href="#470">470</a> <em class="jxr_comment">//<a> ::= any one of the 52 alphabetic characters A through Z</em>
+<a name="471" href="#471">471</a> <em class="jxr_comment">// in upper case and a through z in lower case</em>
+<a name="472" href="#472">472</a> <em class="jxr_comment">//<d> ::= any one of the ten digits 0 through 9</em>
+<a name="473" href="#473">473</a>
+<a name="474" href="#474">474</a> <em class="jxr_comment">// basically, this is a series of letters, digits, and hyphens,</em>
+<a name="475" href="#475">475</a> <em class="jxr_comment">// but it can't start with a digit or hypthen</em>
+<a name="476" href="#476">476</a> <em class="jxr_comment">// and can't end with a hyphen</em>
+<a name="477" href="#477">477</a>
+<a name="478" href="#478">478</a> <em class="jxr_comment">// in practice though, we should relax this as domain names can start</em>
+<a name="479" href="#479">479</a> <em class="jxr_comment">// with digits as well as letters. So only check that doesn't start</em>
+<a name="480" href="#480">480</a> <em class="jxr_comment">// or end with hyphen.</em>
+<a name="481" href="#481">481</a> <strong class="jxr_keyword">while</strong> (<strong class="jxr_keyword">true</strong>) {
+<a name="482" href="#482">482</a> <strong class="jxr_keyword">if</strong> (pos >= address.length()) {
+<a name="483" href="#483">483</a> <strong class="jxr_keyword">break</strong>;
+<a name="484" href="#484">484</a> }
+<a name="485" href="#485">485</a> <strong class="jxr_keyword">char</strong> ch = address.charAt(pos);
+<a name="486" href="#486">486</a> <strong class="jxr_keyword">if</strong> ((ch >= '0' && ch <= '9') ||
+<a name="487" href="#487">487</a> (ch >= 'a' && ch <= 'z') ||
+<a name="488" href="#488">488</a> (ch >= 'A' && ch <= 'Z') ||
+<a name="489" href="#489">489</a> (ch == '-')) {
+<a name="490" href="#490">490</a> resultSB.append(ch);
+<a name="491" href="#491">491</a> pos++;
+<a name="492" href="#492">492</a> <strong class="jxr_keyword">continue</strong>;
+<a name="493" href="#493">493</a> }
+<a name="494" href="#494">494</a> <strong class="jxr_keyword">if</strong> (ch == '.') {
+<a name="495" href="#495">495</a> <strong class="jxr_keyword">break</strong>;
+<a name="496" href="#496">496</a> }
+<a name="497" href="#497">497</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> AddressException(<span class="jxr_string">"Invalid character at "</span> + pos + <span class="jxr_string">" in '"</span> + address + <span class="jxr_string">"'"</span>,address,pos);
+<a name="498" href="#498">498</a> }
+<a name="499" href="#499">499</a> String result = resultSB.toString();
+<a name="500" href="#500">500</a> <strong class="jxr_keyword">if</strong> (result.startsWith(<span class="jxr_string">"-"</span>) || result.endsWith(<span class="jxr_string">"-"</span>)) {
+<a name="501" href="#501">501</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> AddressException(<span class="jxr_string">"Domain name cannot begin or end with a hyphen \"-\" at position "</span> + (pos + 1) + <span class="jxr_string">" in '"</span> + address + <span class="jxr_string">"'"</span>,address,pos+1);
+<a name="502" href="#502">502</a> }
+<a name="503" href="#503">503</a> <strong class="jxr_keyword">return</strong> result;
+<a name="504" href="#504">504</a> }
+<a name="505" href="#505">505</a> }
+</pre>
+<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
+</html>
+
Added: james/site/trunk/www/mailet/api/xref/org/apache/mailet/Mailet.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/mailet/api/xref/org/apache/mailet/Mailet.html?rev=687845&view=auto
==============================================================================
--- james/site/trunk/www/mailet/api/xref/org/apache/mailet/Mailet.html (added)
+++ james/site/trunk/www/mailet/api/xref/org/apache/mailet/Mailet.html Thu Aug 21 13:15:10 2008
@@ -0,0 +1,136 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
+<title>Mailet xref</title>
+<link type="text/css" rel="stylesheet" href="../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../apidocs/org/apache/mailet/Mailet.html">View Javadoc</a></div><pre>
+
+<a name="1" href="#1">1</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment">**************************************************************</em>
+<a name="2" href="#2">2</a> <em class="jxr_javadoccomment"> * Licensed to the Apache Software Foundation (ASF) under one *</em>
+<a name="3" href="#3">3</a> <em class="jxr_javadoccomment"> * or more contributor license agreements. See the NOTICE file *</em>
+<a name="4" href="#4">4</a> <em class="jxr_javadoccomment"> * distributed with this work for additional information *</em>
+<a name="5" href="#5">5</a> <em class="jxr_javadoccomment"> * regarding copyright ownership. The ASF licenses this file *</em>
+<a name="6" href="#6">6</a> <em class="jxr_javadoccomment"> * to you under the Apache License, Version 2.0 (the *</em>
+<a name="7" href="#7">7</a> <em class="jxr_javadoccomment"> * "License"); you may not use this file except in compliance *</em>
+<a name="8" href="#8">8</a> <em class="jxr_javadoccomment"> * with the License. You may obtain a copy of the License at *</em>
+<a name="9" href="#9">9</a> <em class="jxr_javadoccomment"> * *</em>
+<a name="10" href="#10">10</a> <em class="jxr_javadoccomment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a> *</em>
+<a name="11" href="#11">11</a> <em class="jxr_javadoccomment"> * *</em>
+<a name="12" href="#12">12</a> <em class="jxr_javadoccomment"> * Unless required by applicable law or agreed to in writing, *</em>
+<a name="13" href="#13">13</a> <em class="jxr_javadoccomment"> * software distributed under the License is distributed on an *</em>
+<a name="14" href="#14">14</a> <em class="jxr_javadoccomment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY *</em>
+<a name="15" href="#15">15</a> <em class="jxr_javadoccomment"> * KIND, either express or implied. See the License for the *</em>
+<a name="16" href="#16">16</a> <em class="jxr_javadoccomment"> * specific language governing permissions and limitations *</em>
+<a name="17" href="#17">17</a> <em class="jxr_javadoccomment"> * under the License. *</em>
+<a name="18" href="#18">18</a> <em class="jxr_javadoccomment"> ****************************************************************/</em>
+<a name="19" href="#19">19</a>
+<a name="20" href="#20">20</a>
+<a name="21" href="#21">21</a> <strong class="jxr_keyword">package</strong> org.apache.mailet;
+<a name="22" href="#22">22</a>
+<a name="23" href="#23">23</a> <em class="jxr_javadoccomment">/**</em>
+<a name="24" href="#24">24</a> <em class="jxr_javadoccomment"> * Draft of a Mailet inteface. The <code>service</code> perform all needed work</em>
+<a name="25" href="#25">25</a> <em class="jxr_javadoccomment"> * on the Mail object. Whatever remains at the end of the service is considered</em>
+<a name="26" href="#26">26</a> <em class="jxr_javadoccomment"> * to need futher processing and will go to the next Mailet if there is one</em>
+<a name="27" href="#27">27</a> <em class="jxr_javadoccomment"> * configured or will go to the error processor if not.</em>
+<a name="28" href="#28">28</a> <em class="jxr_javadoccomment"> * Setting a Mail state (setState(String)) to Mail.GHOST or cleaning its recipient</em>
+<a name="29" href="#29">29</a> <em class="jxr_javadoccomment"> * list has the same meaning that s no more processing is needed.</em>
+<a name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * Instead of creating new messages, the mailet can put a message with new recipients</em>
+<a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * at the top of the mail queue, or insert them immediately after it's execution</em>
+<a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * through the API are provided by the MailetContext interface.</em>
+<a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * <p></em>
+<a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * This interface defines methods to initialize a mailet, to service messages, and to</em>
+<a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * remove a mailet from the server. These are known as life-cycle methods and are called</em>
+<a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * in the following sequence:</em>
+<a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * <ol></em>
+<a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * <li>The mailet is constructed, then initialized with the init method. </li></em>
+<a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * <li>Any messages for the service method are handled.</li></em>
+<a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * <li>The mailet is taken out of service, then destroyed with the destroy method,</em>
+<a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * then garbage collected and finalized.</li></em>
+<a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * </ol></em>
+<a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * In addition to the life-cycle methods, this interface provides the getMailetConfig</em>
+<a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * method, which the mailet can use to get any startup information, and the</em>
+<a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * getMailetInfo method, which allows the mailet to return basic information about itself,</em>
+<a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * such as author, version, and copyright.</em>
+<a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> *</em>
+<a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * @version 1.0.0, 24/04/1999</em>
+<a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> */</em>
+<a name="50" href="#50">50</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../org/apache/mailet/Mailet.html">Mailet</a> {
+<a name="51" href="#51">51</a>
+<a name="52" href="#52">52</a> <em class="jxr_javadoccomment">/**</em>
+<a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * Called by the mailet container to indicate to a mailet that the</em>
+<a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * mailet is being taken out of service. This method is only called once</em>
+<a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * all threads within the mailet's service method have exited or after a</em>
+<a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * timeout period has passed. After the mailet container calls this method,</em>
+<a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * it will not call the service method again on this mailet.</em>
+<a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * <p></em>
+<a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * This method gives the mailet an opportunity to clean up any resources that</em>
+<a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * are being held (for example, memory, file handles, threads) and make sure</em>
+<a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * that any persistent state is synchronized with the mailet's current state in memory.</em>
+<a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> */</em>
+<a name="63" href="#63">63</a> <strong class="jxr_keyword">void</strong> destroy();
+<a name="64" href="#64">64</a>
+<a name="65" href="#65">65</a> <em class="jxr_javadoccomment">/**</em>
+<a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * Returns information about the mailet, such as author, version, and</em>
+<a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * copyright.</em>
+<a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * <p></em>
+<a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * The string that this method returns should be plain text and not markup</em>
+<a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * of any kind (such as HTML, XML, etc.).</em>
+<a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> *</em>
+<a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * @return a String containing servlet information</em>
+<a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> */</em>
+<a name="74" href="#74">74</a> String getMailetInfo();
+<a name="75" href="#75">75</a>
+<a name="76" href="#76">76</a> <em class="jxr_javadoccomment">/**</em>
+<a name="77" href="#77">77</a> <em class="jxr_javadoccomment"> * Returns a MailetConfig object, which contains initialization and</em>
+<a name="78" href="#78">78</a> <em class="jxr_javadoccomment"> * startup parameters for this mailet.</em>
+<a name="79" href="#79">79</a> <em class="jxr_javadoccomment"> * <p></em>
+<a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * Implementations of this interface are responsible for storing the MailetConfig</em>
+<a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> * object so that this method can return it. The GenericMailet class, which implements</em>
+<a name="82" href="#82">82</a> <em class="jxr_javadoccomment"> * this interface, already does this.</em>
+<a name="83" href="#83">83</a> <em class="jxr_javadoccomment"> *</em>
+<a name="84" href="#84">84</a> <em class="jxr_javadoccomment"> * @return the MailetConfig object that initializes this mailet</em>
+<a name="85" href="#85">85</a> <em class="jxr_javadoccomment"> */</em>
+<a name="86" href="#86">86</a> <a href="../../../org/apache/mailet/MailetConfig.html">MailetConfig</a> getMailetConfig();
+<a name="87" href="#87">87</a>
+<a name="88" href="#88">88</a> <em class="jxr_javadoccomment">/**</em>
+<a name="89" href="#89">89</a> <em class="jxr_javadoccomment"> * Called by the mailet container to indicate to a mailet that the</em>
+<a name="90" href="#90">90</a> <em class="jxr_javadoccomment"> * mailet is being placed into service.</em>
+<a name="91" href="#91">91</a> <em class="jxr_javadoccomment"> * <p></em>
+<a name="92" href="#92">92</a> <em class="jxr_javadoccomment"> * The mailet container calls the init method exactly once after</em>
+<a name="93" href="#93">93</a> <em class="jxr_javadoccomment"> * instantiating the mailet. The init method must complete successfully</em>
+<a name="94" href="#94">94</a> <em class="jxr_javadoccomment"> * before the mailet can receive any requests.</em>
+<a name="95" href="#95">95</a> <em class="jxr_javadoccomment"> *</em>
+<a name="96" href="#96">96</a> <em class="jxr_javadoccomment"> * @param config - a MailetConfig object containing the mailet's configuration</em>
+<a name="97" href="#97">97</a> <em class="jxr_javadoccomment"> * and initialization parameters</em>
+<a name="98" href="#98">98</a> <em class="jxr_javadoccomment"> * @throws javax.mail.MessagingException - if an exception has occurred that interferes with</em>
+<a name="99" href="#99">99</a> <em class="jxr_javadoccomment"> * the mailet's normal operation</em>
+<a name="100" href="#100">100</a> <em class="jxr_javadoccomment"> */</em>
+<a name="101" href="#101">101</a> <strong class="jxr_keyword">void</strong> init(<a href="../../../org/apache/mailet/MailetConfig.html">MailetConfig</a> config) <strong class="jxr_keyword">throws</strong> javax.mail.MessagingException;
+<a name="102" href="#102">102</a>
+<a name="103" href="#103">103</a> <em class="jxr_javadoccomment">/**</em>
+<a name="104" href="#104">104</a> <em class="jxr_javadoccomment"> * Called by the mailet container to allow the mailet to process to</em>
+<a name="105" href="#105">105</a> <em class="jxr_javadoccomment"> * a message.</em>
+<a name="106" href="#106">106</a> <em class="jxr_javadoccomment"> * <p></em>
+<a name="107" href="#107">107</a> <em class="jxr_javadoccomment"> * This method is only called after the mailet's init() method has completed</em>
+<a name="108" href="#108">108</a> <em class="jxr_javadoccomment"> * successfully.</em>
+<a name="109" href="#109">109</a> <em class="jxr_javadoccomment"> * <p></em>
+<a name="110" href="#110">110</a> <em class="jxr_javadoccomment"> * Mailets typically run inside multithreaded mailet containers that can handle</em>
+<a name="111" href="#111">111</a> <em class="jxr_javadoccomment"> * multiple requests concurrently. Developers must be aware to synchronize access</em>
+<a name="112" href="#112">112</a> <em class="jxr_javadoccomment"> * to any shared resources such as files, network connections, as well as the</em>
+<a name="113" href="#113">113</a> <em class="jxr_javadoccomment"> * mailet's class and instance variables. More information on multithreaded</em>
+<a name="114" href="#114">114</a> <em class="jxr_javadoccomment"> * programming in Java is available in <a href="<a href="http://java.sun.com/Series/Tutorial/java/threads/multithreaded.html" target="alexandria_uri">http://java.sun.com/Series/Tutorial/java/threads/multithreaded.html</a>">the</em>
+<a name="115" href="#115">115</a> <em class="jxr_javadoccomment"> * Java tutorial on multi-threaded programming</a>.</em>
+<a name="116" href="#116">116</a> <em class="jxr_javadoccomment"> *</em>
+<a name="117" href="#117">117</a> <em class="jxr_javadoccomment"> * @param mail - the Mail object that contains the message and routing information</em>
+<a name="118" href="#118">118</a> <em class="jxr_javadoccomment"> * @throws javax.mail.MessagingException - if a message or address parsing exception occurs or</em>
+<a name="119" href="#119">119</a> <em class="jxr_javadoccomment"> * an exception that interferes with the mailet's normal operation</em>
+<a name="120" href="#120">120</a> <em class="jxr_javadoccomment"> */</em>
+<a name="121" href="#121">121</a> <strong class="jxr_keyword">void</strong> service(<a href="../../../org/apache/mailet/Mail.html">Mail</a> mail) <strong class="jxr_keyword">throws</strong> javax.mail.MessagingException;
+<a name="122" href="#122">122</a> }
+</pre>
+<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
+</html>
+
Added: james/site/trunk/www/mailet/api/xref/org/apache/mailet/MailetConfig.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/mailet/api/xref/org/apache/mailet/MailetConfig.html?rev=687845&view=auto
==============================================================================
--- james/site/trunk/www/mailet/api/xref/org/apache/mailet/MailetConfig.html (added)
+++ james/site/trunk/www/mailet/api/xref/org/apache/mailet/MailetConfig.html Thu Aug 21 13:15:10 2008
@@ -0,0 +1,88 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
+<title>MailetConfig xref</title>
+<link type="text/css" rel="stylesheet" href="../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../apidocs/org/apache/mailet/MailetConfig.html">View Javadoc</a></div><pre>
+
+<a name="1" href="#1">1</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment">**************************************************************</em>
+<a name="2" href="#2">2</a> <em class="jxr_javadoccomment"> * Licensed to the Apache Software Foundation (ASF) under one *</em>
+<a name="3" href="#3">3</a> <em class="jxr_javadoccomment"> * or more contributor license agreements. See the NOTICE file *</em>
+<a name="4" href="#4">4</a> <em class="jxr_javadoccomment"> * distributed with this work for additional information *</em>
+<a name="5" href="#5">5</a> <em class="jxr_javadoccomment"> * regarding copyright ownership. The ASF licenses this file *</em>
+<a name="6" href="#6">6</a> <em class="jxr_javadoccomment"> * to you under the Apache License, Version 2.0 (the *</em>
+<a name="7" href="#7">7</a> <em class="jxr_javadoccomment"> * "License"); you may not use this file except in compliance *</em>
+<a name="8" href="#8">8</a> <em class="jxr_javadoccomment"> * with the License. You may obtain a copy of the License at *</em>
+<a name="9" href="#9">9</a> <em class="jxr_javadoccomment"> * *</em>
+<a name="10" href="#10">10</a> <em class="jxr_javadoccomment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a> *</em>
+<a name="11" href="#11">11</a> <em class="jxr_javadoccomment"> * *</em>
+<a name="12" href="#12">12</a> <em class="jxr_javadoccomment"> * Unless required by applicable law or agreed to in writing, *</em>
+<a name="13" href="#13">13</a> <em class="jxr_javadoccomment"> * software distributed under the License is distributed on an *</em>
+<a name="14" href="#14">14</a> <em class="jxr_javadoccomment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY *</em>
+<a name="15" href="#15">15</a> <em class="jxr_javadoccomment"> * KIND, either express or implied. See the License for the *</em>
+<a name="16" href="#16">16</a> <em class="jxr_javadoccomment"> * specific language governing permissions and limitations *</em>
+<a name="17" href="#17">17</a> <em class="jxr_javadoccomment"> * under the License. *</em>
+<a name="18" href="#18">18</a> <em class="jxr_javadoccomment"> ****************************************************************/</em>
+<a name="19" href="#19">19</a>
+<a name="20" href="#20">20</a>
+<a name="21" href="#21">21</a> <strong class="jxr_keyword">package</strong> org.apache.mailet;
+<a name="22" href="#22">22</a>
+<a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> java.util.Iterator;
+<a name="24" href="#24">24</a>
+<a name="25" href="#25">25</a> <em class="jxr_javadoccomment">/**</em>
+<a name="26" href="#26">26</a> <em class="jxr_javadoccomment"> * A mailet configuration object used by a mailet container to pass information</em>
+<a name="27" href="#27">27</a> <em class="jxr_javadoccomment"> * to a mailet during initialization.</em>
+<a name="28" href="#28">28</a> <em class="jxr_javadoccomment"> * <p></em>
+<a name="29" href="#29">29</a> <em class="jxr_javadoccomment"> * The configuration information contains initialization parameters, which are a set</em>
+<a name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * of name/value pairs, and a MailetContext object, which gives the mailet information</em>
+<a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * about the server.</em>
+<a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> *</em>
+<a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * @version 1.0.0, 24/04/1999</em>
+<a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> */</em>
+<a name="35" href="#35">35</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../org/apache/mailet/MailetConfig.html">MailetConfig</a> {
+<a name="36" href="#36">36</a>
+<a name="37" href="#37">37</a> <em class="jxr_javadoccomment">/**</em>
+<a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * Returns a String containing the value of the named initialization</em>
+<a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * parameter, or null if the parameter does not exist.</em>
+<a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> *</em>
+<a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * @param name - a String specifying the name of the initialization parameter</em>
+<a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * @return a String containing the value of the initialization parameter</em>
+<a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> */</em>
+<a name="44" href="#44">44</a> String getInitParameter(String name);
+<a name="45" href="#45">45</a>
+<a name="46" href="#46">46</a> <em class="jxr_javadoccomment">/**</em>
+<a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * Returns the names of the mailet's initialization parameters as an</em>
+<a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * Iterator of String objects, or an empty Iterator if the mailet has</em>
+<a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * no initialization parameters.</em>
+<a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> *</em>
+<a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * @return an Iterator of String objects containing the names of the mailet's</em>
+<a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * initialization parameters</em>
+<a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> */</em>
+<a name="54" href="#54">54</a> Iterator getInitParameterNames();
+<a name="55" href="#55">55</a>
+<a name="56" href="#56">56</a> <em class="jxr_javadoccomment">/**</em>
+<a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * Returns a reference to the MailetContext in which the mailet is</em>
+<a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * executing.</em>
+<a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> *</em>
+<a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * @return a MailetContext object, used by the mailet to interact with its</em>
+<a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * mailet container</em>
+<a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> */</em>
+<a name="63" href="#63">63</a> <a href="../../../org/apache/mailet/MailetContext.html">MailetContext</a> getMailetContext();
+<a name="64" href="#64">64</a>
+<a name="65" href="#65">65</a> <em class="jxr_javadoccomment">/**</em>
+<a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * Returns the name of this mailet instance. The name may be provided via</em>
+<a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * server administration, assigned in the application deployment descriptor,</em>
+<a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * or for an unregistered (and thus unnamed) mailet instance it will be the</em>
+<a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * mailet's class name.</em>
+<a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> *</em>
+<a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * @return the name of the mailet instance</em>
+<a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> */</em>
+<a name="73" href="#73">73</a> String getMailetName();
+<a name="74" href="#74">74</a> }
+</pre>
+<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
+</html>
+