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 [3/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/MailetContext.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/mailet/api/apidocs/org/apache/mailet/MailetContext.html?rev=688300&view=auto
==============================================================================
--- james/site/trunk/www/mailet/api/apidocs/org/apache/mailet/MailetContext.html (added)
+++ james/site/trunk/www/mailet/api/apidocs/org/apache/mailet/MailetContext.html Sat Aug 23 04:34:05 2008
@@ -0,0 +1,797 @@
+<!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>
+MailetContext (Apache Mailet API 2.4-SNAPSHOT API)
+</TITLE>
+
+<META NAME="keywords" CONTENT="org.apache.mailet.MailetContext interface">
+
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
+
+<SCRIPT type="text/javascript">
+function windowTitle()
+{
+ parent.document.title="MailetContext (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/MailetContext.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/MailetConfig.html" title="interface in org.apache.mailet"><B>PREV CLASS</B></A>
+ <A HREF="../../../org/apache/mailet/MailetException.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/MailetContext.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="MailetContext.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 MailetContext</H2>
+<HR>
+<DL>
+<DT><PRE>public interface <B>MailetContext</B></DL>
+</PRE>
+
+<P>
+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.
+
+ The MailetContext object is contained within the MailetConfig and
+ MatcherConfig objects, which the mailet container provides to the
+ mailets and matchers when they are initialized.
+<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/MailetContext.html#bounce(org.apache.mailet.Mail, java.lang.String)">bounce</A></B>(<A HREF="../../../org/apache/mailet/Mail.html" title="interface in org.apache.mailet">Mail</A> mail,
+ java.lang.String message)</CODE>
+
+<BR>
+ Bounces the message using a standard format with the given 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/MailetContext.html#bounce(org.apache.mailet.Mail, java.lang.String, org.apache.mailet.MailAddress)">bounce</A></B>(<A HREF="../../../org/apache/mailet/Mail.html" title="interface in org.apache.mailet">Mail</A> mail,
+ java.lang.String message,
+ <A HREF="../../../org/apache/mailet/MailAddress.html" title="class in org.apache.mailet">MailAddress</A> bouncer)</CODE>
+
+<BR>
+ Bounces the email message using the provided email address as the
+ sender of the bounce.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.lang.Object</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/mailet/MailetContext.html#getAttribute(java.lang.String)">getAttribute</A></B>(java.lang.String name)</CODE>
+
+<BR>
+ Returns the mailet container 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/MailetContext.html#getAttributeNames()">getAttributeNames</A></B>()</CODE>
+
+<BR>
+ Returns an Iterator containing the attribute names available within
+ this mailet context.</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/MailetContext.html#getMailServers(java.lang.String)">getMailServers</A></B>(java.lang.String host)</CODE>
+
+<BR>
+ Returns a Collection of Strings of hostnames or ip addresses that
+ are specified as mail server listeners for the given hostname.</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/MailetContext.html#getMajorVersion()">getMajorVersion</A></B>()</CODE>
+
+<BR>
+ Returns the major version of the Mailet API that this mailet
+ container supports.</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/MailetContext.html#getMinorVersion()">getMinorVersion</A></B>()</CODE>
+
+<BR>
+ Returns the minor version of the Mailet API that this mailet
+ container supports.</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/MailetContext.html#getPostmaster()">getPostmaster</A></B>()</CODE>
+
+<BR>
+ Returns the postmaster's address for this mailet context.</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/MailetContext.html#getServerInfo()">getServerInfo</A></B>()</CODE>
+
+<BR>
+ Returns the name and version of the mailet container on which
+ the mailet is running.</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/MailetContext.html#getSMTPHostAddresses(java.lang.String)">getSMTPHostAddresses</A></B>(java.lang.String domainName)</CODE>
+
+<BR>
+ 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.</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/MailetContext.html#isLocalEmail(org.apache.mailet.MailAddress)">isLocalEmail</A></B>(<A HREF="../../../org/apache/mailet/MailAddress.html" title="class in org.apache.mailet">MailAddress</A> mailAddress)</CODE>
+
+<BR>
+ Checks if a user account is exists in the mail context.</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/MailetContext.html#isLocalServer(java.lang.String)">isLocalServer</A></B>(java.lang.String serverName)</CODE>
+
+<BR>
+ Checks if a server is serviced by mail context</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/MailetContext.html#isLocalUser(java.lang.String)">isLocalUser</A></B>(java.lang.String userAccount)</CODE>
+
+<BR>
+ <B>Deprecated.</B> <I>use isLocalEmail(MailAddress) instead</I></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/MailetContext.html#log(java.lang.String)">log</A></B>(java.lang.String message)</CODE>
+
+<BR>
+ Writes the specified message to a mailet log file, usually an event
+ log.</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/MailetContext.html#log(java.lang.String, java.lang.Throwable)">log</A></B>(java.lang.String message,
+ java.lang.Throwable t)</CODE>
+
+<BR>
+ Writes an explanatory message and a stack trace for a given Throwable
+ exception to the mailet log file.</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/MailetContext.html#removeAttribute(java.lang.String)">removeAttribute</A></B>(java.lang.String name)</CODE>
+
+<BR>
+ Removes the attribute with the given name from the mailet context.</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/MailetContext.html#sendMail(org.apache.mailet.Mail)">sendMail</A></B>(<A HREF="../../../org/apache/mailet/Mail.html" title="interface in org.apache.mailet">Mail</A> mail)</CODE>
+
+<BR>
+ Send an outgoing message to the top of this mailet container's root queue.</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/MailetContext.html#sendMail(org.apache.mailet.MailAddress, java.util.Collection, javax.mail.internet.MimeMessage)">sendMail</A></B>(<A HREF="../../../org/apache/mailet/MailAddress.html" title="class in org.apache.mailet">MailAddress</A> sender,
+ java.util.Collection recipients,
+ javax.mail.internet.MimeMessage msg)</CODE>
+
+<BR>
+ Send an outgoing message to the top of this mailet container's root queue.</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/MailetContext.html#sendMail(org.apache.mailet.MailAddress, java.util.Collection, javax.mail.internet.MimeMessage, java.lang.String)">sendMail</A></B>(<A HREF="../../../org/apache/mailet/MailAddress.html" title="class in org.apache.mailet">MailAddress</A> sender,
+ java.util.Collection recipients,
+ javax.mail.internet.MimeMessage msg,
+ java.lang.String state)</CODE>
+
+<BR>
+ Send an outgoing message to the top of this mailet container queue for the
+ appropriate processor that is specified.</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/MailetContext.html#sendMail(javax.mail.internet.MimeMessage)">sendMail</A></B>(javax.mail.internet.MimeMessage msg)</CODE>
+
+<BR>
+ Send an outgoing message to the top of this mailet container's root queue.</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/MailetContext.html#setAttribute(java.lang.String, java.lang.Object)">setAttribute</A></B>(java.lang.String name,
+ java.lang.Object object)</CODE>
+
+<BR>
+ Binds an object to a given attribute name in this mailet context.</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/MailetContext.html#storeMail(org.apache.mailet.MailAddress, org.apache.mailet.MailAddress, javax.mail.internet.MimeMessage)">storeMail</A></B>(<A HREF="../../../org/apache/mailet/MailAddress.html" title="class in org.apache.mailet">MailAddress</A> sender,
+ <A HREF="../../../org/apache/mailet/MailAddress.html" title="class in org.apache.mailet">MailAddress</A> recipient,
+ javax.mail.internet.MimeMessage msg)</CODE>
+
+<BR>
+ <B>Deprecated.</B> <I>- use sparingly. Service will be replaced with
+ resource acquired via JNDI.</I></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="bounce(org.apache.mailet.Mail, java.lang.String)"><!-- --></A><H3>
+bounce</H3>
+<PRE>
+void <B>bounce</B>(<A HREF="../../../org/apache/mailet/Mail.html" title="interface in org.apache.mailet">Mail</A> mail,
+ java.lang.String message)
+ throws javax.mail.MessagingException</PRE>
+<DL>
+<DD>Bounces the message using a standard format with the given message.
+ The message will be sent back to the sender from the postmaster as specified for
+ this mailet context, adding message to top of mail server queue using
+ sendMail().
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>mail</CODE> - - the message that is to be bounced and sender to whom to return the message<DD><CODE>message</CODE> - - a descriptive message as to why the message bounced
+<DT><B>Throws:</B>
+<DD><CODE>javax.mail.MessagingException</CODE></DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="bounce(org.apache.mailet.Mail, java.lang.String, org.apache.mailet.MailAddress)"><!-- --></A><H3>
+bounce</H3>
+<PRE>
+void <B>bounce</B>(<A HREF="../../../org/apache/mailet/Mail.html" title="interface in org.apache.mailet">Mail</A> mail,
+ java.lang.String message,
+ <A HREF="../../../org/apache/mailet/MailAddress.html" title="class in org.apache.mailet">MailAddress</A> bouncer)
+ throws javax.mail.MessagingException</PRE>
+<DL>
+<DD>Bounces the email message using the provided email address as the
+ sender of the bounce.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>mail</CODE> - - the message that is to be bounced and sender to whom to return the message<DD><CODE>message</CODE> - - a descriptive message as to why the message bounced<DD><CODE>bouncer</CODE> - - the address to give as the sender of the bounced message
+<DT><B>Throws:</B>
+<DD><CODE>javax.mail.MessagingException</CODE></DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getMailServers(java.lang.String)"><!-- --></A><H3>
+getMailServers</H3>
+<PRE>
+java.util.Collection <B>getMailServers</B>(java.lang.String host)</PRE>
+<DL>
+<DD>Returns a Collection of Strings of hostnames or ip addresses that
+ are specified as mail server listeners for the given hostname.
+ This is done using MX records, and the hostnames or ip addresses
+ are returned sorted by MX priority.
+
+ <p>TODO: This needs to be made a more specific ordered subtype of Collection.</p>
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>host</CODE> - - the domain name for which to find mail servers
+<DT><B>Returns:</B><DD>a Collection of Strings of hostnames, sorted by priority</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getPostmaster()"><!-- --></A><H3>
+getPostmaster</H3>
+<PRE>
+<A HREF="../../../org/apache/mailet/MailAddress.html" title="class in org.apache.mailet">MailAddress</A> <B>getPostmaster</B>()</PRE>
+<DL>
+<DD>Returns the postmaster's address for this mailet context.
+<P>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>a MailAddress of the Postmaster's address</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getAttribute(java.lang.String)"><!-- --></A><H3>
+getAttribute</H3>
+<PRE>
+java.lang.Object <B>getAttribute</B>(java.lang.String name)</PRE>
+<DL>
+<DD>Returns the mailet container attribute with the given name, or null
+ if there is no attribute by that name. An attribute allows a mailet container
+ to give the mailet additional information not already provided by this interface.
+ See your server documentation for information about its attributes. A list of
+ supported 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 Java Mailet API
+ specification reserves names matching java.*, javax.*, and sun.*
+<P>
+<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</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 available within
+ this mailet context. Use the getAttribute(java.lang.String) method with an
+ attribute name to get the value of an attribute.
+<P>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>an Iterator of attribute names</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getMajorVersion()"><!-- --></A><H3>
+getMajorVersion</H3>
+<PRE>
+int <B>getMajorVersion</B>()</PRE>
+<DL>
+<DD>Returns the major version of the Mailet API that this mailet
+ container supports. All implementations that comply with Version 1.2 must have
+ this method return the integer 1.
+<P>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>1</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getMinorVersion()"><!-- --></A><H3>
+getMinorVersion</H3>
+<PRE>
+int <B>getMinorVersion</B>()</PRE>
+<DL>
+<DD>Returns the minor version of the Mailet API that this mailet
+ container supports. All implementations that comply with Version 1.2 must have
+ this method return the integer 2.
+<P>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>2</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getServerInfo()"><!-- --></A><H3>
+getServerInfo</H3>
+<PRE>
+java.lang.String <B>getServerInfo</B>()</PRE>
+<DL>
+<DD>Returns the name and version of the mailet container on which
+ the mailet is running.
+ <p>
+ The form of the returned string is servername/versionnumber. For example,
+ JAMES may return the string JAMES/1.2.
+ <p>
+ The mailet container may return other optional information after the primary
+ string in parentheses, for example, JAMES/1.2 (JDK 1.3.0; Windows NT 4.0 x86).
+<P>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>a String containing at least the mailet container name and version number</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="isLocalServer(java.lang.String)"><!-- --></A><H3>
+isLocalServer</H3>
+<PRE>
+boolean <B>isLocalServer</B>(java.lang.String serverName)</PRE>
+<DL>
+<DD>Checks if a server is serviced by mail context
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>serverName</CODE> - - name of server.
+<DT><B>Returns:</B><DD>true if server is local, i.e. serviced by this mail context</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="isLocalUser(java.lang.String)"><!-- --></A><H3>
+isLocalUser</H3>
+<PRE>
+boolean <B>isLocalUser</B>(java.lang.String userAccount)</PRE>
+<DL>
+<DD><B>Deprecated.</B> <I>use isLocalEmail(MailAddress) instead</I>
+<P>
+<DD>Checks if a user account is exists in the mail context.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>userAccount</CODE> - - user identifier.
+<DT><B>Returns:</B><DD>true if the account is a local account<DT><B>Since:</B></DT>
+ <DD>James 2.4.0 this method expect to receive also the domain
+ name within the userAccount string (user\@domain).
+ By default it will use \@localhost when no domain is passed.</DD>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="isLocalEmail(org.apache.mailet.MailAddress)"><!-- --></A><H3>
+isLocalEmail</H3>
+<PRE>
+boolean <B>isLocalEmail</B>(<A HREF="../../../org/apache/mailet/MailAddress.html" title="class in org.apache.mailet">MailAddress</A> mailAddress)</PRE>
+<DL>
+<DD>Checks if a user account is exists in the mail context.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>mailAddress</CODE> - - address of the account to be checked.
+<DT><B>Returns:</B><DD>true if the account is a local account<DT><B>Since:</B></DT>
+ <DD>James 2.4.0</DD>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="log(java.lang.String)"><!-- --></A><H3>
+log</H3>
+<PRE>
+void <B>log</B>(java.lang.String message)</PRE>
+<DL>
+<DD>Writes the specified message to a mailet log file, usually an event
+ log. The name and type of the mailet log file is specific to the mailet
+ container.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>message</CODE> - - a String specifying the message to be written to the log file</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="log(java.lang.String, java.lang.Throwable)"><!-- --></A><H3>
+log</H3>
+<PRE>
+void <B>log</B>(java.lang.String message,
+ java.lang.Throwable t)</PRE>
+<DL>
+<DD>Writes an explanatory message and a stack trace for a given Throwable
+ exception to the mailet log file.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>message</CODE> - - a String that describes the error or exception<DD><CODE>t</CODE> - - the Throwable error or exception</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="removeAttribute(java.lang.String)"><!-- --></A><H3>
+removeAttribute</H3>
+<PRE>
+void <B>removeAttribute</B>(java.lang.String name)</PRE>
+<DL>
+<DD>Removes the attribute with the given name from the mailet context. After
+ removal, subsequent calls to getAttribute(java.lang.String) to retrieve
+ the attribute's value will return null.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>name</CODE> - - a String specifying the name of the attribute to be removed</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="sendMail(javax.mail.internet.MimeMessage)"><!-- --></A><H3>
+sendMail</H3>
+<PRE>
+void <B>sendMail</B>(javax.mail.internet.MimeMessage msg)
+ throws javax.mail.MessagingException</PRE>
+<DL>
+<DD>Send an outgoing message to the top of this mailet container's root queue.
+ This is the equivalent of opening an SMTP session to localhost.
+ This uses sender and recipients as specified in the message itself.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>msg</CODE> - - the MimeMessage of the headers and body content of the outgoing message
+<DT><B>Throws:</B>
+<DD><CODE>javax.mail.MessagingException</CODE> - - if the message fails to parse</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="sendMail(org.apache.mailet.MailAddress, java.util.Collection, javax.mail.internet.MimeMessage)"><!-- --></A><H3>
+sendMail</H3>
+<PRE>
+void <B>sendMail</B>(<A HREF="../../../org/apache/mailet/MailAddress.html" title="class in org.apache.mailet">MailAddress</A> sender,
+ java.util.Collection recipients,
+ javax.mail.internet.MimeMessage msg)
+ throws javax.mail.MessagingException</PRE>
+<DL>
+<DD>Send an outgoing message to the top of this mailet container's root queue.
+ This is the equivalent of opening an SMTP session to localhost.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>sender</CODE> - - the sender of the message<DD><CODE>recipients</CODE> - - a Collection of MailAddress objects of recipients<DD><CODE>msg</CODE> - - the MimeMessage of the headers and body content of the outgoing message
+<DT><B>Throws:</B>
+<DD><CODE>javax.mail.MessagingException</CODE> - - if the message fails to parse</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="sendMail(org.apache.mailet.MailAddress, java.util.Collection, javax.mail.internet.MimeMessage, java.lang.String)"><!-- --></A><H3>
+sendMail</H3>
+<PRE>
+void <B>sendMail</B>(<A HREF="../../../org/apache/mailet/MailAddress.html" title="class in org.apache.mailet">MailAddress</A> sender,
+ java.util.Collection recipients,
+ javax.mail.internet.MimeMessage msg,
+ java.lang.String state)
+ throws javax.mail.MessagingException</PRE>
+<DL>
+<DD>Send an outgoing message to the top of this mailet container queue for the
+ appropriate processor that is specified.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>sender</CODE> - - the sender of the message<DD><CODE>recipients</CODE> - - a Collection of MailAddress objects of recipients<DD><CODE>msg</CODE> - - the MimeMessage of the headers and body content of the outgoing message<DD><CODE>state</CODE> - - the state of the message, indicates which processor to use
+ This is a String that names a processor for which the message will be queued
+<DT><B>Throws:</B>
+<DD><CODE>javax.mail.MessagingException</CODE> - - if the message fails to parse</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="sendMail(org.apache.mailet.Mail)"><!-- --></A><H3>
+sendMail</H3>
+<PRE>
+void <B>sendMail</B>(<A HREF="../../../org/apache/mailet/Mail.html" title="interface in org.apache.mailet">Mail</A> mail)
+ throws javax.mail.MessagingException</PRE>
+<DL>
+<DD>Send an outgoing message to the top of this mailet container's root queue.
+ This is the equivalent of opening an SMTP session to localhost.
+ The Mail object provides all envelope and content information
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>mail</CODE> - - the message that is to sent
+<DT><B>Throws:</B>
+<DD><CODE>javax.mail.MessagingException</CODE> - - if the message fails to spool</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="setAttribute(java.lang.String, java.lang.Object)"><!-- --></A><H3>
+setAttribute</H3>
+<PRE>
+void <B>setAttribute</B>(java.lang.String name,
+ java.lang.Object object)</PRE>
+<DL>
+<DD>Binds an object to a given attribute name in this mailet context. 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.
+ <p>
+ Attribute names should follow the same convention as package names. The Java
+ Mailet API specification reserves names matching java.*, javax.*, and sun.*.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>name</CODE> - - a String specifying the name of the attribute<DD><CODE>object</CODE> - - an Object representing the attribute to be bound</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="storeMail(org.apache.mailet.MailAddress, org.apache.mailet.MailAddress, javax.mail.internet.MimeMessage)"><!-- --></A><H3>
+storeMail</H3>
+<PRE>
+void <B>storeMail</B>(<A HREF="../../../org/apache/mailet/MailAddress.html" title="class in org.apache.mailet">MailAddress</A> sender,
+ <A HREF="../../../org/apache/mailet/MailAddress.html" title="class in org.apache.mailet">MailAddress</A> recipient,
+ javax.mail.internet.MimeMessage msg)
+ throws javax.mail.MessagingException</PRE>
+<DL>
+<DD><B>Deprecated.</B> <I>- use sparingly. Service will be replaced with
+ resource acquired via JNDI.</I>
+<P>
+<DD>Stores the message is in the local repository associated with
+ recipient for later retrieval, e.g., by a POP3 or IMAP service.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>sender</CODE> - - the sender of the incoming message<DD><CODE>recipient</CODE> - - the user who is receiving this message (as a complete email address)<DD><CODE>msg</CODE> - - the MimeMessage to store in a local mailbox
+<DT><B>Throws:</B>
+<DD><CODE>javax.mail.MessagingException</CODE> - - if the message fails to parse</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getSMTPHostAddresses(java.lang.String)"><!-- --></A><H3>
+getSMTPHostAddresses</H3>
+<PRE>
+java.util.Iterator <B>getSMTPHostAddresses</B>(java.lang.String domainName)</PRE>
+<DL>
+<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. This is done using MX records, and the HostAddress
+ instances are returned sorted by MX priority. If no host is
+ found for domainName, the Iterator returned will be empty and the
+ first call to hasNext() will return false.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>domainName</CODE> - - the domain for which to find mail servers
+<DT><B>Returns:</B><DD>an Iterator over HostAddress instances, sorted by priority<DT><B>Since:</B></DT>
+ <DD>Mailet API v2.2.0a16-unstable</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/MailetContext.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/MailetConfig.html" title="interface in org.apache.mailet"><B>PREV CLASS</B></A>
+ <A HREF="../../../org/apache/mailet/MailetException.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/MailetContext.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="MailetContext.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/MailetException.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/mailet/api/apidocs/org/apache/mailet/MailetException.html?rev=688300&view=auto
==============================================================================
--- james/site/trunk/www/mailet/api/apidocs/org/apache/mailet/MailetException.html (added)
+++ james/site/trunk/www/mailet/api/apidocs/org/apache/mailet/MailetException.html Sat Aug 23 04:34:05 2008
@@ -0,0 +1,294 @@
+<!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>
+MailetException (Apache Mailet API 2.4-SNAPSHOT API)
+</TITLE>
+
+<META NAME="keywords" CONTENT="org.apache.mailet.MailetException class">
+
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
+
+<SCRIPT type="text/javascript">
+function windowTitle()
+{
+ parent.document.title="MailetException (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/MailetException.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/MailetContext.html" title="interface in org.apache.mailet"><B>PREV CLASS</B></A>
+ <A HREF="../../../org/apache/mailet/Matcher.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/MailetException.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="MailetException.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 | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#methods_inherited_from_class_javax.mail.MessagingException">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | METHOD</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 MailetException</H2>
+<PRE>
+java.lang.Object
+ <IMG SRC="../../../resources/inherit.gif" ALT="extended by ">java.lang.Throwable
+ <IMG SRC="../../../resources/inherit.gif" ALT="extended by ">java.lang.Exception
+ <IMG SRC="../../../resources/inherit.gif" ALT="extended by ">javax.mail.MessagingException
+ <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>org.apache.mailet.MailetException</B>
+</PRE>
+<DL>
+<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable</DD>
+</DL>
+<HR>
+<DL>
+<DT><PRE>public class <B>MailetException</B><DT>extends javax.mail.MessagingException</DL>
+</PRE>
+
+<P>
+Defines a general exception a mailet can throw when it encounters difficulty.
+<P>
+
+<P>
+<DL>
+<DT><B>Version:</B></DT>
+ <DD>1.0.0, 24/04/1999</DD>
+<DT><B>See Also:</B><DD><A HREF="../../../serialized-form.html#org.apache.mailet.MailetException">Serialized Form</A></DL>
+<HR>
+
+<P>
+
+<!-- ======== 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/MailetException.html#MailetException()">MailetException</A></B>()</CODE>
+
+<BR>
+ Constructs a new mailet exception.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE><B><A HREF="../../../org/apache/mailet/MailetException.html#MailetException(java.lang.String)">MailetException</A></B>(java.lang.String message)</CODE>
+
+<BR>
+ Constructs a new mailet exception with the specified message.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE><B><A HREF="../../../org/apache/mailet/MailetException.html#MailetException(java.lang.String, java.lang.Exception)">MailetException</A></B>(java.lang.String message,
+ java.lang.Exception e)</CODE>
+
+<BR>
+ 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.</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>
+</TABLE>
+ <A NAME="methods_inherited_from_class_javax.mail.MessagingException"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
+<TH ALIGN="left"><B>Methods inherited from class javax.mail.MessagingException</B></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE>getCause, getNextException, setNextException, toString</CODE></TD>
+</TR>
+</TABLE>
+ <A NAME="methods_inherited_from_class_java.lang.Throwable"><!-- --></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.Throwable</B></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE>fillInStackTrace, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace</CODE></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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
+</TR>
+</TABLE>
+
+<P>
+
+<!-- ========= 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="MailetException()"><!-- --></A><H3>
+MailetException</H3>
+<PRE>
+public <B>MailetException</B>()</PRE>
+<DL>
+<DD>Constructs a new mailet exception.
+<P>
+</DL>
+<HR>
+
+<A NAME="MailetException(java.lang.String)"><!-- --></A><H3>
+MailetException</H3>
+<PRE>
+public <B>MailetException</B>(java.lang.String message)</PRE>
+<DL>
+<DD>Constructs a new mailet exception with the specified message.
+<P>
+</DL>
+<HR>
+
+<A NAME="MailetException(java.lang.String, java.lang.Exception)"><!-- --></A><H3>
+MailetException</H3>
+<PRE>
+public <B>MailetException</B>(java.lang.String message,
+ java.lang.Exception e)</PRE>
+<DL>
+<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.
+<P>
+</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/MailetException.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/MailetContext.html" title="interface in org.apache.mailet"><B>PREV CLASS</B></A>
+ <A HREF="../../../org/apache/mailet/Matcher.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/MailetException.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="MailetException.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 | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#methods_inherited_from_class_javax.mail.MessagingException">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | METHOD</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/Matcher.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/mailet/api/apidocs/org/apache/mailet/Matcher.html?rev=688300&view=auto
==============================================================================
--- james/site/trunk/www/mailet/api/apidocs/org/apache/mailet/Matcher.html (added)
+++ james/site/trunk/www/mailet/api/apidocs/org/apache/mailet/Matcher.html Sat Aug 23 04:34:05 2008
@@ -0,0 +1,382 @@
+<!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>
+Matcher (Apache Mailet API 2.4-SNAPSHOT API)
+</TITLE>
+
+<META NAME="keywords" CONTENT="org.apache.mailet.Matcher interface">
+
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
+
+<SCRIPT type="text/javascript">
+function windowTitle()
+{
+ parent.document.title="Matcher (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/Matcher.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/MailetException.html" title="class in org.apache.mailet"><B>PREV CLASS</B></A>
+ <A HREF="../../../org/apache/mailet/MatcherConfig.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/Matcher.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="Matcher.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 Matcher</H2>
+<HR>
+<DL>
+<DT><PRE>public interface <B>Matcher</B></DL>
+</PRE>
+
+<P>
+This interface define the behaviour of the message "routing" inside
+ the mailet container. The match(Mail) method returns a Collection of
+ recipients that meet this class's criteria.
+ <p>
+ An important feature of the mailet container is the ability to fork
+ processing of messages. When a message first arrives at the server,
+ it might have multiple recipients specified. As a message is passed
+ to a matcher, the matcher might only "match" one of the listed
+ recipients. It would then return only the matching recipient in
+ the Collection. The mailet container should then duplicate the
+ message splitting the recipient list across the two messages as per
+ what the matcher returned.
+ <p>
+ <b>[THIS PARAGRAPH NOT YET IMPLEMENTED]</b>
+ <i>The matcher can extend this forking to further separation by returning
+ a Collection of Collection objects. This allows a matcher to fork
+ multiple processes if there are multiple recipients that require
+ separate processing. For example, we could write a ListservMatcher
+ that handles multiple listservs. When someone cross-posts across
+ multiple listservs that this matcher handles, it could put each
+ listserv address (recipient) that it handles in a separate Collection
+ object. By returning each of these Collections within a container
+ Collection object, it could indicate to the mailet container how
+ many forks to spawn.</i>
+ <p>
+ This interface defines methods to initialize a matcher, to match
+ messages, and to remove a matcher from the server. These are known
+ as life-cycle methods and are called in the following sequence:
+ <ol>
+ <li>The matcher is constructed, then initialized with the init method.</li>
+ <li>Any calls from clients to the match method are handled.</li>
+ <li>The matcher 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
+ getMatcherConfig method, which the matcher can use to get any startup
+ information, and the getMatcherInfo method, which allows the matcher
+ 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/Matcher.html#destroy()">destroy</A></B>()</CODE>
+
+<BR>
+ Called by the mailet container to indicate to a matcher that the matcher
+ 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/MatcherConfig.html" title="interface in org.apache.mailet">MatcherConfig</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/mailet/Matcher.html#getMatcherConfig()">getMatcherConfig</A></B>()</CODE>
+
+<BR>
+ Returns a MatcherConfig object, which contains initialization and
+ startup parameters for this matcher.</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/Matcher.html#getMatcherInfo()">getMatcherInfo</A></B>()</CODE>
+
+<BR>
+ Returns information about the matcher, 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/Matcher.html#init(org.apache.mailet.MatcherConfig)">init</A></B>(<A HREF="../../../org/apache/mailet/MatcherConfig.html" title="interface in org.apache.mailet">MatcherConfig</A> config)</CODE>
+
+<BR>
+ Called by the mailet container to indicate to a matcher that the
+ matcher is being placed into service.</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/Matcher.html#match(org.apache.mailet.Mail)">match</A></B>(<A HREF="../../../org/apache/mailet/Mail.html" title="interface in org.apache.mailet">Mail</A> mail)</CODE>
+
+<BR>
+ Takes a Mail message, looks at any pertinent information, and then returns a subset
+ of recipients that meet the "match" conditions.</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 matcher that the matcher
+ is being taken out of service. This method is only called once all threads
+ within the matcher's service method have exited or after a timeout period
+ has passed. After the mailet container calls this method, it will not call
+ the match method again on this matcher.
+ <p>
+ This method gives the matcher 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 matcher's current state in memory.
+<P>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getMatcherConfig()"><!-- --></A><H3>
+getMatcherConfig</H3>
+<PRE>
+<A HREF="../../../org/apache/mailet/MatcherConfig.html" title="interface in org.apache.mailet">MatcherConfig</A> <B>getMatcherConfig</B>()</PRE>
+<DL>
+<DD>Returns a MatcherConfig object, which contains initialization and
+ startup parameters for this matcher.
+ <p>
+ Implementations of this interface are responsible for storing the
+ MatcherConfig object so that this method can return it. The GenericMatcher
+ class, which implements this interface, already does this.
+<P>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>the MatcherConfig object that initializes this matcher</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getMatcherInfo()"><!-- --></A><H3>
+getMatcherInfo</H3>
+<PRE>
+java.lang.String <B>getMatcherInfo</B>()</PRE>
+<DL>
+<DD>Returns information about the matcher, 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 matcher information</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="init(org.apache.mailet.MatcherConfig)"><!-- --></A><H3>
+init</H3>
+<PRE>
+void <B>init</B>(<A HREF="../../../org/apache/mailet/MatcherConfig.html" title="interface in org.apache.mailet">MatcherConfig</A> config)
+ throws javax.mail.MessagingException</PRE>
+<DL>
+<DD>Called by the mailet container to indicate to a matcher that the
+ matcher is being placed into service.
+ <p>
+ The mailet container calls the init method exactly once after instantiating
+ the matcher. The init method must complete successfully before the matcher
+ can receive any messages.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>config</CODE> - - a MatcherConfig object containing the matcher's configuration
+ and initialization parameters
+<DT><B>Throws:</B>
+<DD><CODE>javax.mail.MessagingException</CODE> - - if an exception has occurred that
+ interferes with the matcher's normal operation</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="match(org.apache.mailet.Mail)"><!-- --></A><H3>
+match</H3>
+<PRE>
+java.util.Collection <B>match</B>(<A HREF="../../../org/apache/mailet/Mail.html" title="interface in org.apache.mailet">Mail</A> mail)
+ throws javax.mail.MessagingException</PRE>
+<DL>
+<DD>Takes a Mail message, looks at any pertinent information, and then returns a subset
+ of recipients that meet the "match" conditions.
+ <p>
+ This method is only called after the matcher's init() method has completed
+ successfully.
+ <p>
+ Matchers 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, and as well as the
+ matcher'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>Returns:</B><DD>a Collection of String objects (recipients) that meet the match criteria
+<DT><B>Throws:</B>
+<DD><CODE>javax.mail.MessagingException</CODE> - - if an message or address parsing exception occurs or
+ an exception that interferes with the matcher'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/Matcher.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/MailetException.html" title="class in org.apache.mailet"><B>PREV CLASS</B></A>
+ <A HREF="../../../org/apache/mailet/MatcherConfig.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/Matcher.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="Matcher.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/MatcherConfig.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/mailet/api/apidocs/org/apache/mailet/MatcherConfig.html?rev=688300&view=auto
==============================================================================
--- james/site/trunk/www/mailet/api/apidocs/org/apache/mailet/MatcherConfig.html (added)
+++ james/site/trunk/www/mailet/api/apidocs/org/apache/mailet/MatcherConfig.html Sat Aug 23 04:34:05 2008
@@ -0,0 +1,268 @@
+<!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>
+MatcherConfig (Apache Mailet API 2.4-SNAPSHOT API)
+</TITLE>
+
+<META NAME="keywords" CONTENT="org.apache.mailet.MatcherConfig interface">
+
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
+
+<SCRIPT type="text/javascript">
+function windowTitle()
+{
+ parent.document.title="MatcherConfig (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/MatcherConfig.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/Matcher.html" title="interface in org.apache.mailet"><B>PREV CLASS</B></A>
+ NEXT CLASS</FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../index.html?org/apache/mailet/MatcherConfig.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="MatcherConfig.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 MatcherConfig</H2>
+<HR>
+<DL>
+<DT><PRE>public interface <B>MatcherConfig</B></DL>
+</PRE>
+
+<P>
+A matcher configuration object used by a mailet container used to pass information
+ to a matcher during initialization.
+ <p>
+ The configuration information contains an initialization parameter,
+ which is set as a condition String, and a MailetContext object,
+ which gives the mailet information about the mailet container.
+<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/MatcherConfig.html#getCondition()">getCondition</A></B>()</CODE>
+
+<BR>
+ The simple condition defined for this matcher, e.g., for
+ SenderIs=admin@localhost, this would return admin@localhost.</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/MatcherConfig.html#getMailetContext()">getMailetContext</A></B>()</CODE>
+
+<BR>
+ Returns a reference to the MailetContext in which the matcher 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/MatcherConfig.html#getMatcherName()">getMatcherName</A></B>()</CODE>
+
+<BR>
+ Returns the name of this matcher 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="getCondition()"><!-- --></A><H3>
+getCondition</H3>
+<PRE>
+java.lang.String <B>getCondition</B>()</PRE>
+<DL>
+<DD>The simple condition defined for this matcher, e.g., for
+ SenderIs=admin@localhost, this would return admin@localhost.
+<P>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>a String containing the value of the initialization parameter</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 matcher is executing
+<P>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>a MailetContext object, used by the matcher to interact with its
+ mailet container</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getMatcherName()"><!-- --></A><H3>
+getMatcherName</H3>
+<PRE>
+java.lang.String <B>getMatcherName</B>()</PRE>
+<DL>
+<DD>Returns the name of this matcher instance. The name may be provided via server
+ administration, assigned in the application deployment descriptor, or for
+ an unregistered (and thus unnamed) matcher instance it will be the matcher's
+ class name.
+<P>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>the name of the matcher 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/MatcherConfig.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/Matcher.html" title="interface in org.apache.mailet"><B>PREV CLASS</B></A>
+ NEXT CLASS</FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../index.html?org/apache/mailet/MatcherConfig.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="MatcherConfig.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/class-use/HostAddress.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/mailet/api/apidocs/org/apache/mailet/class-use/HostAddress.html?rev=688300&view=auto
==============================================================================
--- james/site/trunk/www/mailet/api/apidocs/org/apache/mailet/class-use/HostAddress.html (added)
+++ james/site/trunk/www/mailet/api/apidocs/org/apache/mailet/class-use/HostAddress.html Sat Aug 23 04:34:05 2008
@@ -0,0 +1,139 @@
+<!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>
+Uses of Class org.apache.mailet.HostAddress (Apache Mailet API 2.4-SNAPSHOT API)
+</TITLE>
+
+
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
+
+<SCRIPT type="text/javascript">
+function windowTitle()
+{
+ parent.document.title="Uses of Class org.apache.mailet.HostAddress (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="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../org/apache/mailet/HostAddress.html" title="class in org.apache.mailet"><FONT CLASS="NavBarFont1"><B>Class</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Use</B></FONT> </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">
+ PREV
+ NEXT</FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../../index.html?org/apache/mailet/class-use/HostAddress.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="HostAddress.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>
+</TABLE>
+<A NAME="skip-navbar_top"></A>
+<!-- ========= END OF TOP NAVBAR ========= -->
+
+<HR>
+<CENTER>
+<H2>
+<B>Uses of Class<br>org.apache.mailet.HostAddress</B></H2>
+</CENTER>
+No usage of org.apache.mailet.HostAddress
+<P>
+<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="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../org/apache/mailet/HostAddress.html" title="class in org.apache.mailet"><FONT CLASS="NavBarFont1"><B>Class</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Use</B></FONT> </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">
+ PREV
+ NEXT</FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../../index.html?org/apache/mailet/class-use/HostAddress.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="HostAddress.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>
+</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>