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/23 13:34:08 UTC
svn commit: r688300 [2/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/ te...
Added: 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=688300&view=auto
==============================================================================
--- james/site/trunk/www/mailet/api/apidocs/org/apache/mailet/Mail.html (added)
+++ james/site/trunk/www/mailet/api/apidocs/org/apache/mailet/Mail.html Sat Aug 23 04:34:05 2008
@@ -0,0 +1,882 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!--NewPage-->
+<HTML>
+<HEAD>
+<!-- Generated by javadoc (build 1.5.0_16) on Sat Aug 23 12:29:13 BST 2008 -->
+<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<TITLE>
+Mail (Apache Mailet API 2.4-SNAPSHOT API)
+</TITLE>
+
+<META NAME="keywords" CONTENT="org.apache.mailet.Mail interface">
+
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
+
+<SCRIPT type="text/javascript">
+function windowTitle()
+{
+ parent.document.title="Mail (Apache Mailet API 2.4-SNAPSHOT API)";
+}
+</SCRIPT>
+<NOSCRIPT>
+</NOSCRIPT>
+
+</HEAD>
+
+<BODY BGCOLOR="white" onload="windowTitle();">
+
+
+<!-- ========= START OF TOP NAVBAR ======= -->
+<A NAME="navbar_top"><!-- --></A>
+<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
+<TR>
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_top_firstrow"><!-- --></A>
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
+ <TR ALIGN="center" VALIGN="top">
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../org/apache/mailet/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Mail.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../org/apache/mailet/HostAddress.html" title="class in org.apache.mailet"><B>PREV CLASS</B></A>
+ <A HREF="../../../org/apache/mailet/MailAddress.html" title="class in org.apache.mailet"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../index.html?org/apache/mailet/Mail.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="Mail.html" target="_top"><B>NO FRAMES</B></A>
+ <SCRIPT type="text/javascript">
+ <!--
+ if(window==top) {
+ document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
+ }
+ //-->
+</SCRIPT>
+<NOSCRIPT>
+ <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
+</NOSCRIPT>
+
+
+</FONT></TD>
+</TR>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+ SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<A NAME="skip-navbar_top"></A>
+<!-- ========= END OF TOP NAVBAR ========= -->
+
+<HR>
+<!-- ======== START OF CLASS DATA ======== -->
+<H2>
+<FONT SIZE="-1">
+org.apache.mailet</FONT>
+<BR>
+Interface Mail</H2>
+<DL>
+<DT><B>All Superinterfaces:</B> <DD>java.lang.Cloneable, java.io.Serializable</DD>
+</DL>
+<HR>
+<DL>
+<DT><PRE>public interface <B>Mail</B><DT>extends java.io.Serializable, java.lang.Cloneable</DL>
+</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>
+
+<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>
+<!-- =========== FIELD SUMMARY =========== -->
+
+<A NAME="field_summary"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
+<B>Field Summary</B></FONT></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static java.lang.String</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/mailet/Mail.html#DEFAULT">DEFAULT</A></B></CODE>
+
+<BR>
+ </TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static java.lang.String</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/mailet/Mail.html#ERROR">ERROR</A></B></CODE>
+
+<BR>
+ </TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static java.lang.String</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/mailet/Mail.html#GHOST">GHOST</A></B></CODE>
+
+<BR>
+ </TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static java.lang.String</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/mailet/Mail.html#TRANSPORT">TRANSPORT</A></B></CODE>
+
+<BR>
+ </TD>
+</TR>
+</TABLE>
+
+<!-- ========== METHOD SUMMARY =========== -->
+
+<A NAME="method_summary"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
+<B>Method Summary</B></FONT></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.io.Serializable</CODE></FONT></TD>
+<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>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.util.Iterator</CODE></FONT></TD>
+<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>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.lang.String</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/mailet/Mail.html#getErrorMessage()">getErrorMessage</A></B>()</CODE>
+
+<BR>
+ The error message, if any, associated with this message.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.util.Date</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/mailet/Mail.html#getLastUpdated()">getLastUpdated</A></B>()</CODE>
+
+<BR>
+ </TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> javax.mail.internet.MimeMessage</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/mailet/Mail.html#getMessage()">getMessage</A></B>()</CODE>
+
+<BR>
+ Returns the MimeMessage stored in this message</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> long</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/mailet/Mail.html#getMessageSize()">getMessageSize</A></B>()</CODE>
+
+<BR>
+ </TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.lang.String</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/mailet/Mail.html#getName()">getName</A></B>()</CODE>
+
+<BR>
+ Returns the message name of this message</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.util.Collection</CODE></FONT></TD>
+<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>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.lang.String</CODE></FONT></TD>
+<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>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.lang.String</CODE></FONT></TD>
+<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>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> <A HREF="../../../org/apache/mailet/MailAddress.html" title="class in org.apache.mailet">MailAddress</A></CODE></FONT></TD>
+<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>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.lang.String</CODE></FONT></TD>
+<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>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> boolean</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/mailet/Mail.html#hasAttributes()">hasAttributes</A></B>()</CODE>
+
+<BR>
+ </TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<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>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.io.Serializable</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/mailet/Mail.html#removeAttribute(java.lang.String)">removeAttribute</A></B>(java.lang.String name)</CODE>
+
+<BR>
+ Removes the attribute with the given name from this Mail instance.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.io.Serializable</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/mailet/Mail.html#setAttribute(java.lang.String, java.io.Serializable)">setAttribute</A></B>(java.lang.String name,
+ java.io.Serializable object)</CODE>
+
+<BR>
+ Binds an object to a given attribute name in this Mail instance.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/mailet/Mail.html#setErrorMessage(java.lang.String)">setErrorMessage</A></B>(java.lang.String msg)</CODE>
+
+<BR>
+ Sets the error message associated with this message.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/mailet/Mail.html#setLastUpdated(java.util.Date)">setLastUpdated</A></B>(java.util.Date lastUpdated)</CODE>
+
+<BR>
+ </TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<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>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<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>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<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>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/mailet/Mail.html#setState(java.lang.String)">setState</A></B>(java.lang.String state)</CODE>
+
+<BR>
+ Sets the state of this message.</TD>
+</TR>
+</TABLE>
+
+<P>
+
+<!-- ============ FIELD DETAIL =========== -->
+
+<A NAME="field_detail"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Field Detail</B></FONT></TH>
+</TR>
+</TABLE>
+
+<A NAME="GHOST"><!-- --></A><H3>
+GHOST</H3>
+<PRE>
+static final java.lang.String <B>GHOST</B></PRE>
+<DL>
+<DL>
+<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.mailet.Mail.GHOST">Constant Field Values</A></DL>
+</DL>
+<HR>
+
+<A NAME="DEFAULT"><!-- --></A><H3>
+DEFAULT</H3>
+<PRE>
+static final java.lang.String <B>DEFAULT</B></PRE>
+<DL>
+<DL>
+<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.mailet.Mail.DEFAULT">Constant Field Values</A></DL>
+</DL>
+<HR>
+
+<A NAME="ERROR"><!-- --></A><H3>
+ERROR</H3>
+<PRE>
+static final java.lang.String <B>ERROR</B></PRE>
+<DL>
+<DL>
+<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.mailet.Mail.ERROR">Constant Field Values</A></DL>
+</DL>
+<HR>
+
+<A NAME="TRANSPORT"><!-- --></A><H3>
+TRANSPORT</H3>
+<PRE>
+static final java.lang.String <B>TRANSPORT</B></PRE>
+<DL>
+<DL>
+<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.mailet.Mail.TRANSPORT">Constant Field Values</A></DL>
+</DL>
+
+<!-- ============ METHOD DETAIL ========== -->
+
+<A NAME="method_detail"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Method Detail</B></FONT></TH>
+</TR>
+</TABLE>
+
+<A NAME="getName()"><!-- --></A><H3>
+getName</H3>
+<PRE>
+java.lang.String <B>getName</B>()</PRE>
+<DL>
+<DD>Returns the message name of this message
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>the message name<DT><B>Since:</B></DT>
+ <DD>Mailet API v2.3</DD>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="setName(java.lang.String)"><!-- --></A><H3>
+setName</H3>
+<PRE>
+void <B>setName</B>(java.lang.String newName)</PRE>
+<DL>
+<DD>Set the message 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>
+ <DD>Mailet API v2.3</DD>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getMessage()"><!-- --></A><H3>
+getMessage</H3>
+<PRE>
+javax.mail.internet.MimeMessage <B>getMessage</B>()
+ throws javax.mail.MessagingException</PRE>
+<DL>
+<DD>Returns the MimeMessage stored in this message
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+
+<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>
+</DL>
+<HR>
+
+<A NAME="getRecipients()"><!-- --></A><H3>
+getRecipients</H3>
+<PRE>
+java.util.Collection <B>getRecipients</B>()</PRE>
+<DL>
+<DD>Returns a Collection of MailAddress objects that are recipients of this message
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>a Collection of MailAddress objects that are recipients of this message</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="setRecipients(java.util.Collection)"><!-- --></A><H3>
+setRecipients</H3>
+<PRE>
+void <B>setRecipients</B>(java.util.Collection recipients)</PRE>
+<DL>
+<DD>Method setRecipients.
+<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>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getSender()"><!-- --></A><H3>
+getSender</H3>
+<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
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>a MailAddress of the sender of this message</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getState()"><!-- --></A><H3>
+getState</H3>
+<PRE>
+java.lang.String <B>getState</B>()</PRE>
+<DL>
+<DD>The current state of the message, such as GHOST, ERROR, or DEFAULT
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>the state of this message</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getRemoteHost()"><!-- --></A><H3>
+getRemoteHost</H3>
+<PRE>
+java.lang.String <B>getRemoteHost</B>()</PRE>
+<DL>
+<DD>The remote hostname of the server that connected to send 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>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getRemoteAddr()"><!-- --></A><H3>
+getRemoteAddr</H3>
+<PRE>
+java.lang.String <B>getRemoteAddr</B>()</PRE>
+<DL>
+<DD>The remote ip address of the server that connected to send 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>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getErrorMessage()"><!-- --></A><H3>
+getErrorMessage</H3>
+<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.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>a String of a descriptive error message</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="setErrorMessage(java.lang.String)"><!-- --></A><H3>
+setErrorMessage</H3>
+<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.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>msg</CODE> - - a descriptive error message</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="setMessage(javax.mail.internet.MimeMessage)"><!-- --></A><H3>
+setMessage</H3>
+<PRE>
+void <B>setMessage</B>(javax.mail.internet.MimeMessage message)</PRE>
+<DL>
+<DD>Sets the MimeMessage associated with this message via the object.
+<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>
+</DD>
+</DL>
+<HR>
+
+<A NAME="setState(java.lang.String)"><!-- --></A><H3>
+setState</H3>
+<PRE>
+void <B>setState</B>(java.lang.String state)</PRE>
+<DL>
+<DD>Sets the state of this message.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>state</CODE> - - the new state of this message</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getAttribute(java.lang.String)"><!-- --></A><H3>
+getAttribute</H3>
+<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>.
+<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>
+ <DD>Mailet API v2.1</DD>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getAttributeNames()"><!-- --></A><H3>
+getAttributeNames</H3>
+<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.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>an Iterator of attribute names<DT><B>Since:</B></DT>
+ <DD>Mailet API v2.1</DD>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="hasAttributes()"><!-- --></A><H3>
+hasAttributes</H3>
+<PRE>
+boolean <B>hasAttributes</B>()</PRE>
+<DL>
+<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>
+ <DD>Mailet API v2.1</DD>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="removeAttribute(java.lang.String)"><!-- --></A><H3>
+removeAttribute</H3>
+<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.
+<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>
+ <DD>Mailet API v2.1</DD>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="removeAllAttributes()"><!-- --></A><H3>
+removeAllAttributes</H3>
+<PRE>
+void <B>removeAllAttributes</B>()</PRE>
+<DL>
+<DD>Removes all the attributes associated with this Mail instance.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Since:</B></DT>
+ <DD>Mailet API v2.1</DD>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="setAttribute(java.lang.String, java.io.Serializable)"><!-- --></A><H3>
+setAttribute</H3>
+<PRE>
+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
+ <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>.
+<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>
+ <DD>Mailet API v2.1</DD>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getMessageSize()"><!-- --></A><H3>
+getMessageSize</H3>
+<PRE>
+long <B>getMessageSize</B>()
+ throws javax.mail.MessagingException</PRE>
+<DL>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>message size
+<DT><B>Throws:</B>
+<DD><CODE>javax.mail.MessagingException</CODE><DT><B>Since:</B></DT>
+ <DD>Mailet API v2.3</DD>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getLastUpdated()"><!-- --></A><H3>
+getLastUpdated</H3>
+<PRE>
+java.util.Date <B>getLastUpdated</B>()</PRE>
+<DL>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>the last update date<DT><B>Since:</B></DT>
+ <DD>Mailet API v2.3</DD>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="setLastUpdated(java.util.Date)"><!-- --></A><H3>
+setLastUpdated</H3>
+<PRE>
+void <B>setLastUpdated</B>(java.util.Date lastUpdated)</PRE>
+<DL>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>lastUpdated</CODE> - the new last updated date<DT><B>Since:</B></DT>
+ <DD>Mailet API v2.3</DD>
+</DL>
+</DD>
+</DL>
+<!-- ========= END OF CLASS DATA ========= -->
+<HR>
+
+
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<A NAME="navbar_bottom"><!-- --></A>
+<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
+<TR>
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_bottom_firstrow"><!-- --></A>
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
+ <TR ALIGN="center" VALIGN="top">
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../org/apache/mailet/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Mail.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../org/apache/mailet/HostAddress.html" title="class in org.apache.mailet"><B>PREV CLASS</B></A>
+ <A HREF="../../../org/apache/mailet/MailAddress.html" title="class in org.apache.mailet"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../index.html?org/apache/mailet/Mail.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="Mail.html" target="_top"><B>NO FRAMES</B></A>
+ <SCRIPT type="text/javascript">
+ <!--
+ if(window==top) {
+ document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
+ }
+ //-->
+</SCRIPT>
+<NOSCRIPT>
+ <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
+</NOSCRIPT>
+
+
+</FONT></TD>
+</TR>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+ SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<A NAME="skip-navbar_bottom"></A>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+
+<HR>
+Copyright © 2007-2008 <a href="http://www.apache.org">The Apache Software Foundation</a>. All Rights Reserved.
+</BODY>
+</HTML>
Added: 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=688300&view=auto
==============================================================================
--- james/site/trunk/www/mailet/api/apidocs/org/apache/mailet/MailAddress.html (added)
+++ james/site/trunk/www/mailet/api/apidocs/org/apache/mailet/MailAddress.html Sat Aug 23 04:34:05 2008
@@ -0,0 +1,581 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!--NewPage-->
+<HTML>
+<HEAD>
+<!-- Generated by javadoc (build 1.5.0_16) on Sat Aug 23 12:29:13 BST 2008 -->
+<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<TITLE>
+MailAddress (Apache Mailet API 2.4-SNAPSHOT API)
+</TITLE>
+
+<META NAME="keywords" CONTENT="org.apache.mailet.MailAddress class">
+
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
+
+<SCRIPT type="text/javascript">
+function windowTitle()
+{
+ parent.document.title="MailAddress (Apache Mailet API 2.4-SNAPSHOT API)";
+}
+</SCRIPT>
+<NOSCRIPT>
+</NOSCRIPT>
+
+</HEAD>
+
+<BODY BGCOLOR="white" onload="windowTitle();">
+
+
+<!-- ========= START OF TOP NAVBAR ======= -->
+<A NAME="navbar_top"><!-- --></A>
+<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
+<TR>
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_top_firstrow"><!-- --></A>
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
+ <TR ALIGN="center" VALIGN="top">
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../org/apache/mailet/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/MailAddress.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../org/apache/mailet/Mail.html" title="interface in org.apache.mailet"><B>PREV CLASS</B></A>
+ <A HREF="../../../org/apache/mailet/Mailet.html" title="interface in org.apache.mailet"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../index.html?org/apache/mailet/MailAddress.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="MailAddress.html" target="_top"><B>NO FRAMES</B></A>
+ <SCRIPT type="text/javascript">
+ <!--
+ if(window==top) {
+ document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
+ }
+ //-->
+</SCRIPT>
+<NOSCRIPT>
+ <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
+</NOSCRIPT>
+
+
+</FONT></TD>
+</TR>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+ SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<A NAME="skip-navbar_top"></A>
+<!-- ========= END OF TOP NAVBAR ========= -->
+
+<HR>
+<!-- ======== START OF CLASS DATA ======== -->
+<H2>
+<FONT SIZE="-1">
+org.apache.mailet</FONT>
+<BR>
+Class MailAddress</H2>
+<PRE>
+java.lang.Object
+ <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>org.apache.mailet.MailAddress</B>
+</PRE>
+<DL>
+<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable</DD>
+</DL>
+<HR>
+<DL>
+<DT><PRE>public class <B>MailAddress</B><DT>extends java.lang.Object<DT>implements java.io.Serializable</DL>
+</PRE>
+
+<P>
+A representation of an email address.
+ <p>This class encapsulates functionalities to access to different
+ parts of an email address without dealing with its parsing.</p>
+
+ <p>A MailAddress is an address specified in the MAIL FROM and
+ RCPT TO commands in SMTP sessions. These are either passed by
+ an external server to the mailet-compliant SMTP server, or they
+ are created programmatically by the mailet-compliant server to
+ send to another (external) SMTP server. Mailets and matchers
+ use the MailAddress for the purpose of evaluating the sender
+ and recipient(s) of a message.</p>
+
+ <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>,
+ 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
+ mailets and matchers that might not realize the flexibility of an
+ 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
+ local-part from domain.</p>
+
+ <p>This parses an address as per the BNF specification for <mailbox>
+ from RFC 821 on page 30 and 31, section 4.1.2. COMMAND SYNTAX.
+ http://www.freesoft.org/CIE/RFC/821/15.htm</p>
+<P>
+
+<P>
+<DL>
+<DT><B>Version:</B></DT>
+ <DD>1.0</DD>
+<DT><B>See Also:</B><DD><A HREF="../../../serialized-form.html#org.apache.mailet.MailAddress">Serialized Form</A></DL>
+<HR>
+
+<P>
+<!-- =========== FIELD SUMMARY =========== -->
+
+<A NAME="field_summary"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
+<B>Field Summary</B></FONT></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static long</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/mailet/MailAddress.html#serialVersionUID">serialVersionUID</A></B></CODE>
+
+<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>
+</TR>
+</TABLE>
+
+<!-- ======== CONSTRUCTOR SUMMARY ======== -->
+
+<A NAME="constructor_summary"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
+<B>Constructor Summary</B></FONT></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<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>
+</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>
+</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>
+</TR>
+</TABLE>
+
+<!-- ========== METHOD SUMMARY =========== -->
+
+<A NAME="method_summary"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
+<B>Method Summary</B></FONT></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> boolean</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/mailet/MailAddress.html#equals(java.lang.Object)">equals</A></B>(java.lang.Object obj)</CODE>
+
+<BR>
+ </TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.lang.String</CODE></FONT></TD>
+<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>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.lang.String</CODE></FONT></TD>
+<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>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.lang.String</CODE></FONT></TD>
+<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>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.lang.String</CODE></FONT></TD>
+<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>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> int</CODE></FONT></TD>
+<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>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> javax.mail.internet.InternetAddress</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/mailet/MailAddress.html#toInternetAddress()">toInternetAddress</A></B>()</CODE>
+
+<BR>
+ Return MailAddress as InternetAddress</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.lang.String</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/mailet/MailAddress.html#toString()">toString</A></B>()</CODE>
+
+<BR>
+ </TD>
+</TR>
+</TABLE>
+ <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
+<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</CODE></TD>
+</TR>
+</TABLE>
+
+<P>
+
+<!-- ============ FIELD DETAIL =========== -->
+
+<A NAME="field_detail"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Field Detail</B></FONT></TH>
+</TR>
+</TABLE>
+
+<A NAME="serialVersionUID"><!-- --></A><H3>
+serialVersionUID</H3>
+<PRE>
+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.
+<P>
+<DL>
+<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.mailet.MailAddress.serialVersionUID">Constant Field Values</A></DL>
+</DL>
+
+<!-- ========= CONSTRUCTOR DETAIL ======== -->
+
+<A NAME="constructor_detail"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Constructor Detail</B></FONT></TH>
+</TR>
+</TABLE>
+
+<A NAME="MailAddress(java.lang.String)"><!-- --></A><H3>
+MailAddress</H3>
+<PRE>
+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>
+<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>Throws:</B>
+<DD><CODE>javax.mail.internet.AddressException</CODE> - if the parse failed</DL>
+</DL>
+<HR>
+
+<A NAME="MailAddress(java.lang.String, java.lang.String)"><!-- --></A><H3>
+MailAddress</H3>
+<PRE>
+public <B>MailAddress</B>(java.lang.String localPart,
+ java.lang.String domain)
+ throws javax.mail.internet.AddressException</PRE>
+<DL>
+<DD>Construct a MailAddress with the provided personal name and email
+ address.
+<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>Throws:</B>
+<DD><CODE>javax.mail.internet.AddressException</CODE> - if the parse failed</DL>
+</DL>
+<HR>
+
+<A NAME="MailAddress(javax.mail.internet.InternetAddress)"><!-- --></A><H3>
+MailAddress</H3>
+<PRE>
+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
+<P>
+<DL>
+<DT><B>Parameters:</B><DD><CODE>address</CODE> -
+<DT><B>Throws:</B>
+<DD><CODE>javax.mail.internet.AddressException</CODE></DL>
+</DL>
+
+<!-- ============ METHOD DETAIL ========== -->
+
+<A NAME="method_detail"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Method Detail</B></FONT></TH>
+</TR>
+</TABLE>
+
+<A NAME="getHost()"><!-- --></A><H3>
+getHost</H3>
+<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>
+<P>
+<DD>Return 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>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getDomain()"><!-- --></A><H3>
+getDomain</H3>
+<PRE>
+public java.lang.String <B>getDomain</B>()</PRE>
+<DL>
+<DD>Return 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>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getUser()"><!-- --></A><H3>
+getUser</H3>
+<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>
+<P>
+<DD>Return 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>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getLocalPart()"><!-- --></A><H3>
+getLocalPart</H3>
+<PRE>
+public java.lang.String <B>getLocalPart</B>()</PRE>
+<DL>
+<DD>Return 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>
+</DD>
+</DL>
+<HR>
+
+<A NAME="toString()"><!-- --></A><H3>
+toString</H3>
+<PRE>
+public java.lang.String <B>toString</B>()</PRE>
+<DL>
+<DD><DL>
+<DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL>
+</DD>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="toInternetAddress()"><!-- --></A><H3>
+toInternetAddress</H3>
+<PRE>
+public javax.mail.internet.InternetAddress <B>toInternetAddress</B>()</PRE>
+<DL>
+<DD>Return MailAddress as InternetAddress
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>the address</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="equals(java.lang.Object)"><!-- --></A><H3>
+equals</H3>
+<PRE>
+public boolean <B>equals</B>(java.lang.Object obj)</PRE>
+<DL>
+<DD><DL>
+<DT><B>Overrides:</B><DD><CODE>equals</CODE> in class <CODE>java.lang.Object</CODE></DL>
+</DD>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="hashCode()"><!-- --></A><H3>
+hashCode</H3>
+<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.
+<P>
+<DD><DL>
+<DT><B>Overrides:</B><DD><CODE>hashCode</CODE> in class <CODE>java.lang.Object</CODE></DL>
+</DD>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>the hashcode.</DL>
+</DD>
+</DL>
+<!-- ========= END OF CLASS DATA ========= -->
+<HR>
+
+
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<A NAME="navbar_bottom"><!-- --></A>
+<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
+<TR>
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_bottom_firstrow"><!-- --></A>
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
+ <TR ALIGN="center" VALIGN="top">
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../org/apache/mailet/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/MailAddress.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../org/apache/mailet/Mail.html" title="interface in org.apache.mailet"><B>PREV CLASS</B></A>
+ <A HREF="../../../org/apache/mailet/Mailet.html" title="interface in org.apache.mailet"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../index.html?org/apache/mailet/MailAddress.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="MailAddress.html" target="_top"><B>NO FRAMES</B></A>
+ <SCRIPT type="text/javascript">
+ <!--
+ if(window==top) {
+ document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
+ }
+ //-->
+</SCRIPT>
+<NOSCRIPT>
+ <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
+</NOSCRIPT>
+
+
+</FONT></TD>
+</TR>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+ SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<A NAME="skip-navbar_bottom"></A>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+
+<HR>
+Copyright © 2007-2008 <a href="http://www.apache.org">The Apache Software Foundation</a>. All Rights Reserved.
+</BODY>
+</HTML>
Added: james/site/trunk/www/mailet/api/apidocs/org/apache/mailet/Mailet.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/mailet/api/apidocs/org/apache/mailet/Mailet.html?rev=688300&view=auto
==============================================================================
--- james/site/trunk/www/mailet/api/apidocs/org/apache/mailet/Mailet.html (added)
+++ james/site/trunk/www/mailet/api/apidocs/org/apache/mailet/Mailet.html Sat Aug 23 04:34:05 2008
@@ -0,0 +1,367 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!--NewPage-->
+<HTML>
+<HEAD>
+<!-- Generated by javadoc (build 1.5.0_16) on Sat Aug 23 12:29:14 BST 2008 -->
+<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<TITLE>
+Mailet (Apache Mailet API 2.4-SNAPSHOT API)
+</TITLE>
+
+<META NAME="keywords" CONTENT="org.apache.mailet.Mailet interface">
+
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
+
+<SCRIPT type="text/javascript">
+function windowTitle()
+{
+ parent.document.title="Mailet (Apache Mailet API 2.4-SNAPSHOT API)";
+}
+</SCRIPT>
+<NOSCRIPT>
+</NOSCRIPT>
+
+</HEAD>
+
+<BODY BGCOLOR="white" onload="windowTitle();">
+
+
+<!-- ========= START OF TOP NAVBAR ======= -->
+<A NAME="navbar_top"><!-- --></A>
+<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
+<TR>
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_top_firstrow"><!-- --></A>
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
+ <TR ALIGN="center" VALIGN="top">
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../org/apache/mailet/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Mailet.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../org/apache/mailet/MailAddress.html" title="class in org.apache.mailet"><B>PREV CLASS</B></A>
+ <A HREF="../../../org/apache/mailet/MailetConfig.html" title="interface in org.apache.mailet"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../index.html?org/apache/mailet/Mailet.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="Mailet.html" target="_top"><B>NO FRAMES</B></A>
+ <SCRIPT type="text/javascript">
+ <!--
+ if(window==top) {
+ document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
+ }
+ //-->
+</SCRIPT>
+<NOSCRIPT>
+ <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
+</NOSCRIPT>
+
+
+</FONT></TD>
+</TR>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+ SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<A NAME="skip-navbar_top"></A>
+<!-- ========= END OF TOP NAVBAR ========= -->
+
+<HR>
+<!-- ======== START OF CLASS DATA ======== -->
+<H2>
+<FONT SIZE="-1">
+org.apache.mailet</FONT>
+<BR>
+Interface Mailet</H2>
+<HR>
+<DL>
+<DT><PRE>public interface <B>Mailet</B></DL>
+</PRE>
+
+<P>
+Draft of a Mailet inteface. The <code>service</code> perform all needed work
+ on the Mail object. Whatever remains at the end of the service is considered
+ to need futher processing and will go to the next Mailet if there is one
+ configured or will go to the error processor if not.
+ Setting a Mail state (setState(String)) to Mail.GHOST or cleaning its recipient
+ list has the same meaning that s no more processing is needed.
+ Instead of creating new messages, the mailet can put a message with new recipients
+ at the top of the mail queue, or insert them immediately after it's execution
+ through the API are provided by the MailetContext interface.
+ <p>
+ This interface defines methods to initialize a mailet, to service messages, and to
+ remove a mailet from the server. These are known as life-cycle methods and are called
+ in the following sequence:
+ <ol>
+ <li>The mailet is constructed, then initialized with the init method. </li>
+ <li>Any messages for the service method are handled.</li>
+ <li>The mailet is taken out of service, then destroyed with the destroy method,
+ then garbage collected and finalized.</li>
+ </ol>
+ In addition to the life-cycle methods, this interface provides the getMailetConfig
+ method, which the mailet can use to get any startup information, and the
+ getMailetInfo method, which allows the mailet to return basic information about itself,
+ such as author, version, and copyright.
+<P>
+
+<P>
+<DL>
+<DT><B>Version:</B></DT>
+ <DD>1.0.0, 24/04/1999</DD>
+</DL>
+<HR>
+
+<P>
+
+<!-- ========== METHOD SUMMARY =========== -->
+
+<A NAME="method_summary"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
+<B>Method Summary</B></FONT></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/mailet/Mailet.html#destroy()">destroy</A></B>()</CODE>
+
+<BR>
+ Called by the mailet container to indicate to a mailet that the
+ mailet is being taken out of service.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> <A HREF="../../../org/apache/mailet/MailetConfig.html" title="interface in org.apache.mailet">MailetConfig</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/mailet/Mailet.html#getMailetConfig()">getMailetConfig</A></B>()</CODE>
+
+<BR>
+ Returns a MailetConfig object, which contains initialization and
+ startup parameters for this mailet.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.lang.String</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/mailet/Mailet.html#getMailetInfo()">getMailetInfo</A></B>()</CODE>
+
+<BR>
+ Returns information about the mailet, such as author, version, and
+ copyright.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/mailet/Mailet.html#init(org.apache.mailet.MailetConfig)">init</A></B>(<A HREF="../../../org/apache/mailet/MailetConfig.html" title="interface in org.apache.mailet">MailetConfig</A> config)</CODE>
+
+<BR>
+ Called by the mailet container to indicate to a mailet that the
+ mailet is being placed into service.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/mailet/Mailet.html#service(org.apache.mailet.Mail)">service</A></B>(<A HREF="../../../org/apache/mailet/Mail.html" title="interface in org.apache.mailet">Mail</A> mail)</CODE>
+
+<BR>
+ Called by the mailet container to allow the mailet to process to
+ a message.</TD>
+</TR>
+</TABLE>
+
+<P>
+
+<!-- ============ METHOD DETAIL ========== -->
+
+<A NAME="method_detail"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Method Detail</B></FONT></TH>
+</TR>
+</TABLE>
+
+<A NAME="destroy()"><!-- --></A><H3>
+destroy</H3>
+<PRE>
+void <B>destroy</B>()</PRE>
+<DL>
+<DD>Called by the mailet container to indicate to a mailet that the
+ mailet is being taken out of service. This method is only called once
+ all threads within the mailet's service method have exited or after a
+ timeout period has passed. After the mailet container calls this method,
+ it will not call the service method again on this mailet.
+ <p>
+ This method gives the mailet an opportunity to clean up any resources that
+ are being held (for example, memory, file handles, threads) and make sure
+ that any persistent state is synchronized with the mailet's current state in memory.
+<P>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getMailetInfo()"><!-- --></A><H3>
+getMailetInfo</H3>
+<PRE>
+java.lang.String <B>getMailetInfo</B>()</PRE>
+<DL>
+<DD>Returns information about the mailet, such as author, version, and
+ copyright.
+ <p>
+ The string that this method returns should be plain text and not markup
+ of any kind (such as HTML, XML, etc.).
+<P>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>a String containing servlet information</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getMailetConfig()"><!-- --></A><H3>
+getMailetConfig</H3>
+<PRE>
+<A HREF="../../../org/apache/mailet/MailetConfig.html" title="interface in org.apache.mailet">MailetConfig</A> <B>getMailetConfig</B>()</PRE>
+<DL>
+<DD>Returns a MailetConfig object, which contains initialization and
+ startup parameters for this mailet.
+ <p>
+ Implementations of this interface are responsible for storing the MailetConfig
+ object so that this method can return it. The GenericMailet class, which implements
+ this interface, already does this.
+<P>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>the MailetConfig object that initializes this mailet</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="init(org.apache.mailet.MailetConfig)"><!-- --></A><H3>
+init</H3>
+<PRE>
+void <B>init</B>(<A HREF="../../../org/apache/mailet/MailetConfig.html" title="interface in org.apache.mailet">MailetConfig</A> config)
+ throws javax.mail.MessagingException</PRE>
+<DL>
+<DD>Called by the mailet container to indicate to a mailet that the
+ mailet is being placed into service.
+ <p>
+ The mailet container calls the init method exactly once after
+ instantiating the mailet. The init method must complete successfully
+ before the mailet can receive any requests.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>config</CODE> - - a MailetConfig object containing the mailet's configuration
+ and initialization parameters
+<DT><B>Throws:</B>
+<DD><CODE>javax.mail.MessagingException</CODE> - - if an exception has occurred that interferes with
+ the mailet's normal operation</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="service(org.apache.mailet.Mail)"><!-- --></A><H3>
+service</H3>
+<PRE>
+void <B>service</B>(<A HREF="../../../org/apache/mailet/Mail.html" title="interface in org.apache.mailet">Mail</A> mail)
+ throws javax.mail.MessagingException</PRE>
+<DL>
+<DD>Called by the mailet container to allow the mailet to process to
+ a message.
+ <p>
+ This method is only called after the mailet's init() method has completed
+ successfully.
+ <p>
+ Mailets typically run inside multithreaded mailet containers that can handle
+ multiple requests concurrently. Developers must be aware to synchronize access
+ to any shared resources such as files, network connections, as well as the
+ mailet's class and instance variables. More information on multithreaded
+ programming in Java is available in <a href="http://java.sun.com/Series/Tutorial/java/threads/multithreaded.html">the
+ Java tutorial on multi-threaded programming</a>.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>mail</CODE> - - the Mail object that contains the message and routing information
+<DT><B>Throws:</B>
+<DD><CODE>javax.mail.MessagingException</CODE> - - if a message or address parsing exception occurs or
+ an exception that interferes with the mailet's normal operation</DL>
+</DD>
+</DL>
+<!-- ========= END OF CLASS DATA ========= -->
+<HR>
+
+
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<A NAME="navbar_bottom"><!-- --></A>
+<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
+<TR>
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_bottom_firstrow"><!-- --></A>
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
+ <TR ALIGN="center" VALIGN="top">
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../org/apache/mailet/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Mailet.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../org/apache/mailet/MailAddress.html" title="class in org.apache.mailet"><B>PREV CLASS</B></A>
+ <A HREF="../../../org/apache/mailet/MailetConfig.html" title="interface in org.apache.mailet"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../index.html?org/apache/mailet/Mailet.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="Mailet.html" target="_top"><B>NO FRAMES</B></A>
+ <SCRIPT type="text/javascript">
+ <!--
+ if(window==top) {
+ document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
+ }
+ //-->
+</SCRIPT>
+<NOSCRIPT>
+ <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
+</NOSCRIPT>
+
+
+</FONT></TD>
+</TR>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+ SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<A NAME="skip-navbar_bottom"></A>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+
+<HR>
+Copyright © 2007-2008 <a href="http://www.apache.org">The Apache Software Foundation</a>. All Rights Reserved.
+</BODY>
+</HTML>
Added: james/site/trunk/www/mailet/api/apidocs/org/apache/mailet/MailetConfig.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/mailet/api/apidocs/org/apache/mailet/MailetConfig.html?rev=688300&view=auto
==============================================================================
--- james/site/trunk/www/mailet/api/apidocs/org/apache/mailet/MailetConfig.html (added)
+++ james/site/trunk/www/mailet/api/apidocs/org/apache/mailet/MailetConfig.html Sat Aug 23 04:34:05 2008
@@ -0,0 +1,297 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!--NewPage-->
+<HTML>
+<HEAD>
+<!-- Generated by javadoc (build 1.5.0_16) on Sat Aug 23 12:29:14 BST 2008 -->
+<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<TITLE>
+MailetConfig (Apache Mailet API 2.4-SNAPSHOT API)
+</TITLE>
+
+<META NAME="keywords" CONTENT="org.apache.mailet.MailetConfig interface">
+
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
+
+<SCRIPT type="text/javascript">
+function windowTitle()
+{
+ parent.document.title="MailetConfig (Apache Mailet API 2.4-SNAPSHOT API)";
+}
+</SCRIPT>
+<NOSCRIPT>
+</NOSCRIPT>
+
+</HEAD>
+
+<BODY BGCOLOR="white" onload="windowTitle();">
+
+
+<!-- ========= START OF TOP NAVBAR ======= -->
+<A NAME="navbar_top"><!-- --></A>
+<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
+<TR>
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_top_firstrow"><!-- --></A>
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
+ <TR ALIGN="center" VALIGN="top">
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../org/apache/mailet/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/MailetConfig.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../org/apache/mailet/Mailet.html" title="interface in org.apache.mailet"><B>PREV CLASS</B></A>
+ <A HREF="../../../org/apache/mailet/MailetContext.html" title="interface in org.apache.mailet"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../index.html?org/apache/mailet/MailetConfig.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="MailetConfig.html" target="_top"><B>NO FRAMES</B></A>
+ <SCRIPT type="text/javascript">
+ <!--
+ if(window==top) {
+ document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
+ }
+ //-->
+</SCRIPT>
+<NOSCRIPT>
+ <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
+</NOSCRIPT>
+
+
+</FONT></TD>
+</TR>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+ SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<A NAME="skip-navbar_top"></A>
+<!-- ========= END OF TOP NAVBAR ========= -->
+
+<HR>
+<!-- ======== START OF CLASS DATA ======== -->
+<H2>
+<FONT SIZE="-1">
+org.apache.mailet</FONT>
+<BR>
+Interface MailetConfig</H2>
+<HR>
+<DL>
+<DT><PRE>public interface <B>MailetConfig</B></DL>
+</PRE>
+
+<P>
+A mailet configuration object used by a mailet container to pass information
+ to a mailet during initialization.
+ <p>
+ The configuration information contains initialization parameters, which are a set
+ of name/value pairs, and a MailetContext object, which gives the mailet information
+ about the server.
+<P>
+
+<P>
+<DL>
+<DT><B>Version:</B></DT>
+ <DD>1.0.0, 24/04/1999</DD>
+</DL>
+<HR>
+
+<P>
+
+<!-- ========== METHOD SUMMARY =========== -->
+
+<A NAME="method_summary"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
+<B>Method Summary</B></FONT></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.lang.String</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/mailet/MailetConfig.html#getInitParameter(java.lang.String)">getInitParameter</A></B>(java.lang.String name)</CODE>
+
+<BR>
+ Returns a String containing the value of the named initialization
+ parameter, or null if the parameter does not exist.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.util.Iterator</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/mailet/MailetConfig.html#getInitParameterNames()">getInitParameterNames</A></B>()</CODE>
+
+<BR>
+ Returns the names of the mailet's initialization parameters as an
+ Iterator of String objects, or an empty Iterator if the mailet has
+ no initialization parameters.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> <A HREF="../../../org/apache/mailet/MailetContext.html" title="interface in org.apache.mailet">MailetContext</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/mailet/MailetConfig.html#getMailetContext()">getMailetContext</A></B>()</CODE>
+
+<BR>
+ Returns a reference to the MailetContext in which the mailet is
+ executing.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.lang.String</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/mailet/MailetConfig.html#getMailetName()">getMailetName</A></B>()</CODE>
+
+<BR>
+ Returns the name of this mailet instance.</TD>
+</TR>
+</TABLE>
+
+<P>
+
+<!-- ============ METHOD DETAIL ========== -->
+
+<A NAME="method_detail"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Method Detail</B></FONT></TH>
+</TR>
+</TABLE>
+
+<A NAME="getInitParameter(java.lang.String)"><!-- --></A><H3>
+getInitParameter</H3>
+<PRE>
+java.lang.String <B>getInitParameter</B>(java.lang.String name)</PRE>
+<DL>
+<DD>Returns a String containing the value of the named initialization
+ parameter, or null if the parameter does not exist.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>name</CODE> - - a String specifying the name of the initialization parameter
+<DT><B>Returns:</B><DD>a String containing the value of the initialization parameter</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getInitParameterNames()"><!-- --></A><H3>
+getInitParameterNames</H3>
+<PRE>
+java.util.Iterator <B>getInitParameterNames</B>()</PRE>
+<DL>
+<DD>Returns the names of the mailet's initialization parameters as an
+ Iterator of String objects, or an empty Iterator if the mailet has
+ no initialization parameters.
+<P>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>an Iterator of String objects containing the names of the mailet's
+ initialization parameters</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getMailetContext()"><!-- --></A><H3>
+getMailetContext</H3>
+<PRE>
+<A HREF="../../../org/apache/mailet/MailetContext.html" title="interface in org.apache.mailet">MailetContext</A> <B>getMailetContext</B>()</PRE>
+<DL>
+<DD>Returns a reference to the MailetContext in which the mailet is
+ executing.
+<P>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>a MailetContext object, used by the mailet to interact with its
+ mailet container</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getMailetName()"><!-- --></A><H3>
+getMailetName</H3>
+<PRE>
+java.lang.String <B>getMailetName</B>()</PRE>
+<DL>
+<DD>Returns the name of this mailet instance. The name may be provided via
+ server administration, assigned in the application deployment descriptor,
+ or for an unregistered (and thus unnamed) mailet instance it will be the
+ mailet's class name.
+<P>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>the name of the mailet instance</DL>
+</DD>
+</DL>
+<!-- ========= END OF CLASS DATA ========= -->
+<HR>
+
+
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<A NAME="navbar_bottom"><!-- --></A>
+<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
+<TR>
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_bottom_firstrow"><!-- --></A>
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
+ <TR ALIGN="center" VALIGN="top">
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../org/apache/mailet/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/MailetConfig.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../org/apache/mailet/Mailet.html" title="interface in org.apache.mailet"><B>PREV CLASS</B></A>
+ <A HREF="../../../org/apache/mailet/MailetContext.html" title="interface in org.apache.mailet"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../index.html?org/apache/mailet/MailetConfig.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="MailetConfig.html" target="_top"><B>NO FRAMES</B></A>
+ <SCRIPT type="text/javascript">
+ <!--
+ if(window==top) {
+ document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
+ }
+ //-->
+</SCRIPT>
+<NOSCRIPT>
+ <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
+</NOSCRIPT>
+
+
+</FONT></TD>
+</TR>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+ SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<A NAME="skip-navbar_bottom"></A>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+
+<HR>
+Copyright © 2007-2008 <a href="http://www.apache.org">The Apache Software Foundation</a>. All Rights Reserved.
+</BODY>
+</HTML>