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 2009/08/03 14:19:07 UTC
svn commit: r800330 [2/22] - in /james/site/trunk/www/mailet: ./ api/
api/apidocs/ api/apidocs/org/apache/mailet/
api/apidocs/org/apache/mailet/class-use/ api/stylesheets/ api/testapidocs/
api/testapidocs/org/apache/mailet/ api/testapidocs/org/apache/m...
Modified: james/site/trunk/www/mailet/api/apidocs/index-all.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/mailet/api/apidocs/index-all.html?rev=800330&r1=800329&r2=800330&view=diff
==============================================================================
--- james/site/trunk/www/mailet/api/apidocs/index-all.html (original)
+++ james/site/trunk/www/mailet/api/apidocs/index-all.html Mon Aug 3 12:18:51 2009
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.5.0_18) on Thu May 28 11:11:02 BST 2009 -->
+<!-- Generated by javadoc (build 1.5.0_18) on Mon Aug 03 13:36:26 BST 2009 -->
<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<TITLE>
Index (Apache Mailet API 2.5-SNAPSHOT API)
@@ -83,8 +83,7 @@
<DD>Bounces the message using a standard format with the given message.
<DT><A HREF="./org/apache/mailet/MailetContext.html#bounce(org.apache.mailet.Mail, java.lang.String, org.apache.mailet.MailAddress)"><B>bounce(Mail, String, MailAddress)</B></A> -
Method in interface org.apache.mailet.<A HREF="./org/apache/mailet/MailetContext.html" title="interface in org.apache.mailet">MailetContext</A>
-<DD>Bounces the email message using the provided email address as the
- sender of the bounce.
+<DD>Bounces the message using a standard format with the given message.
</DL>
<HR>
<A NAME="_D_"><!-- --></A><H2>
@@ -95,12 +94,10 @@
<DD>
<DT><A HREF="./org/apache/mailet/Mailet.html#destroy()"><B>destroy()</B></A> -
Method in interface org.apache.mailet.<A HREF="./org/apache/mailet/Mailet.html" title="interface in org.apache.mailet">Mailet</A>
-<DD>Called by the mailet container to indicate to a mailet that the
- mailet is being taken out of service.
+<DD>Destroys this Mailet.
<DT><A HREF="./org/apache/mailet/Matcher.html#destroy()"><B>destroy()</B></A> -
Method in interface org.apache.mailet.<A HREF="./org/apache/mailet/Matcher.html" title="interface in org.apache.mailet">Matcher</A>
-<DD>Called by the mailet container to indicate to a matcher that the matcher
- is being taken out of service.
+<DD>Destroys this Matcher.
</DL>
<HR>
<A NAME="_E_"><!-- --></A><H2>
@@ -108,7 +105,7 @@
<DL>
<DT><A HREF="./org/apache/mailet/MailAddress.html#equals(java.lang.Object)"><B>equals(Object)</B></A> -
Method in class org.apache.mailet.<A HREF="./org/apache/mailet/MailAddress.html" title="class in org.apache.mailet">MailAddress</A>
-<DD>
+<DD>Indicates whether some other object is "equal to" this one.
<DT><A HREF="./org/apache/mailet/Mail.html#ERROR"><B>ERROR</B></A> -
Static variable in interface org.apache.mailet.<A HREF="./org/apache/mailet/Mail.html" title="interface in org.apache.mailet">Mail</A>
<DD>
@@ -119,40 +116,40 @@
<DL>
<DT><A HREF="./org/apache/mailet/Mail.html#getAttribute(java.lang.String)"><B>getAttribute(String)</B></A> -
Method in interface org.apache.mailet.<A HREF="./org/apache/mailet/Mail.html" title="interface in org.apache.mailet">Mail</A>
-<DD>Returns the Mail session attribute with the given name, or null
- if there is no attribute by that name.
+<DD>Returns the value of the named Mail instance attribute,
+ or null if the attribute does not exist.
<DT><A HREF="./org/apache/mailet/MailetContext.html#getAttribute(java.lang.String)"><B>getAttribute(String)</B></A> -
Method in interface org.apache.mailet.<A HREF="./org/apache/mailet/MailetContext.html" title="interface in org.apache.mailet">MailetContext</A>
-<DD>Returns the mailet container attribute with the given name, or null
- if there is no attribute by that name.
+<DD>Returns the value of the named mailet context attribute,
+ or null if the attribute does not exist.
<DT><A HREF="./org/apache/mailet/Mail.html#getAttributeNames()"><B>getAttributeNames()</B></A> -
Method in interface org.apache.mailet.<A HREF="./org/apache/mailet/Mail.html" title="interface in org.apache.mailet">Mail</A>
-<DD>Returns an Iterator containing the attribute names currently available within
- this Mail instance.
+<DD>Returns an Iterator over the names of all attributes which are set
+ in this Mail instance.
<DT><A HREF="./org/apache/mailet/MailetContext.html#getAttributeNames()"><B>getAttributeNames()</B></A> -
Method in interface org.apache.mailet.<A HREF="./org/apache/mailet/MailetContext.html" title="interface in org.apache.mailet">MailetContext</A>
-<DD>Returns an Iterator containing the attribute names available within
- this mailet context.
+<DD>Returns an Iterator over the names of all attributes which are set
+ in this mailet context.
<DT><A HREF="./org/apache/mailet/MatcherConfig.html#getCondition()"><B>getCondition()</B></A> -
Method in interface org.apache.mailet.<A HREF="./org/apache/mailet/MatcherConfig.html" title="interface in org.apache.mailet">MatcherConfig</A>
-<DD>The simple condition defined for this matcher, e.g., for
- SenderIs=admin@localhost, this would return admin@localhost.
+<DD>The condition defined for this matcher.
<DT><A HREF="./org/apache/mailet/MailAddress.html#getDomain()"><B>getDomain()</B></A> -
Method in class org.apache.mailet.<A HREF="./org/apache/mailet/MailAddress.html" title="class in org.apache.mailet">MailAddress</A>
-<DD>Return the domain part per RFC2822 3.4.1.
+<DD>Returns the domain part per RFC2822 3.4.1.
<DT><A HREF="./org/apache/mailet/Mail.html#getErrorMessage()"><B>getErrorMessage()</B></A> -
Method in interface org.apache.mailet.<A HREF="./org/apache/mailet/Mail.html" title="interface in org.apache.mailet">Mail</A>
<DD>The error message, if any, associated with this message.
<DT><A HREF="./org/apache/mailet/MailAddress.html#getHost()"><B>getHost()</B></A> -
Method in class org.apache.mailet.<A HREF="./org/apache/mailet/MailAddress.html" title="class in org.apache.mailet">MailAddress</A>
-<DD><B>Deprecated.</B> <I>use getDomain() - name change to align with RFC2822 3.4.1. Addr-spec specification</I>
+<DD><B>Deprecated.</B> <I>use <A HREF="./org/apache/mailet/MailAddress.html#getDomain()"><CODE>MailAddress.getDomain()</CODE></A>, whose name was changed to
+ align with RFC2822 3.4.1. addr-spec specification</I>
<DT><A HREF="./org/apache/mailet/HostAddress.html#getHostName()"><B>getHostName()</B></A> -
Method in class org.apache.mailet.<A HREF="./org/apache/mailet/HostAddress.html" title="class in org.apache.mailet">HostAddress</A>
-<DD>
+<DD>Returns the host name corresponding to the url
<DT><A HREF="./org/apache/mailet/MailetConfig.html#getInitParameter(java.lang.String)"><B>getInitParameter(String)</B></A> -
Method in interface org.apache.mailet.<A HREF="./org/apache/mailet/MailetConfig.html" title="interface in org.apache.mailet">MailetConfig</A>
-<DD>Returns a String containing the value of the named initialization
- parameter, or null if the parameter does not exist.
+<DD>Returns the value of the named initialization parameter,
+ or null if the parameter does not exist.
<DT><A HREF="./org/apache/mailet/MailetConfig.html#getInitParameterNames()"><B>getInitParameterNames()</B></A> -
Method in interface org.apache.mailet.<A HREF="./org/apache/mailet/MailetConfig.html" title="interface in org.apache.mailet">MailetConfig</A>
<DD>Returns the names of the mailet's initialization parameters as an
@@ -160,14 +157,15 @@
no initialization parameters.
<DT><A HREF="./org/apache/mailet/Mail.html#getLastUpdated()"><B>getLastUpdated()</B></A> -
Method in interface org.apache.mailet.<A HREF="./org/apache/mailet/Mail.html" title="interface in org.apache.mailet">Mail</A>
-<DD>
+<DD>Returns the time at which this Mail was last updated.
<DT><A HREF="./org/apache/mailet/MailAddress.html#getLocalPart()"><B>getLocalPart()</B></A> -
Method in class org.apache.mailet.<A HREF="./org/apache/mailet/MailAddress.html" title="class in org.apache.mailet">MailAddress</A>
-<DD>Return the local-part per RFC2822 3.4.1.
+<DD>Returns the local-part per RFC2822 3.4.1.
<DT><A HREF="./org/apache/mailet/Mailet.html#getMailetConfig()"><B>getMailetConfig()</B></A> -
Method in interface org.apache.mailet.<A HREF="./org/apache/mailet/Mailet.html" title="interface in org.apache.mailet">Mailet</A>
-<DD>Returns a MailetConfig object, which contains initialization and
- startup parameters for this mailet.
+<DD>Returns a MailetConfig object, which provides initialization parameters
+ and a <A HREF="./org/apache/mailet/MailetContext.html" title="interface in org.apache.mailet"><CODE>MailetContext</CODE></A> through which it can interact with the
+ mailet container.
<DT><A HREF="./org/apache/mailet/MailetConfig.html#getMailetContext()"><B>getMailetContext()</B></A> -
Method in interface org.apache.mailet.<A HREF="./org/apache/mailet/MailetConfig.html" title="interface in org.apache.mailet">MailetConfig</A>
<DD>Returns a reference to the MailetContext in which the mailet is
@@ -177,73 +175,76 @@
<DD>Returns a reference to the MailetContext in which the matcher is executing
<DT><A HREF="./org/apache/mailet/Mailet.html#getMailetInfo()"><B>getMailetInfo()</B></A> -
Method in interface org.apache.mailet.<A HREF="./org/apache/mailet/Mailet.html" title="interface in org.apache.mailet">Mailet</A>
-<DD>Returns information about the mailet, such as author, version, and
+<DD>Returns information about the mailet, such as author, version and
copyright.
<DT><A HREF="./org/apache/mailet/MailetConfig.html#getMailetName()"><B>getMailetName()</B></A> -
Method in interface org.apache.mailet.<A HREF="./org/apache/mailet/MailetConfig.html" title="interface in org.apache.mailet">MailetConfig</A>
<DD>Returns the name of this mailet instance.
<DT><A HREF="./org/apache/mailet/MailetContext.html#getMailServers(java.lang.String)"><B>getMailServers(String)</B></A> -
Method in interface org.apache.mailet.<A HREF="./org/apache/mailet/MailetContext.html" title="interface in org.apache.mailet">MailetContext</A>
-<DD>Returns a Collection of Strings of hostnames or ip addresses that
- are specified as mail server listeners for the given hostname.
+<DD>Returns the hostnames that are specified as mail handlers for
+ the given domain name.
<DT><A HREF="./org/apache/mailet/MailetContext.html#getMajorVersion()"><B>getMajorVersion()</B></A> -
Method in interface org.apache.mailet.<A HREF="./org/apache/mailet/MailetContext.html" title="interface in org.apache.mailet">MailetContext</A>
-<DD>Returns the major version of the Mailet API that this mailet
+<DD>Returns the major version number of the Mailet API that this mailet
container supports.
<DT><A HREF="./org/apache/mailet/Matcher.html#getMatcherConfig()"><B>getMatcherConfig()</B></A> -
Method in interface org.apache.mailet.<A HREF="./org/apache/mailet/Matcher.html" title="interface in org.apache.mailet">Matcher</A>
-<DD>Returns a MatcherConfig object, which contains initialization and
- startup parameters for this matcher.
+<DD>Returns a MatcherConfig object, which provides initialization parameters
+ and a <A HREF="./org/apache/mailet/MailetContext.html" title="interface in org.apache.mailet"><CODE>MailetContext</CODE></A> through which it can interact with the
+ mailet container.
<DT><A HREF="./org/apache/mailet/Matcher.html#getMatcherInfo()"><B>getMatcherInfo()</B></A> -
Method in interface org.apache.mailet.<A HREF="./org/apache/mailet/Matcher.html" title="interface in org.apache.mailet">Matcher</A>
-<DD>Returns information about the matcher, such as author, version, and copyright.
+<DD>Returns information about the matcher, such as author, version and
+ copyright.
<DT><A HREF="./org/apache/mailet/MatcherConfig.html#getMatcherName()"><B>getMatcherName()</B></A> -
Method in interface org.apache.mailet.<A HREF="./org/apache/mailet/MatcherConfig.html" title="interface in org.apache.mailet">MatcherConfig</A>
<DD>Returns the name of this matcher instance.
<DT><A HREF="./org/apache/mailet/Mail.html#getMessage()"><B>getMessage()</B></A> -
Method in interface org.apache.mailet.<A HREF="./org/apache/mailet/Mail.html" title="interface in org.apache.mailet">Mail</A>
-<DD>Returns the MimeMessage stored in this message
+<DD>Returns the MimeMessage stored in this message.
<DT><A HREF="./org/apache/mailet/Mail.html#getMessageSize()"><B>getMessageSize()</B></A> -
Method in interface org.apache.mailet.<A HREF="./org/apache/mailet/Mail.html" title="interface in org.apache.mailet">Mail</A>
-<DD>
+<DD>Returns the message size (including headers).
<DT><A HREF="./org/apache/mailet/MailetContext.html#getMinorVersion()"><B>getMinorVersion()</B></A> -
Method in interface org.apache.mailet.<A HREF="./org/apache/mailet/MailetContext.html" title="interface in org.apache.mailet">MailetContext</A>
-<DD>Returns the minor version of the Mailet API that this mailet
+<DD>Returns the minor version number of the Mailet API that this mailet
container supports.
<DT><A HREF="./org/apache/mailet/Mail.html#getName()"><B>getName()</B></A> -
Method in interface org.apache.mailet.<A HREF="./org/apache/mailet/Mail.html" title="interface in org.apache.mailet">Mail</A>
-<DD>Returns the message name of this message
+<DD>Returns the name of this message.
<DT><A HREF="./org/apache/mailet/MailetContext.html#getPostmaster()"><B>getPostmaster()</B></A> -
Method in interface org.apache.mailet.<A HREF="./org/apache/mailet/MailetContext.html" title="interface in org.apache.mailet">MailetContext</A>
-<DD>Returns the postmaster's address for this mailet context.
+<DD>Returns the Postmaster address for this mailet context.
<DT><A HREF="./org/apache/mailet/Mail.html#getRecipients()"><B>getRecipients()</B></A> -
Method in interface org.apache.mailet.<A HREF="./org/apache/mailet/Mail.html" title="interface in org.apache.mailet">Mail</A>
-<DD>Returns a Collection of MailAddress objects that are recipients of this message
+<DD>Returns the message recipients as a Collection of MailAddress objects,
+ as specified by the SMTP "RCPT TO" command, or internally defined.
<DT><A HREF="./org/apache/mailet/Mail.html#getRemoteAddr()"><B>getRemoteAddr()</B></A> -
Method in interface org.apache.mailet.<A HREF="./org/apache/mailet/Mail.html" title="interface in org.apache.mailet">Mail</A>
-<DD>The remote ip address of the server that connected to send this message
+<DD>Returns the IP address of the remote server that sent this message.
<DT><A HREF="./org/apache/mailet/Mail.html#getRemoteHost()"><B>getRemoteHost()</B></A> -
Method in interface org.apache.mailet.<A HREF="./org/apache/mailet/Mail.html" title="interface in org.apache.mailet">Mail</A>
-<DD>The remote hostname of the server that connected to send this message
+<DD>Returns the host name of the remote server that sent this message.
<DT><A HREF="./org/apache/mailet/Mail.html#getSender()"><B>getSender()</B></A> -
Method in interface org.apache.mailet.<A HREF="./org/apache/mailet/Mail.html" title="interface in org.apache.mailet">Mail</A>
-<DD>The sender of the message, as specified by the MAIL FROM header, or internally defined
+<DD>Returns the sender of the message, as specified by the SMTP "MAIL FROM" command,
+ or internally defined.
<DT><A HREF="./org/apache/mailet/MailetContext.html#getServerInfo()"><B>getServerInfo()</B></A> -
Method in interface org.apache.mailet.<A HREF="./org/apache/mailet/MailetContext.html" title="interface in org.apache.mailet">MailetContext</A>
<DD>Returns the name and version of the mailet container on which
the mailet is running.
<DT><A HREF="./org/apache/mailet/MailetContext.html#getSMTPHostAddresses(java.lang.String)"><B>getSMTPHostAddresses(String)</B></A> -
Method in interface org.apache.mailet.<A HREF="./org/apache/mailet/MailetContext.html" title="interface in org.apache.mailet">MailetContext</A>
-<DD>Returns an Iterator over HostAddress, a specialized subclass of
- javax.mail.URLName, which provides location information for
- servers that are specified as mail handlers for the given
- hostname.
+<DD>Returns the SMTP host addresses specified as mail handlers for
+ the given domain name.
<DT><A HREF="./org/apache/mailet/Mail.html#getState()"><B>getState()</B></A> -
Method in interface org.apache.mailet.<A HREF="./org/apache/mailet/Mail.html" title="interface in org.apache.mailet">Mail</A>
-<DD>The current state of the message, such as GHOST, ERROR, or DEFAULT
+<DD>Returns the current state of the message, such as GHOST, ERROR or DEFAULT.
<DT><A HREF="./org/apache/mailet/MailAddress.html#getUser()"><B>getUser()</B></A> -
Method in class org.apache.mailet.<A HREF="./org/apache/mailet/MailAddress.html" title="class in org.apache.mailet">MailAddress</A>
-<DD><B>Deprecated.</B> <I>use getLocalPart() - name change to align with RFC2822 3.4.1. Addr-spec specification</I>
+<DD><B>Deprecated.</B> <I>use <A HREF="./org/apache/mailet/MailAddress.html#getLocalPart()"><CODE>MailAddress.getLocalPart()</CODE></A>, whose name was changed to
+ align with the RFC2822 3.4.1. addr-spec specification</I>
<DT><A HREF="./org/apache/mailet/Mail.html#GHOST"><B>GHOST</B></A> -
Static variable in interface org.apache.mailet.<A HREF="./org/apache/mailet/Mail.html" title="interface in org.apache.mailet">Mail</A>
<DD>
@@ -254,15 +255,14 @@
<DL>
<DT><A HREF="./org/apache/mailet/Mail.html#hasAttributes()"><B>hasAttributes()</B></A> -
Method in interface org.apache.mailet.<A HREF="./org/apache/mailet/Mail.html" title="interface in org.apache.mailet">Mail</A>
-<DD>
+<DD>Returns whether this Mail instance has any attributes set.
<DT><A HREF="./org/apache/mailet/MailAddress.html#hashCode()"><B>hashCode()</B></A> -
Method in class org.apache.mailet.<A HREF="./org/apache/mailet/MailAddress.html" title="class in org.apache.mailet">MailAddress</A>
-<DD>Return a hashCode for this object which should be identical for addresses
- which are equivalent.
-<DT><A HREF="./org/apache/mailet/HostAddress.html" title="class in org.apache.mailet"><B>HostAddress</B></A> - Class in <A HREF="./org/apache/mailet/package-summary.html">org.apache.mailet</A><DD>A specialized subclass of javax.mail.URLName, which provides location
- information for servers.<DT><A HREF="./org/apache/mailet/HostAddress.html#HostAddress(java.lang.String, java.lang.String)"><B>HostAddress(String, String)</B></A> -
+<DD>Returns a hash code value for this object.
+<DT><A HREF="./org/apache/mailet/HostAddress.html" title="class in org.apache.mailet"><B>HostAddress</B></A> - Class in <A HREF="./org/apache/mailet/package-summary.html">org.apache.mailet</A><DD>A specialized subclass of javax.mail.URLName, which provides
+ the name of a URL as well as its corresponding host name.<DT><A HREF="./org/apache/mailet/HostAddress.html#HostAddress(java.lang.String, java.lang.String)"><B>HostAddress(String, String)</B></A> -
Constructor for class org.apache.mailet.<A HREF="./org/apache/mailet/HostAddress.html" title="class in org.apache.mailet">HostAddress</A>
-<DD>
+<DD>Constructs a new host address with the given details.
</DL>
<HR>
<A NAME="_I_"><!-- --></A><H2>
@@ -270,21 +270,19 @@
<DL>
<DT><A HREF="./org/apache/mailet/Mailet.html#init(org.apache.mailet.MailetConfig)"><B>init(MailetConfig)</B></A> -
Method in interface org.apache.mailet.<A HREF="./org/apache/mailet/Mailet.html" title="interface in org.apache.mailet">Mailet</A>
-<DD>Called by the mailet container to indicate to a mailet that the
- mailet is being placed into service.
+<DD>Initializes this Mailet.
<DT><A HREF="./org/apache/mailet/Matcher.html#init(org.apache.mailet.MatcherConfig)"><B>init(MatcherConfig)</B></A> -
Method in interface org.apache.mailet.<A HREF="./org/apache/mailet/Matcher.html" title="interface in org.apache.mailet">Matcher</A>
-<DD>Called by the mailet container to indicate to a matcher that the
- matcher is being placed into service.
+<DD>Initializes this Matcher.
<DT><A HREF="./org/apache/mailet/MailetContext.html#isLocalEmail(org.apache.mailet.MailAddress)"><B>isLocalEmail(MailAddress)</B></A> -
Method in interface org.apache.mailet.<A HREF="./org/apache/mailet/MailetContext.html" title="interface in org.apache.mailet">MailetContext</A>
-<DD>Checks if a user account is exists in the mail context.
+<DD>Checks if an address is local, i.e.
<DT><A HREF="./org/apache/mailet/MailetContext.html#isLocalServer(java.lang.String)"><B>isLocalServer(String)</B></A> -
Method in interface org.apache.mailet.<A HREF="./org/apache/mailet/MailetContext.html" title="interface in org.apache.mailet">MailetContext</A>
-<DD>Checks if a server is serviced by mail context
+<DD>Checks if a host name is local, i.e.
<DT><A HREF="./org/apache/mailet/MailetContext.html#isLocalUser(java.lang.String)"><B>isLocalUser(String)</B></A> -
Method in interface org.apache.mailet.<A HREF="./org/apache/mailet/MailetContext.html" title="interface in org.apache.mailet">MailetContext</A>
-<DD><B>Deprecated.</B> <I>use isLocalEmail(MailAddress) instead</I>
+<DD><B>Deprecated.</B> <I>use <A HREF="./org/apache/mailet/MailetContext.html#isLocalEmail(org.apache.mailet.MailAddress)"><CODE>MailetContext.isLocalEmail(MailAddress)</CODE></A> instead</I>
</DL>
<HR>
<A NAME="_L_"><!-- --></A><H2>
@@ -292,34 +290,30 @@
<DL>
<DT><A HREF="./org/apache/mailet/MailetContext.html#log(java.lang.String)"><B>log(String)</B></A> -
Method in interface org.apache.mailet.<A HREF="./org/apache/mailet/MailetContext.html" title="interface in org.apache.mailet">MailetContext</A>
-<DD>Writes the specified message to a mailet log file, usually an event
- log.
+<DD>Writes the specified message to a mailet log.
<DT><A HREF="./org/apache/mailet/MailetContext.html#log(java.lang.String, java.lang.Throwable)"><B>log(String, Throwable)</B></A> -
Method in interface org.apache.mailet.<A HREF="./org/apache/mailet/MailetContext.html" title="interface in org.apache.mailet">MailetContext</A>
-<DD>Writes an explanatory message and a stack trace for a given Throwable
- exception to the mailet log file.
+<DD>Writes the specified message to a mailet log, along with the stack
+ trace of the given Throwable.
</DL>
<HR>
<A NAME="_M_"><!-- --></A><H2>
<B>M</B></H2>
<DL>
-<DT><A HREF="./org/apache/mailet/Mail.html" title="interface in org.apache.mailet"><B>Mail</B></A> - Interface in <A HREF="./org/apache/mailet/package-summary.html">org.apache.mailet</A><DD>Wrap a MimeMessage with routing information (from SMTP) such
- as SMTP specified recipients, sender, and ip address and hostname
- of sending server.<DT><A HREF="./org/apache/mailet/MailAddress.html" title="class in org.apache.mailet"><B>MailAddress</B></A> - Class in <A HREF="./org/apache/mailet/package-summary.html">org.apache.mailet</A><DD>A representation of an email address.<DT><A HREF="./org/apache/mailet/MailAddress.html#MailAddress(java.lang.String)"><B>MailAddress(String)</B></A> -
+<DT><A HREF="./org/apache/mailet/Mail.html" title="interface in org.apache.mailet"><B>Mail</B></A> - Interface in <A HREF="./org/apache/mailet/package-summary.html">org.apache.mailet</A><DD>Wraps a MimeMessage with additional routing and processing information.<DT><A HREF="./org/apache/mailet/MailAddress.html" title="class in org.apache.mailet"><B>MailAddress</B></A> - Class in <A HREF="./org/apache/mailet/package-summary.html">org.apache.mailet</A><DD>A representation of an email address.<DT><A HREF="./org/apache/mailet/MailAddress.html#MailAddress(java.lang.String)"><B>MailAddress(String)</B></A> -
Constructor for class org.apache.mailet.<A HREF="./org/apache/mailet/MailAddress.html" title="class in org.apache.mailet">MailAddress</A>
-<DD>Construct a MailAddress parsing the provided <code>String</code> object.
+<DD>Constructs a MailAddress by parsing the provided address.
<DT><A HREF="./org/apache/mailet/MailAddress.html#MailAddress(java.lang.String, java.lang.String)"><B>MailAddress(String, String)</B></A> -
Constructor for class org.apache.mailet.<A HREF="./org/apache/mailet/MailAddress.html" title="class in org.apache.mailet">MailAddress</A>
-<DD>Construct a MailAddress with the provided personal name and email
- address.
+<DD>Constructs a MailAddress with the provided local part and domain.
<DT><A HREF="./org/apache/mailet/MailAddress.html#MailAddress(javax.mail.internet.InternetAddress)"><B>MailAddress(InternetAddress)</B></A> -
Constructor for class org.apache.mailet.<A HREF="./org/apache/mailet/MailAddress.html" title="class in org.apache.mailet">MailAddress</A>
-<DD>Constructs a MailAddress from a JavaMail InternetAddress, using only the
- email address portion, discarding the personal name.
-<DT><A HREF="./org/apache/mailet/Mailet.html" title="interface in org.apache.mailet"><B>Mailet</B></A> - Interface in <A HREF="./org/apache/mailet/package-summary.html">org.apache.mailet</A><DD>Draft of a Mailet inteface.<DT><A HREF="./org/apache/mailet/MailetConfig.html" title="interface in org.apache.mailet"><B>MailetConfig</B></A> - Interface in <A HREF="./org/apache/mailet/package-summary.html">org.apache.mailet</A><DD>A mailet configuration object used by a mailet container to pass information
- to a mailet during initialization.<DT><A HREF="./org/apache/mailet/MailetContext.html" title="interface in org.apache.mailet"><B>MailetContext</B></A> - Interface in <A HREF="./org/apache/mailet/package-summary.html">org.apache.mailet</A><DD>Defines a set of methods that a mailet or matcher uses to communicate
- with its mailet container, for example, to send a new message, to
- deliver a message locally, or write to a log file.<DT><A HREF="./org/apache/mailet/MailetException.html" title="class in org.apache.mailet"><B>MailetException</B></A> - Exception in <A HREF="./org/apache/mailet/package-summary.html">org.apache.mailet</A><DD>Defines a general exception a mailet can throw when it encounters difficulty.<DT><A HREF="./org/apache/mailet/MailetException.html#MailetException()"><B>MailetException()</B></A> -
+<DD>Constructs a MailAddress from an InternetAddress, using only the
+ email address portion (an "addr-spec", not "name-addr", as
+ defined in the RFC2822 3.4.
+<DT><A HREF="./org/apache/mailet/Mailet.html" title="interface in org.apache.mailet"><B>Mailet</B></A> - Interface in <A HREF="./org/apache/mailet/package-summary.html">org.apache.mailet</A><DD>A Mailet processes mail messages.<DT><A HREF="./org/apache/mailet/MailetConfig.html" title="interface in org.apache.mailet"><B>MailetConfig</B></A> - Interface in <A HREF="./org/apache/mailet/package-summary.html">org.apache.mailet</A><DD>A mailet configuration object used by the mailet container to pass
+ information to a mailet during initialization.<DT><A HREF="./org/apache/mailet/MailetContext.html" title="interface in org.apache.mailet"><B>MailetContext</B></A> - Interface in <A HREF="./org/apache/mailet/package-summary.html">org.apache.mailet</A><DD>Defines a set of methods that can be used to interact with the mailet
+ container.<DT><A HREF="./org/apache/mailet/MailetException.html" title="class in org.apache.mailet"><B>MailetException</B></A> - Exception in <A HREF="./org/apache/mailet/package-summary.html">org.apache.mailet</A><DD>Defines a general exception a mailet can throw when it encounters difficulty.<DT><A HREF="./org/apache/mailet/MailetException.html#MailetException()"><B>MailetException()</B></A> -
Constructor for exception org.apache.mailet.<A HREF="./org/apache/mailet/MailetException.html" title="class in org.apache.mailet">MailetException</A>
<DD>Constructs a new mailet exception.
<DT><A HREF="./org/apache/mailet/MailetException.html#MailetException(java.lang.String)"><B>MailetException(String)</B></A> -
@@ -327,35 +321,33 @@
<DD>Constructs a new mailet exception with the specified message.
<DT><A HREF="./org/apache/mailet/MailetException.html#MailetException(java.lang.String, java.lang.Exception)"><B>MailetException(String, Exception)</B></A> -
Constructor for exception org.apache.mailet.<A HREF="./org/apache/mailet/MailetException.html" title="class in org.apache.mailet">MailetException</A>
-<DD>Constructs a new mailet exception when the mailet needs to throw
- an exception and include a message about the "root cause" exception
- that interfered with its normal operation, including a description
- message.
+<DD>Constructs a new mailet exception with the specified message
+ and an exception which is the "root cause" of the exception.
<DT><A HREF="./org/apache/mailet/Matcher.html#match(org.apache.mailet.Mail)"><B>match(Mail)</B></A> -
Method in interface org.apache.mailet.<A HREF="./org/apache/mailet/Matcher.html" title="interface in org.apache.mailet">Matcher</A>
-<DD>Takes a Mail message, looks at any pertinent information, and then returns a subset
- of recipients that meet the "match" conditions.
-<DT><A HREF="./org/apache/mailet/Matcher.html" title="interface in org.apache.mailet"><B>Matcher</B></A> - Interface in <A HREF="./org/apache/mailet/package-summary.html">org.apache.mailet</A><DD>This interface define the behaviour of the message "routing" inside
- the mailet container.<DT><A HREF="./org/apache/mailet/MatcherConfig.html" title="interface in org.apache.mailet"><B>MatcherConfig</B></A> - Interface in <A HREF="./org/apache/mailet/package-summary.html">org.apache.mailet</A><DD>A matcher configuration object used by a mailet container used to pass information
- to a matcher during initialization.</DL>
+<DD>Takes a Mail message, looks at any pertinent information, and returns
+ a subset of recipients that meet the match conditions.
+<DT><A HREF="./org/apache/mailet/Matcher.html" title="interface in org.apache.mailet"><B>Matcher</B></A> - Interface in <A HREF="./org/apache/mailet/package-summary.html">org.apache.mailet</A><DD>This interface defines the behaviour of the message "routing" inside
+ the mailet container.<DT><A HREF="./org/apache/mailet/MatcherConfig.html" title="interface in org.apache.mailet"><B>MatcherConfig</B></A> - Interface in <A HREF="./org/apache/mailet/package-summary.html">org.apache.mailet</A><DD>A matcher configuration object used by the mailet container to pass
+ information to a matcher during initialization.</DL>
<HR>
<A NAME="_O_"><!-- --></A><H2>
<B>O</B></H2>
<DL>
-<DT><A HREF="./org/apache/mailet/package-summary.html"><B>org.apache.mailet</B></A> - package org.apache.mailet<DD>The classes that constitute the Mailet API.</DL>
+<DT><A HREF="./org/apache/mailet/package-summary.html"><B>org.apache.mailet</B></A> - package org.apache.mailet<DD>This package constitutes the Mailet API.</DL>
<HR>
<A NAME="_R_"><!-- --></A><H2>
<B>R</B></H2>
<DL>
<DT><A HREF="./org/apache/mailet/Mail.html#removeAllAttributes()"><B>removeAllAttributes()</B></A> -
Method in interface org.apache.mailet.<A HREF="./org/apache/mailet/Mail.html" title="interface in org.apache.mailet">Mail</A>
-<DD>Removes all the attributes associated with this Mail instance.
+<DD>Removes all attributes associated with this Mail instance.
<DT><A HREF="./org/apache/mailet/Mail.html#removeAttribute(java.lang.String)"><B>removeAttribute(String)</B></A> -
Method in interface org.apache.mailet.<A HREF="./org/apache/mailet/Mail.html" title="interface in org.apache.mailet">Mail</A>
<DD>Removes the attribute with the given name from this Mail instance.
<DT><A HREF="./org/apache/mailet/MailetContext.html#removeAttribute(java.lang.String)"><B>removeAttribute(String)</B></A> -
Method in interface org.apache.mailet.<A HREF="./org/apache/mailet/MailetContext.html" title="interface in org.apache.mailet">MailetContext</A>
-<DD>Removes the attribute with the given name from the mailet context.
+<DD>Removes the attribute with the given name from this Mail instance.
</DL>
<HR>
<A NAME="_S_"><!-- --></A><H2>
@@ -363,46 +355,47 @@
<DL>
<DT><A HREF="./org/apache/mailet/MailetContext.html#sendMail(javax.mail.internet.MimeMessage)"><B>sendMail(MimeMessage)</B></A> -
Method in interface org.apache.mailet.<A HREF="./org/apache/mailet/MailetContext.html" title="interface in org.apache.mailet">MailetContext</A>
-<DD>Send an outgoing message to the top of this mailet container's root queue.
+<DD>Sends an outgoing message to the top of this mailet container's root queue.
<DT><A HREF="./org/apache/mailet/MailetContext.html#sendMail(org.apache.mailet.MailAddress, java.util.Collection, javax.mail.internet.MimeMessage)"><B>sendMail(MailAddress, Collection, MimeMessage)</B></A> -
Method in interface org.apache.mailet.<A HREF="./org/apache/mailet/MailetContext.html" title="interface in org.apache.mailet">MailetContext</A>
-<DD>Send an outgoing message to the top of this mailet container's root queue.
+<DD>Sends an outgoing message to the top of this mailet container's root queue.
<DT><A HREF="./org/apache/mailet/MailetContext.html#sendMail(org.apache.mailet.MailAddress, java.util.Collection, javax.mail.internet.MimeMessage, java.lang.String)"><B>sendMail(MailAddress, Collection, MimeMessage, String)</B></A> -
Method in interface org.apache.mailet.<A HREF="./org/apache/mailet/MailetContext.html" title="interface in org.apache.mailet">MailetContext</A>
-<DD>Send an outgoing message to the top of this mailet container queue for the
- appropriate processor that is specified.
+<DD>Sends an outgoing message to the top of this mailet container's queue for the
+ specified processor.
<DT><A HREF="./org/apache/mailet/MailetContext.html#sendMail(org.apache.mailet.Mail)"><B>sendMail(Mail)</B></A> -
Method in interface org.apache.mailet.<A HREF="./org/apache/mailet/MailetContext.html" title="interface in org.apache.mailet">MailetContext</A>
-<DD>Send an outgoing message to the top of this mailet container's root queue.
+<DD>Sends an outgoing message to the top of this mailet container's root queue.
<DT><A HREF="./org/apache/mailet/MailAddress.html#serialVersionUID"><B>serialVersionUID</B></A> -
Static variable in class org.apache.mailet.<A HREF="./org/apache/mailet/MailAddress.html" title="class in org.apache.mailet">MailAddress</A>
<DD>We hardcode the serialVersionUID
- 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.
+ 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.
<DT><A HREF="./org/apache/mailet/Mailet.html#service(org.apache.mailet.Mail)"><B>service(Mail)</B></A> -
Method in interface org.apache.mailet.<A HREF="./org/apache/mailet/Mailet.html" title="interface in org.apache.mailet">Mailet</A>
-<DD>Called by the mailet container to allow the mailet to process to
- a message.
+<DD>Services a mail message.
<DT><A HREF="./org/apache/mailet/Mail.html#setAttribute(java.lang.String, java.io.Serializable)"><B>setAttribute(String, Serializable)</B></A> -
Method in interface org.apache.mailet.<A HREF="./org/apache/mailet/Mail.html" title="interface in org.apache.mailet">Mail</A>
-<DD>Binds an object to a given attribute name in this Mail instance.
+<DD>Associates an attribute with the given name and value with this Mail instance.
<DT><A HREF="./org/apache/mailet/MailetContext.html#setAttribute(java.lang.String, java.lang.Object)"><B>setAttribute(String, Object)</B></A> -
Method in interface org.apache.mailet.<A HREF="./org/apache/mailet/MailetContext.html" title="interface in org.apache.mailet">MailetContext</A>
-<DD>Binds an object to a given attribute name in this mailet context.
+<DD>Associates an attribute with the given name and value with this mailet context.
<DT><A HREF="./org/apache/mailet/Mail.html#setErrorMessage(java.lang.String)"><B>setErrorMessage(String)</B></A> -
Method in interface org.apache.mailet.<A HREF="./org/apache/mailet/Mail.html" title="interface in org.apache.mailet">Mail</A>
<DD>Sets the error message associated with this message.
<DT><A HREF="./org/apache/mailet/Mail.html#setLastUpdated(java.util.Date)"><B>setLastUpdated(Date)</B></A> -
Method in interface org.apache.mailet.<A HREF="./org/apache/mailet/Mail.html" title="interface in org.apache.mailet">Mail</A>
-<DD>
+<DD>Sets the time at which this Mail was last updated.
<DT><A HREF="./org/apache/mailet/Mail.html#setMessage(javax.mail.internet.MimeMessage)"><B>setMessage(MimeMessage)</B></A> -
Method in interface org.apache.mailet.<A HREF="./org/apache/mailet/Mail.html" title="interface in org.apache.mailet">Mail</A>
-<DD>Sets the MimeMessage associated with this message via the object.
+<DD>Sets the MimeMessage wrapped by this Mail instance.
<DT><A HREF="./org/apache/mailet/Mail.html#setName(java.lang.String)"><B>setName(String)</B></A> -
Method in interface org.apache.mailet.<A HREF="./org/apache/mailet/Mail.html" title="interface in org.apache.mailet">Mail</A>
-<DD>Set the message name of this message
+<DD>Set the name of this message.
<DT><A HREF="./org/apache/mailet/Mail.html#setRecipients(java.util.Collection)"><B>setRecipients(Collection)</B></A> -
Method in interface org.apache.mailet.<A HREF="./org/apache/mailet/Mail.html" title="interface in org.apache.mailet">Mail</A>
-<DD>Method setRecipients.
+<DD>Sets the message recipients as a Collection of MailAddress objects.
<DT><A HREF="./org/apache/mailet/Mail.html#setState(java.lang.String)"><B>setState(String)</B></A> -
Method in interface org.apache.mailet.<A HREF="./org/apache/mailet/Mail.html" title="interface in org.apache.mailet">Mail</A>
<DD>Sets the state of this message.
@@ -417,7 +410,8 @@
<DL>
<DT><A HREF="./org/apache/mailet/MailAddress.html#toInternetAddress()"><B>toInternetAddress()</B></A> -
Method in class org.apache.mailet.<A HREF="./org/apache/mailet/MailAddress.html" title="class in org.apache.mailet">MailAddress</A>
-<DD>Return MailAddress as InternetAddress
+<DD>Returns an InternetAddress representing the same address
+ as this MailAddress.
<DT><A HREF="./org/apache/mailet/MailAddress.html#toString()"><B>toString()</B></A> -
Method in class org.apache.mailet.<A HREF="./org/apache/mailet/MailAddress.html" title="class in org.apache.mailet">MailAddress</A>
<DD>
Modified: james/site/trunk/www/mailet/api/apidocs/index.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/mailet/api/apidocs/index.html?rev=800330&r1=800329&r2=800330&view=diff
==============================================================================
--- james/site/trunk/www/mailet/api/apidocs/index.html (original)
+++ james/site/trunk/www/mailet/api/apidocs/index.html Mon Aug 3 12:18:51 2009
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc on Thu May 28 11:11:02 BST 2009-->
+<!-- Generated by javadoc on Mon Aug 03 13:36:27 BST 2009-->
<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<TITLE>
Apache Mailet API 2.5-SNAPSHOT API
Modified: james/site/trunk/www/mailet/api/apidocs/org/apache/mailet/HostAddress.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/mailet/api/apidocs/org/apache/mailet/HostAddress.html?rev=800330&r1=800329&r2=800330&view=diff
==============================================================================
--- james/site/trunk/www/mailet/api/apidocs/org/apache/mailet/HostAddress.html (original)
+++ james/site/trunk/www/mailet/api/apidocs/org/apache/mailet/HostAddress.html Mon Aug 3 12:18:51 2009
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.5.0_18) on Thu May 28 11:11:01 BST 2009 -->
+<!-- Generated by javadoc (build 1.5.0_18) on Mon Aug 03 13:36:26 BST 2009 -->
<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<TITLE>
HostAddress (Apache Mailet API 2.5-SNAPSHOT API)
@@ -99,14 +99,14 @@
</PRE>
<P>
-A specialized subclass of javax.mail.URLName, which provides location
- information for servers.
+A specialized subclass of javax.mail.URLName, which provides
+ the name of a URL as well as its corresponding host name.
<P>
<P>
<DL>
<DT><B>Since:</B></DT>
- <DD>Mailet API v2.2.0a16-unstable</DD>
+ <DD>Mailet API v2.3</DD>
</DL>
<HR>
@@ -143,7 +143,7 @@
java.lang.String url)</CODE>
<BR>
- </TD>
+ Constructs a new host address with the given details.</TD>
</TR>
</TABLE>
@@ -161,7 +161,7 @@
<TD><CODE><B><A HREF="../../../org/apache/mailet/HostAddress.html#getHostName()">getHostName</A></B>()</CODE>
<BR>
- </TD>
+ Returns the host name corresponding to the url</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_javax.mail.URLName"><!-- --></A>
@@ -201,6 +201,10 @@
public <B>HostAddress</B>(java.lang.String hostname,
java.lang.String url)</PRE>
<DL>
+<DD>Constructs a new host address with the given details.
+<P>
+<DL>
+<DT><B>Parameters:</B><DD><CODE>hostname</CODE> - the hostname corresponding to the url<DD><CODE>url</CODE> - the url name</DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
@@ -218,8 +222,11 @@
<PRE>
public java.lang.String <B>getHostName</B>()</PRE>
<DL>
+<DD>Returns the host name corresponding to the url
+<P>
<DD><DL>
-</DL>
+
+<DT><B>Returns:</B><DD>the host name</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
Modified: james/site/trunk/www/mailet/api/apidocs/org/apache/mailet/Mail.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/mailet/api/apidocs/org/apache/mailet/Mail.html?rev=800330&r1=800329&r2=800330&view=diff
==============================================================================
--- james/site/trunk/www/mailet/api/apidocs/org/apache/mailet/Mail.html (original)
+++ james/site/trunk/www/mailet/api/apidocs/org/apache/mailet/Mail.html Mon Aug 3 12:18:51 2009
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.5.0_18) on Thu May 28 11:11:01 BST 2009 -->
+<!-- Generated by javadoc (build 1.5.0_18) on Mon Aug 03 13:36:26 BST 2009 -->
<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<TITLE>
Mail (Apache Mailet API 2.5-SNAPSHOT API)
@@ -97,18 +97,46 @@
</PRE>
<P>
-Wrap a MimeMessage with routing information (from SMTP) such
- as SMTP specified recipients, sender, and ip address and hostname
- of sending server. It also contains its state which represents
- which processor in the mailet container it is currently running.
- Special processor names are "root" and "error".
+<p>Wraps a MimeMessage with additional routing and processing information.
+ <p>This includes
+ <ul>
+ <li>a unique name</li>
+ <li>envelope properties such the SMTP-specified sender ("MAIL FROM") and recipients ("RCPT TO")</li>
+ <li>the IP address and hostname of the sending server</li>
+ <li>the processing state, which also represents the processor in
+ the mailet container which is currently processing the message</li>
+ <li>the time at which the Mail was last updated</li>
+ <li>additional processing attributes (see below)</li>
+ </ul>
+ <p>
+ The Mail interface also defines constants for special processor names,
+ such as "root" and "error".
+ <p>
+ <b>Mail Attributes</b>
+ <p>
+ While processing a Mail instance, a Mailet can associate additional
+ information with it by using mail attributes. These attributes can
+ then be queried by the same mailet or other mailets later on.
+ <p>
+ Some containers may also use attributes to provide envelope information.
+ <p>
+ Every attribute consists of a name and a value.
+ Attribute names should follow the same convention as package names.
+ The Mailet API specification reserves names matching
+ <i>org.apache.james.*</i> and <i>org.apache.mailet.*</i>.
+ <p>
+ Attribute values can be arbitrary objects, but since Mail is
+ Serializable, the attribute value must be Serializable as well.
+ <p>
+ The list of attributes which are currently associated with a Mail
+ instance can be retrieved using the <A HREF="../../../org/apache/mailet/Mail.html#getAttributeNames()"><CODE>getAttributeNames()</CODE></A>
+ method, and given its name, the value of an attribute can be
+ retrieved using the <A HREF="../../../org/apache/mailet/Mail.html#getAttribute(java.lang.String)"><CODE>getAttribute(java.lang.String)</CODE></A> method. It is also
+ possible to remove <A HREF="../../../org/apache/mailet/Mail.html#removeAttribute(java.lang.String)"><CODE>one</CODE></A> attribute or
+ <A HREF="../../../org/apache/mailet/Mail.html#removeAllAttributes()"><CODE>all</CODE></A> attributes of a Mail instance.
<P>
<P>
-<DL>
-<DT><B>Version:</B></DT>
- <DD>CVS $Revision: 534853 $ $Date: 2007-05-03 14:39:16 +0100 (Thu, 03 May 2007) $</DD>
-</DL>
<HR>
<P>
@@ -168,8 +196,8 @@
<TD><CODE><B><A HREF="../../../org/apache/mailet/Mail.html#getAttribute(java.lang.String)">getAttribute</A></B>(java.lang.String name)</CODE>
<BR>
- Returns the Mail session attribute with the given name, or null
- if there is no attribute by that name.</TD>
+ Returns the value of the named Mail instance attribute,
+ or null if the attribute does not exist.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -177,8 +205,8 @@
<TD><CODE><B><A HREF="../../../org/apache/mailet/Mail.html#getAttributeNames()">getAttributeNames</A></B>()</CODE>
<BR>
- Returns an Iterator containing the attribute names currently available within
- this Mail instance.</TD>
+ Returns an Iterator over the names of all attributes which are set
+ in this Mail instance.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -194,7 +222,7 @@
<TD><CODE><B><A HREF="../../../org/apache/mailet/Mail.html#getLastUpdated()">getLastUpdated</A></B>()</CODE>
<BR>
- </TD>
+ Returns the time at which this Mail was last updated.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -202,7 +230,7 @@
<TD><CODE><B><A HREF="../../../org/apache/mailet/Mail.html#getMessage()">getMessage</A></B>()</CODE>
<BR>
- Returns the MimeMessage stored in this message</TD>
+ Returns the MimeMessage stored in this message.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -210,7 +238,7 @@
<TD><CODE><B><A HREF="../../../org/apache/mailet/Mail.html#getMessageSize()">getMessageSize</A></B>()</CODE>
<BR>
- </TD>
+ Returns the message size (including headers).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -218,7 +246,7 @@
<TD><CODE><B><A HREF="../../../org/apache/mailet/Mail.html#getName()">getName</A></B>()</CODE>
<BR>
- Returns the message name of this message</TD>
+ Returns the name of this message.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -226,7 +254,8 @@
<TD><CODE><B><A HREF="../../../org/apache/mailet/Mail.html#getRecipients()">getRecipients</A></B>()</CODE>
<BR>
- Returns a Collection of MailAddress objects that are recipients of this message</TD>
+ Returns the message recipients as a Collection of MailAddress objects,
+ as specified by the SMTP "RCPT TO" command, or internally defined.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -234,7 +263,7 @@
<TD><CODE><B><A HREF="../../../org/apache/mailet/Mail.html#getRemoteAddr()">getRemoteAddr</A></B>()</CODE>
<BR>
- The remote ip address of the server that connected to send this message</TD>
+ Returns the IP address of the remote server that sent this message.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -242,7 +271,7 @@
<TD><CODE><B><A HREF="../../../org/apache/mailet/Mail.html#getRemoteHost()">getRemoteHost</A></B>()</CODE>
<BR>
- The remote hostname of the server that connected to send this message</TD>
+ Returns the host name of the remote server that sent this message.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -250,7 +279,8 @@
<TD><CODE><B><A HREF="../../../org/apache/mailet/Mail.html#getSender()">getSender</A></B>()</CODE>
<BR>
- The sender of the message, as specified by the MAIL FROM header, or internally defined</TD>
+ Returns the sender of the message, as specified by the SMTP "MAIL FROM" command,
+ or internally defined.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -258,7 +288,7 @@
<TD><CODE><B><A HREF="../../../org/apache/mailet/Mail.html#getState()">getState</A></B>()</CODE>
<BR>
- The current state of the message, such as GHOST, ERROR, or DEFAULT</TD>
+ Returns the current state of the message, such as GHOST, ERROR or DEFAULT.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -266,7 +296,7 @@
<TD><CODE><B><A HREF="../../../org/apache/mailet/Mail.html#hasAttributes()">hasAttributes</A></B>()</CODE>
<BR>
- </TD>
+ Returns whether this Mail instance has any attributes set.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -274,7 +304,7 @@
<TD><CODE><B><A HREF="../../../org/apache/mailet/Mail.html#removeAllAttributes()">removeAllAttributes</A></B>()</CODE>
<BR>
- Removes all the attributes associated with this Mail instance.</TD>
+ Removes all attributes associated with this Mail instance.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -291,7 +321,7 @@
java.io.Serializable object)</CODE>
<BR>
- Binds an object to a given attribute name in this Mail instance.</TD>
+ Associates an attribute with the given name and value with this Mail instance.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -307,7 +337,7 @@
<TD><CODE><B><A HREF="../../../org/apache/mailet/Mail.html#setLastUpdated(java.util.Date)">setLastUpdated</A></B>(java.util.Date lastUpdated)</CODE>
<BR>
- </TD>
+ Sets the time at which this Mail was last updated.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -315,7 +345,7 @@
<TD><CODE><B><A HREF="../../../org/apache/mailet/Mail.html#setMessage(javax.mail.internet.MimeMessage)">setMessage</A></B>(javax.mail.internet.MimeMessage message)</CODE>
<BR>
- Sets the MimeMessage associated with this message via the object.</TD>
+ Sets the MimeMessage wrapped by this Mail instance.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -323,7 +353,7 @@
<TD><CODE><B><A HREF="../../../org/apache/mailet/Mail.html#setName(java.lang.String)">setName</A></B>(java.lang.String newName)</CODE>
<BR>
- Set the message name of this message</TD>
+ Set the name of this message.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -331,7 +361,7 @@
<TD><CODE><B><A HREF="../../../org/apache/mailet/Mail.html#setRecipients(java.util.Collection)">setRecipients</A></B>(java.util.Collection recipients)</CODE>
<BR>
- Method setRecipients.</TD>
+ Sets the message recipients as a Collection of MailAddress objects.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -409,7 +439,7 @@
<PRE>
java.lang.String <B>getName</B>()</PRE>
<DL>
-<DD>Returns the message name of this message
+<DD>Returns the name of this message.
<P>
<DD><DL>
</DL>
@@ -428,13 +458,13 @@
<PRE>
void <B>setName</B>(java.lang.String newName)</PRE>
<DL>
-<DD>Set the message name of this message
+<DD>Set the name of this message.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>newName</CODE> - new name<DT><B>Since:</B></DT>
+<DT><B>Parameters:</B><DD><CODE>newName</CODE> - the new message name<DT><B>Since:</B></DT>
<DD>Mailet API v2.3</DD>
</DL>
</DD>
@@ -447,7 +477,7 @@
javax.mail.internet.MimeMessage <B>getMessage</B>()
throws javax.mail.MessagingException</PRE>
<DL>
-<DD>Returns the MimeMessage stored in this message
+<DD>Returns the MimeMessage stored in this message.
<P>
<DD><DL>
</DL>
@@ -456,7 +486,7 @@
<DT><B>Returns:</B><DD>the MimeMessage that this Mail object wraps
<DT><B>Throws:</B>
-<DD><CODE>javax.mail.MessagingException</CODE> - - an error occured while loading this object</DL>
+<DD><CODE>javax.mail.MessagingException</CODE> - when an error occurs while retrieving the message</DL>
</DD>
</DL>
<HR>
@@ -466,7 +496,8 @@
<PRE>
java.util.Collection <B>getRecipients</B>()</PRE>
<DL>
-<DD>Returns a Collection of MailAddress objects that are recipients of this message
+<DD>Returns the message recipients as a Collection of MailAddress objects,
+ as specified by the SMTP "RCPT TO" command, or internally defined.
<P>
<DD><DL>
</DL>
@@ -483,14 +514,14 @@
<PRE>
void <B>setRecipients</B>(java.util.Collection recipients)</PRE>
<DL>
-<DD>Method setRecipients.
+<DD>Sets the message recipients as a Collection of MailAddress objects.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>recipients</CODE> - a Collection of MailAddress Objects representing the recipients of this message<DT><B>Since:</B></DT>
- <DD>Mailet API v3.0-unstable</DD>
+<DT><B>Parameters:</B><DD><CODE>recipients</CODE> - the message recipients as a Collection of MailAddress Objects<DT><B>Since:</B></DT>
+ <DD>Mailet API v2.4</DD>
</DL>
</DD>
</DL>
@@ -501,14 +532,15 @@
<PRE>
<A HREF="../../../org/apache/mailet/MailAddress.html" title="class in org.apache.mailet">MailAddress</A> <B>getSender</B>()</PRE>
<DL>
-<DD>The sender of the message, as specified by the MAIL FROM header, or internally defined
+<DD>Returns the sender of the message, as specified by the SMTP "MAIL FROM" command,
+ or internally defined.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
-<DT><B>Returns:</B><DD>a MailAddress of the sender of this message</DL>
+<DT><B>Returns:</B><DD>the sender of this message</DL>
</DD>
</DL>
<HR>
@@ -518,7 +550,7 @@
<PRE>
java.lang.String <B>getState</B>()</PRE>
<DL>
-<DD>The current state of the message, such as GHOST, ERROR, or DEFAULT
+<DD>Returns the current state of the message, such as GHOST, ERROR or DEFAULT.
<P>
<DD><DL>
</DL>
@@ -535,14 +567,14 @@
<PRE>
java.lang.String <B>getRemoteHost</B>()</PRE>
<DL>
-<DD>The remote hostname of the server that connected to send this message
+<DD>Returns the host name of the remote server that sent this message.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
-<DT><B>Returns:</B><DD>a String of the hostname of the server that connected to send this message</DL>
+<DT><B>Returns:</B><DD>the host name of the remote server that sent this message</DL>
</DD>
</DL>
<HR>
@@ -552,14 +584,14 @@
<PRE>
java.lang.String <B>getRemoteAddr</B>()</PRE>
<DL>
-<DD>The remote ip address of the server that connected to send this message
+<DD>Returns the IP address of the remote server that sent this message.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
-<DT><B>Returns:</B><DD>a String of the ip address of the server that connected to send this message</DL>
+<DT><B>Returns:</B><DD>the IP address of the remote server that sent this message</DL>
</DD>
</DL>
<HR>
@@ -569,14 +601,14 @@
<PRE>
java.lang.String <B>getErrorMessage</B>()</PRE>
<DL>
-<DD>The error message, if any, associated with this message. Not sure why this is needed.
+<DD>The error message, if any, associated with this message.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
-<DT><B>Returns:</B><DD>a String of a descriptive error message</DL>
+<DT><B>Returns:</B><DD>the error message associated with this message, or null</DL>
</DD>
</DL>
<HR>
@@ -586,13 +618,13 @@
<PRE>
void <B>setErrorMessage</B>(java.lang.String msg)</PRE>
<DL>
-<DD>Sets the error message associated with this message. Not sure why this is needed.
+<DD>Sets the error message associated with this message.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>msg</CODE> - - a descriptive error message</DL>
+<DT><B>Parameters:</B><DD><CODE>msg</CODE> - the error message</DL>
</DD>
</DL>
<HR>
@@ -602,13 +634,13 @@
<PRE>
void <B>setMessage</B>(javax.mail.internet.MimeMessage message)</PRE>
<DL>
-<DD>Sets the MimeMessage associated with this message via the object.
+<DD>Sets the MimeMessage wrapped by this Mail instance.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>message</CODE> - - the new MimeMessage that this Mail object will wrap</DL>
+<DT><B>Parameters:</B><DD><CODE>message</CODE> - the new message that this Mail instance will wrap</DL>
</DD>
</DL>
<HR>
@@ -624,7 +656,7 @@
</DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>state</CODE> - - the new state of this message</DL>
+<DT><B>Parameters:</B><DD><CODE>state</CODE> - the new state of this message</DL>
</DD>
</DL>
<HR>
@@ -634,24 +666,15 @@
<PRE>
java.io.Serializable <B>getAttribute</B>(java.lang.String name)</PRE>
<DL>
-<DD>Returns the Mail session attribute with the given name, or null
- if there is no attribute by that name.
- An attribute allows a mailet to give this Mail instance additional information
- not already provided by this interface.<p>
- A list of currently set attributes can be retrieved using getAttributeNames.
- <p>
- The attribute is returned as a java.lang.Object or some subclass. Attribute
- names should follow the same convention as package names. The Mailet API
- specification reserves names matching <I>org.apache.james.*</I>
- and <I>org.apache.mailet.*</I>.
+<DD>Returns the value of the named Mail instance attribute,
+ or null if the attribute does not exist.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>name</CODE> - - a String specifying the name of the attribute
-<DT><B>Returns:</B><DD>an Object containing the value of the attribute, or null if no attribute
- exists matching the given name<DT><B>Since:</B></DT>
+<DT><B>Parameters:</B><DD><CODE>name</CODE> - the attribute name
+<DT><B>Returns:</B><DD>the attribute value, or null if the attribute does not exist<DT><B>Since:</B></DT>
<DD>Mailet API v2.1</DD>
</DL>
</DD>
@@ -663,16 +686,18 @@
<PRE>
java.util.Iterator <B>getAttributeNames</B>()</PRE>
<DL>
-<DD>Returns an Iterator containing the attribute names currently available within
- this Mail instance. Use the getAttribute(java.lang.String) method with an
- attribute name to get the value of an attribute.
+<DD>Returns an Iterator over the names of all attributes which are set
+ in this Mail instance.
+ <p>
+ The <A HREF="../../../org/apache/mailet/Mail.html#getAttribute(java.lang.String)"><CODE>getAttribute(java.lang.String)</CODE></A> method can be called to
+ retrieve an attribute's value given its name.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
-<DT><B>Returns:</B><DD>an Iterator of attribute names<DT><B>Since:</B></DT>
+<DT><B>Returns:</B><DD>an Iterator (of Strings) over all attribute names<DT><B>Since:</B></DT>
<DD>Mailet API v2.1</DD>
</DL>
</DD>
@@ -684,12 +709,14 @@
<PRE>
boolean <B>hasAttributes</B>()</PRE>
<DL>
+<DD>Returns whether this Mail instance has any attributes set.
+<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
-<DT><B>Returns:</B><DD>true if this Mail instance has any attributes set.<DT><B>Since:</B></DT>
+<DT><B>Returns:</B><DD>true if this Mail instance has any attributes set, false if not<DT><B>Since:</B></DT>
<DD>Mailet API v2.1</DD>
</DL>
</DD>
@@ -701,18 +728,16 @@
<PRE>
java.io.Serializable <B>removeAttribute</B>(java.lang.String name)</PRE>
<DL>
-<DD>Removes the attribute with the given name from this Mail instance. After
- removal, subsequent calls to getAttribute(java.lang.String) to retrieve
- the attribute's value will return null.
+<DD>Removes the attribute with the given name from this Mail instance.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>name</CODE> - - a String specifying the name of the attribute to be removed
-<DT><B>Returns:</B><DD>previous attribute value associated with specified name, or null
- if there was no mapping for name (null can also mean that null
- was bound to the name)<DT><B>Since:</B></DT>
+<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the attribute to be removed
+<DT><B>Returns:</B><DD>the value of the removed attribute, or null
+ if there was no such attribute (or if the attribute existed
+ and its value was null)<DT><B>Since:</B></DT>
<DD>Mailet API v2.1</DD>
</DL>
</DD>
@@ -724,7 +749,7 @@
<PRE>
void <B>removeAllAttributes</B>()</PRE>
<DL>
-<DD>Removes all the attributes associated with this Mail instance.
+<DD>Removes all attributes associated with this Mail instance.
<P>
<DD><DL>
</DL>
@@ -743,23 +768,23 @@
java.io.Serializable <B>setAttribute</B>(java.lang.String name,
java.io.Serializable object)</PRE>
<DL>
-<DD>Binds an object to a given attribute name in this Mail instance. If the name
- specified is already used for an attribute, this method will remove the old
- attribute and bind the name to the new attribute.
- As instances of Mail is Serializable, it is necessary that the attributes being
- Serializable as well
+<DD>Associates an attribute with the given name and value with this Mail instance.
+ If an attribute with the given name already exists, it is replaced, and the
+ previous value is returned.
<p>
- Attribute names should follow the same convention as package names.
- The Mailet API specification reserves names matching <I>org.apache.james.*</I>
- and <I>org.apache.mailet.*</I>.
+ Conventionally, attribute names should follow the namespacing guidelines
+ for Java packages.
+ The Mailet API specification reserves names matching
+ <i>org.apache.james.*</i> and <i>org.apache.mailet.*</i>.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>name</CODE> - - a String specifying the name of the attribute<DD><CODE>object</CODE> - - a Serializable Object representing the attribute to be bound
-<DT><B>Returns:</B><DD>the object previously bound to the name, null if the name was
- not bound (null can also mean that null was bound to the name)<DT><B>Since:</B></DT>
+<DT><B>Parameters:</B><DD><CODE>name</CODE> - the attribute name<DD><CODE>object</CODE> - the attribute value
+<DT><B>Returns:</B><DD>the value of the previously existing attribute with the same name,
+ or null if there was no such attribute (or if the attribute existed
+ and its value was null)<DT><B>Since:</B></DT>
<DD>Mailet API v2.1</DD>
</DL>
</DD>
@@ -772,14 +797,23 @@
long <B>getMessageSize</B>()
throws javax.mail.MessagingException</PRE>
<DL>
+<DD>Returns the message size (including headers).
+ <p>
+ This is intended as a guide suitable for processing heuristics, and not
+ a precise indication of the number of outgoing bytes that would be produced
+ were the email to be encoded for transport.
+ In cases where an exact value is not readily available or is difficult to
+ determine (for example, when the fully transfer encoded message is not available)
+ a suitable estimate may be returned.
+<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
-<DT><B>Returns:</B><DD>message size
+<DT><B>Returns:</B><DD>the message size
<DT><B>Throws:</B>
-<DD><CODE>javax.mail.MessagingException</CODE><DT><B>Since:</B></DT>
+<DD><CODE>javax.mail.MessagingException</CODE> - when the size cannot be retrieved<DT><B>Since:</B></DT>
<DD>Mailet API v2.3</DD>
</DL>
</DD>
@@ -791,12 +825,14 @@
<PRE>
java.util.Date <B>getLastUpdated</B>()</PRE>
<DL>
+<DD>Returns the time at which this Mail was last updated.
+<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
-<DT><B>Returns:</B><DD>the last update date<DT><B>Since:</B></DT>
+<DT><B>Returns:</B><DD>the time at which this Mail was last updated<DT><B>Since:</B></DT>
<DD>Mailet API v2.3</DD>
</DL>
</DD>
@@ -808,11 +844,13 @@
<PRE>
void <B>setLastUpdated</B>(java.util.Date lastUpdated)</PRE>
<DL>
+<DD>Sets the time at which this Mail was last updated.
+<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>lastUpdated</CODE> - the new last updated date<DT><B>Since:</B></DT>
+<DT><B>Parameters:</B><DD><CODE>lastUpdated</CODE> - the time at which this Mail was last modified<DT><B>Since:</B></DT>
<DD>Mailet API v2.3</DD>
</DL>
</DD>
Modified: james/site/trunk/www/mailet/api/apidocs/org/apache/mailet/MailAddress.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/mailet/api/apidocs/org/apache/mailet/MailAddress.html?rev=800330&r1=800329&r2=800330&view=diff
==============================================================================
--- james/site/trunk/www/mailet/api/apidocs/org/apache/mailet/MailAddress.html (original)
+++ james/site/trunk/www/mailet/api/apidocs/org/apache/mailet/MailAddress.html Mon Aug 3 12:18:51 2009
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.5.0_18) on Thu May 28 11:11:01 BST 2009 -->
+<!-- Generated by javadoc (build 1.5.0_18) on Mon Aug 03 13:36:26 BST 2009 -->
<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<TITLE>
MailAddress (Apache Mailet API 2.5-SNAPSHOT API)
@@ -102,7 +102,8 @@
<P>
A representation of an email address.
- <p>This class encapsulates functionalities to access to different
+
+ <p>This class encapsulates functionality to access different
parts of an email address without dealing with its parsing.</p>
<p>A MailAddress is an address specified in the MAIL FROM and
@@ -116,17 +117,17 @@
<p>MailAddress parses an email address as defined in RFC 821
(SMTP) p. 30 and 31 where addresses are defined in BNF convention.
As the mailet API does not support the aged "SMTP-relayed mail"
- addressing protocol, this leaves all addresses to be a <mailbox>,
+ addressing protocol, this leaves all addresses to be a <code><mailbox></code>,
as per the spec.
<p>This class is a good way to validate email addresses as there are
some valid addresses which would fail with a simpler approach
- to parsing address. It also removes parsing burden from
+ to parsing address. It also removes the parsing burden from
mailets and matchers that might not realize the flexibility of an
- SMTP address. For instance, "serge@home"@lokitech.com is a valid
+ SMTP address. For instance, "serge@home"@lokitech.com is a valid
SMTP address (the quoted text serge@home is the local-part and
- lokitech.com is the domain). This means all current parsing to date
- is incorrect as we just find the first @ and use that to separate
+ lokitech.com is the domain). This means all current parsing to date
+ is incorrect as we just find the first '@' and use that to separate
local-part from domain.</p>
<p>This parses an address as per the BNF specification for <mailbox>
@@ -157,7 +158,9 @@
<BR>
We hardcode the serialVersionUID
- 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.</TD>
+ 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.</TD>
</TR>
</TABLE>
@@ -173,22 +176,22 @@
<TD><CODE><B><A HREF="../../../org/apache/mailet/MailAddress.html#MailAddress(javax.mail.internet.InternetAddress)">MailAddress</A></B>(javax.mail.internet.InternetAddress address)</CODE>
<BR>
- Constructs a MailAddress from a JavaMail InternetAddress, using only the
- email address portion, discarding the personal name.</TD>
+ Constructs a MailAddress from an InternetAddress, using only the
+ email address portion (an "addr-spec", not "name-addr", as
+ defined in the RFC2822 3.4.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../org/apache/mailet/MailAddress.html#MailAddress(java.lang.String)">MailAddress</A></B>(java.lang.String address)</CODE>
<BR>
- Construct a MailAddress parsing the provided <code>String</code> object.</TD>
+ Constructs a MailAddress by parsing the provided address.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../org/apache/mailet/MailAddress.html#MailAddress(java.lang.String, java.lang.String)">MailAddress</A></B>(java.lang.String localPart,
java.lang.String domain)</CODE>
<BR>
- Construct a MailAddress with the provided personal name and email
- address.</TD>
+ Constructs a MailAddress with the provided local part and domain.</TD>
</TR>
</TABLE>
@@ -206,7 +209,7 @@
<TD><CODE><B><A HREF="../../../org/apache/mailet/MailAddress.html#equals(java.lang.Object)">equals</A></B>(java.lang.Object obj)</CODE>
<BR>
- </TD>
+ Indicates whether some other object is "equal to" this one.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -214,7 +217,7 @@
<TD><CODE><B><A HREF="../../../org/apache/mailet/MailAddress.html#getDomain()">getDomain</A></B>()</CODE>
<BR>
- Return the domain part per RFC2822 3.4.1.</TD>
+ Returns the domain part per RFC2822 3.4.1.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -222,7 +225,8 @@
<TD><CODE><B><A HREF="../../../org/apache/mailet/MailAddress.html#getHost()">getHost</A></B>()</CODE>
<BR>
- <B>Deprecated.</B> <I>use getDomain() - name change to align with RFC2822 3.4.1. Addr-spec specification</I></TD>
+ <B>Deprecated.</B> <I>use <A HREF="../../../org/apache/mailet/MailAddress.html#getDomain()"><CODE>getDomain()</CODE></A>, whose name was changed to
+ align with RFC2822 3.4.1. addr-spec specification</I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -230,7 +234,7 @@
<TD><CODE><B><A HREF="../../../org/apache/mailet/MailAddress.html#getLocalPart()">getLocalPart</A></B>()</CODE>
<BR>
- Return the local-part per RFC2822 3.4.1.</TD>
+ Returns the local-part per RFC2822 3.4.1.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -238,7 +242,8 @@
<TD><CODE><B><A HREF="../../../org/apache/mailet/MailAddress.html#getUser()">getUser</A></B>()</CODE>
<BR>
- <B>Deprecated.</B> <I>use getLocalPart() - name change to align with RFC2822 3.4.1. Addr-spec specification</I></TD>
+ <B>Deprecated.</B> <I>use <A HREF="../../../org/apache/mailet/MailAddress.html#getLocalPart()"><CODE>getLocalPart()</CODE></A>, whose name was changed to
+ align with the RFC2822 3.4.1. addr-spec specification</I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -246,8 +251,7 @@
<TD><CODE><B><A HREF="../../../org/apache/mailet/MailAddress.html#hashCode()">hashCode</A></B>()</CODE>
<BR>
- Return a hashCode for this object which should be identical for addresses
- which are equivalent.</TD>
+ Returns a hash code value for this object.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -255,7 +259,8 @@
<TD><CODE><B><A HREF="../../../org/apache/mailet/MailAddress.html#toInternetAddress()">toInternetAddress</A></B>()</CODE>
<BR>
- Return MailAddress as InternetAddress</TD>
+ Returns an InternetAddress representing the same address
+ as this MailAddress.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -294,7 +299,9 @@
public static final long <B>serialVersionUID</B></PRE>
<DL>
<DD>We hardcode the serialVersionUID
- 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.
+ 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.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.mailet.MailAddress.serialVersionUID">Constant Field Values</A></DL>
@@ -316,12 +323,10 @@
public <B>MailAddress</B>(java.lang.String address)
throws javax.mail.internet.AddressException</PRE>
<DL>
-<DD><p>Construct a MailAddress parsing the provided <code>String</code> object.</p>
-
- <p>The <code>personal</code> variable is left empty.</p>
+<DD>Constructs a MailAddress by parsing the provided address.
<P>
<DL>
-<DT><B>Parameters:</B><DD><CODE>address</CODE> - the email address compliant to the RFC2822 3.4.1. Addr-spec specification
+<DT><B>Parameters:</B><DD><CODE>address</CODE> - the email address, compliant to the RFC2822 3.4.1. addr-spec specification
<DT><B>Throws:</B>
<DD><CODE>javax.mail.internet.AddressException</CODE> - if the parse failed</DL>
</DL>
@@ -334,11 +339,13 @@
java.lang.String domain)
throws javax.mail.internet.AddressException</PRE>
<DL>
-<DD>Construct a MailAddress with the provided personal name and email
- address.
+<DD>Constructs a MailAddress with the provided local part and domain.
<P>
<DL>
-<DT><B>Parameters:</B><DD><CODE>localPart</CODE> - 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<DD><CODE>domain</CODE> - The domain portion identifies the point to which the mail is delivered per RFC2822 3.4.1. Addr-spec specification
+<DT><B>Parameters:</B><DD><CODE>localPart</CODE> - the local-part portion. This 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<DD><CODE>domain</CODE> - the domain portion. This identifies the point to which the mail
+ is delivered per RFC2822 3.4.1. addr-spec specification
<DT><B>Throws:</B>
<DD><CODE>javax.mail.internet.AddressException</CODE> - if the parse failed</DL>
</DL>
@@ -350,13 +357,14 @@
public <B>MailAddress</B>(javax.mail.internet.InternetAddress address)
throws javax.mail.internet.AddressException</PRE>
<DL>
-<DD>Constructs a MailAddress from a JavaMail InternetAddress, using only the
- email address portion, discarding the personal name. (an "addr-spec" not a "name-addr" as defined in RFC2822 3.4. Address Specification
+<DD>Constructs a MailAddress from an InternetAddress, using only the
+ email address portion (an "addr-spec", not "name-addr", as
+ defined in the RFC2822 3.4. Address Specification)
<P>
<DL>
-<DT><B>Parameters:</B><DD><CODE>address</CODE> -
+<DT><B>Parameters:</B><DD><CODE>address</CODE> - the address
<DT><B>Throws:</B>
-<DD><CODE>javax.mail.internet.AddressException</CODE></DL>
+<DD><CODE>javax.mail.internet.AddressException</CODE> - if the parse failed</DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
@@ -374,18 +382,18 @@
<PRE>
public java.lang.String <B>getHost</B>()</PRE>
<DL>
-<DD><B>Deprecated.</B> <I>use getDomain() - name change to align with RFC2822 3.4.1. Addr-spec specification</I>
+<DD><B>Deprecated.</B> <I>use <A HREF="../../../org/apache/mailet/MailAddress.html#getDomain()"><CODE>getDomain()</CODE></A>, whose name was changed to
+ align with RFC2822 3.4.1. addr-spec specification</I>
<P>
-<DD>Return the host part.
+<DD>Returns the host part.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
-<DT><B>Returns:</B><DD>a <code>String</code> object representing the host part
- of this email address. If the host is of the dotNum form
- (e.g. [yyy.yyy.yyy.yyy]) then strip the braces first.</DL>
+<DT><B>Returns:</B><DD>the host part of this email address. If the host is of the
+ dotNum form (e.g. [yyy.yyy.yyy.yyy]), then strip the braces first.</DL>
</DD>
</DL>
<HR>
@@ -395,15 +403,16 @@
<PRE>
public java.lang.String <B>getDomain</B>()</PRE>
<DL>
-<DD>Return the domain part per RFC2822 3.4.1. Addr-spec specification
+<DD>Returns the domain part per RFC2822 3.4.1. addr-spec specification.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
-<DT><B>Returns:</B><DD>a <code>String</code> object representing the domain part
- 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.</DL>
+<DT><B>Returns:</B><DD>the domain part 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.</DL>
</DD>
</DL>
<HR>
@@ -413,19 +422,17 @@
<PRE>
public java.lang.String <B>getUser</B>()</PRE>
<DL>
-<DD><B>Deprecated.</B> <I>use getLocalPart() - name change to align with RFC2822 3.4.1. Addr-spec specification</I>
+<DD><B>Deprecated.</B> <I>use <A HREF="../../../org/apache/mailet/MailAddress.html#getLocalPart()"><CODE>getLocalPart()</CODE></A>, whose name was changed to
+ align with the RFC2822 3.4.1. addr-spec specification</I>
<P>
-<DD>Return the user part.
+<DD>Returns the user part.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
-<DT><B>Returns:</B><DD>a <code>String</code> object representing the user part
- of this email address.
-<DT><B>Throws:</B>
-<DD><CODE>javax.mail.internet.AddressException</CODE> - if the parse failed</DL>
+<DT><B>Returns:</B><DD>the user part of this email address</DL>
</DD>
</DL>
<HR>
@@ -435,19 +442,19 @@
<PRE>
public java.lang.String <B>getLocalPart</B>()</PRE>
<DL>
-<DD>Return the local-part per RFC2822 3.4.1. Addr-spec specification
+<DD>Returns the local-part per RFC2822 3.4.1. addr-spec specification.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
-<DT><B>Returns:</B><DD>a <code>String</code> object representing the local-part
- of this email address as defined by RFC2822 3.4.1. Addr-spec specification.
- 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.
- It is the part before the "@"
-<DT><B>Throws:</B>
-<DD><CODE>javax.mail.internet.AddressException</CODE> - if the parse failed</DL>
+<DT><B>Returns:</B><DD>the local-part of this email address as defined by the
+ RFC2822 3.4.1. addr-spec specification.
+ 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
+ (the part before the "@" character)</DL>
</DD>
</DL>
<HR>
@@ -471,7 +478,8 @@
<PRE>
public javax.mail.internet.InternetAddress <B>toInternetAddress</B>()</PRE>
<DL>
-<DD>Return MailAddress as InternetAddress
+<DD>Returns an InternetAddress representing the same address
+ as this MailAddress.
<P>
<DD><DL>
</DL>
@@ -488,6 +496,13 @@
<PRE>
public boolean <B>equals</B>(java.lang.Object obj)</PRE>
<DL>
+<DD>Indicates whether some other object is "equal to" this one.
+
+ Note that this implementation breaks the general contract of the
+ <code>equals</code> method by allowing an instance to equal to a
+ <code>String</code>. It is recommended that implementations avoid
+ relying on this design which may be removed in a future release.
+<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE>equals</CODE> in class <CODE>java.lang.Object</CODE></DL>
</DD>
@@ -502,11 +517,11 @@
<PRE>
public int <B>hashCode</B>()</PRE>
<DL>
-<DD>Return a hashCode for this object which should be identical for addresses
- which are equivalent. This is implemented by obtaining the default
- hashcode of the String representation of the MailAddress. Without this
- explicit definition, the default hashCode will create different hashcodes
- for separate object instances.
+<DD>Returns a hash code value for this object.
+ <p>
+ This method is implemented by returning the hash code of the canonical
+ string representation of this address, so that all instances representing
+ the same address will return an identical hash code.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE>hashCode</CODE> in class <CODE>java.lang.Object</CODE></DL>