You are viewing a plain text version of this content. The canonical link for it is here.
Posted to server-dev@james.apache.org by ch...@apache.org on 2001/05/18 12:00:52 UTC
cvs commit: jakarta-james/www/mailet/org/apache/mailet GenericMailet.html GenericMatcher.html GenericRecipientMatcher.html Mail.html MailAddress.html Mailet.html MailetConfig.html MailetContext.html MailetException.html Matcher.html MatcherConfig.html package-frame.html package-summary.html package-tree.html
charlesb 01/05/18 03:00:51
Modified: . build.xml
Added: www/mailet allclasses-frame.html deprecated-list.html
help-doc.html index-all.html index.html
overview-tree.html package-list packages.html
serialized-form.html stylesheet.css
www/mailet/org/apache/mailet GenericMailet.html
GenericMatcher.html GenericRecipientMatcher.html
Mail.html MailAddress.html Mailet.html
MailetConfig.html MailetContext.html
MailetException.html Matcher.html
MatcherConfig.html package-frame.html
package-summary.html package-tree.html
Log:
Moving to www dir
Revision Changes Path
1.66 +3 -2 jakarta-james/build.xml
Index: build.xml
===================================================================
RCS file: /home/cvs/jakarta-james/build.xml,v
retrieving revision 1.65
retrieving revision 1.66
diff -u -r1.65 -r1.66
--- build.xml 2001/05/17 16:49:47 1.65
+++ build.xml 2001/05/18 10:00:42 1.66
@@ -552,11 +552,12 @@
-->
<target name="site-docs" depends="local-xdocs">
- <!-- delete all old documents but keep CVS directories -->
+ <!-- delete old documents but keep CVS directories, rfclist and mailet
+ api -->
<!-- note that by doing an include the defaultexcludes (CVS dirs) will be kept -->
<delete>
<fileset dir="${www.dir}">
- <include name="**"/>
+ <include name="*"/>
</fileset>
</delete>
1.1 jakarta-james/www/mailet/allclasses-frame.html
Index: allclasses-frame.html
===================================================================
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc on Tue Sep 12 18:58:54 EDT 2000 -->
<TITLE>
All Classes
</TITLE>
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
</HEAD>
<BODY BGCOLOR="white">
<FONT size="+1" ID="FrameHeadingFont">
<B>All Classes</B></FONT>
<BR>
<TABLE BORDER="0" WIDTH="100%">
<TR>
<TD NOWRAP><FONT ID="FrameItemFont"><A HREF="org/apache/mailet/GenericMailet.html" TARGET="classFrame">GenericMailet</A>
<BR>
<A HREF="org/apache/mailet/GenericMatcher.html" TARGET="classFrame">GenericMatcher</A>
<BR>
<A HREF="org/apache/mailet/GenericRecipientMatcher.html" TARGET="classFrame">GenericRecipientMatcher</A>
<BR>
<A HREF="org/apache/mailet/Mail.html" TARGET="classFrame"><I>Mail</I></A>
<BR>
<A HREF="org/apache/mailet/MailAddress.html" TARGET="classFrame">MailAddress</A>
<BR>
<A HREF="org/apache/mailet/Mailet.html" TARGET="classFrame"><I>Mailet</I></A>
<BR>
<A HREF="org/apache/mailet/MailetConfig.html" TARGET="classFrame"><I>MailetConfig</I></A>
<BR>
<A HREF="org/apache/mailet/MailetContext.html" TARGET="classFrame"><I>MailetContext</I></A>
<BR>
<A HREF="org/apache/mailet/MailetException.html" TARGET="classFrame">MailetException</A>
<BR>
<A HREF="org/apache/mailet/Matcher.html" TARGET="classFrame"><I>Matcher</I></A>
<BR>
<A HREF="org/apache/mailet/MatcherConfig.html" TARGET="classFrame"><I>MatcherConfig</I></A>
<BR>
</FONT></TD>
</TR>
</TABLE>
</BODY>
</HTML>
1.1 jakarta-james/www/mailet/deprecated-list.html
Index: deprecated-list.html
===================================================================
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc on Tue Sep 12 18:58:54 EDT 2000 -->
<TITLE>
: Deprecated List
</TITLE>
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
</HEAD>
<BODY BGCOLOR="white">
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_top"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" ID="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <FONT ID="NavBarFont1">Package</FONT> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <FONT ID="NavBarFont1">Class</FONT> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="org/apache/mailet/package-tree.html"><FONT ID="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" ID="NavBarCell1Rev"> <FONT ID="NavBarFont1Rev"><B>Deprecated</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="index-all.html"><FONT ID="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="help-doc.html"><FONT ID="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" ID="NavBarCell2"><FONT SIZE="-2">
PREV
NEXT</FONT></TD>
<TD BGCOLOR="white" ID="NavBarCell2"><FONT SIZE="-2">
<A HREF="index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="deprecated-list.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
<CENTER>
<H2>
<B>Deprecated API</B></H2>
</CENTER>
<HR>
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_bottom"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" ID="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <FONT ID="NavBarFont1">Package</FONT> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <FONT ID="NavBarFont1">Class</FONT> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="org/apache/mailet/package-tree.html"><FONT ID="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" ID="NavBarCell1Rev"> <FONT ID="NavBarFont1Rev"><B>Deprecated</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="index-all.html"><FONT ID="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="help-doc.html"><FONT ID="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" ID="NavBarCell2"><FONT SIZE="-2">
PREV
NEXT</FONT></TD>
<TD BGCOLOR="white" ID="NavBarCell2"><FONT SIZE="-2">
<A HREF="index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="deprecated-list.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
</BODY>
</HTML>
1.1 jakarta-james/www/mailet/help-doc.html
Index: help-doc.html
===================================================================
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc on Tue Sep 12 18:58:55 EDT 2000 -->
<TITLE>
: API Help
</TITLE>
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
</HEAD>
<BODY BGCOLOR="white">
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_top"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" ID="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <FONT ID="NavBarFont1">Package</FONT> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <FONT ID="NavBarFont1">Class</FONT> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="org/apache/mailet/package-tree.html"><FONT ID="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="deprecated-list.html"><FONT ID="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="index-all.html"><FONT ID="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" ID="NavBarCell1Rev"> <FONT ID="NavBarFont1Rev"><B>Help</B></FONT> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" ID="NavBarCell2"><FONT SIZE="-2">
PREV
NEXT</FONT></TD>
<TD BGCOLOR="white" ID="NavBarCell2"><FONT SIZE="-2">
<A HREF="index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="help-doc.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
<CENTER>
<H1>
How This API Document Is Organized</H1>
</CENTER>
This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.<H3>
Package</H3>
<BLOCKQUOTE>
<P>
Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain four categories:<UL>
<LI>Interfaces (italic)<LI>Classes<LI>Exceptions<LI>Errors</UL>
</BLOCKQUOTE>
<H3>
Class/Interface</H3>
<BLOCKQUOTE>
<P>
Each class, interface, inner class and inner interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:<UL>
<LI>Class inheritance diagram<LI>Direct Subclasses<LI>All Known Subinterfaces<LI>All Known Implementing Classes<LI>Class/interface declaration<LI>Class/interface description
<P>
<LI>Inner Class Summary<LI>Field Summary<LI>Constructor Summary<LI>Method Summary
<P>
<LI>Field Detail<LI>Constructor Detail<LI>Method Detail</UL>
Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.</BLOCKQUOTE>
<H3>
Tree (Class Hierarchy)</H3>
<BLOCKQUOTE>
There is a <A HREF="overview-tree.html">Class Hierarchy</A> page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with <code>java.lang.Object</code>. The interfaces do not inherit from <code>java.lang.Object</code>.<UL>
<LI>When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.<LI>When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.</UL>
</BLOCKQUOTE>
<H3>
Deprecated API</H3>
<BLOCKQUOTE>
The <A HREF="deprecated-list.html">Deprecated API</A> page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.</BLOCKQUOTE>
<H3>
Index</H3>
<BLOCKQUOTE>
The <A HREF="index-all.html">Index</A> contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.</BLOCKQUOTE>
<H3>
Prev/Next</H3>
These links take you to the next or previous class, interface, package, or related page.<H3>
Frames/No Frames</H3>
These links show and hide the HTML frames. All pages are available with or without frames.
<P>
<H3>
Serialized Form</H3>
Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.
<P>
<FONT SIZE="-1">
<EM>
This help file applies to API documentation generated using the standard doclet. </EM>
</FONT>
<BR>
<HR>
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_bottom"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" ID="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <FONT ID="NavBarFont1">Package</FONT> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <FONT ID="NavBarFont1">Class</FONT> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="org/apache/mailet/package-tree.html"><FONT ID="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="deprecated-list.html"><FONT ID="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="index-all.html"><FONT ID="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" ID="NavBarCell1Rev"> <FONT ID="NavBarFont1Rev"><B>Help</B></FONT> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" ID="NavBarCell2"><FONT SIZE="-2">
PREV
NEXT</FONT></TD>
<TD BGCOLOR="white" ID="NavBarCell2"><FONT SIZE="-2">
<A HREF="index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="help-doc.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
</BODY>
</HTML>
1.1 jakarta-james/www/mailet/index-all.html
Index: index-all.html
===================================================================
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc on Tue Sep 12 18:58:54 EDT 2000 -->
<TITLE>
: Index
</TITLE>
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
</HEAD>
<BODY BGCOLOR="white">
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_top"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" ID="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <FONT ID="NavBarFont1">Package</FONT> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <FONT ID="NavBarFont1">Class</FONT> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="org/apache/mailet/package-tree.html"><FONT ID="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="deprecated-list.html"><FONT ID="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" ID="NavBarCell1Rev"> <FONT ID="NavBarFont1Rev"><B>Index</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="help-doc.html"><FONT ID="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" ID="NavBarCell2"><FONT SIZE="-2">
PREV
NEXT</FONT></TD>
<TD BGCOLOR="white" ID="NavBarCell2"><FONT SIZE="-2">
<A HREF="index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="index-all.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<A HREF="#_B_">B</A> <A HREF="#_D_">D</A> <A HREF="#_E_">E</A> <A HREF="#_G_">G</A> <A HREF="#_I_">I</A> <A HREF="#_L_">L</A> <A HREF="#_M_">M</A> <A HREF="#_O_">O</A> <A HREF="#_R_">R</A> <A HREF="#_S_">S</A> <A HREF="#_T_">T</A> <A HREF="#_W_">W</A> <HR>
<A NAME="_B_"><!-- --></A><H2>
<B>B</B></H2>
<DL>
<DT><A HREF="org/apache/mailet/MailetContext.html#bounce(org.apache.mailet.Mail, java.lang.String)"><B>bounce(Mail, String)</B></A> -
Method in interface org.apache.mailet.<A HREF="org/apache/mailet/MailetContext.html">MailetContext</A>
<DD>Bounces the message using a stanard format with the given message.
<DT><A HREF="org/apache/mailet/MailetContext.html#bounce(org.apache.mailet.Mail, java.lang.String, java.lang.String)"><B>bounce(Mail, String, String)</B></A> -
Method in interface org.apache.mailet.<A HREF="org/apache/mailet/MailetContext.html">MailetContext</A>
<DD>Bounces the email message using the provided email address as the
sender of the bounce.
</DL>
<HR>
<A NAME="_D_"><!-- --></A><H2>
<B>D</B></H2>
<DL>
<DT><A HREF="org/apache/mailet/Mail.html#DEFAULT"><B>DEFAULT</B></A> -
Static variable in interface org.apache.mailet.<A HREF="org/apache/mailet/Mail.html">Mail</A>
<DD>
<DT><A HREF="org/apache/mailet/Mailet.html#destroy()"><B>destroy()</B></A> -
Method in interface org.apache.mailet.<A HREF="org/apache/mailet/Mailet.html">Mailet</A>
<DD>Called by the mailet container to indicate to a mailet that the
mailet is being taken out of service.
<DT><A HREF="org/apache/mailet/Matcher.html#destroy()"><B>destroy()</B></A> -
Method in interface org.apache.mailet.<A HREF="org/apache/mailet/Matcher.html">Matcher</A>
<DD>Called by the mailet container to indicate to a matcher that the matcher
is being taken out of service.
<DT><A HREF="org/apache/mailet/GenericMatcher.html#destroy()"><B>destroy()</B></A> -
Method in class org.apache.mailet.<A HREF="org/apache/mailet/GenericMatcher.html">GenericMatcher</A>
<DD>Called by the mailet container to indicate to a matcher that the
matcher is being taken out of service.
<DT><A HREF="org/apache/mailet/GenericMailet.html#destroy()"><B>destroy()</B></A> -
Method in class org.apache.mailet.<A HREF="org/apache/mailet/GenericMailet.html">GenericMailet</A>
<DD>Called by the mailer container to indicate to a mailet that the
mailet is being taken out of service.
</DL>
<HR>
<A NAME="_E_"><!-- --></A><H2>
<B>E</B></H2>
<DL>
<DT><A HREF="org/apache/mailet/MailAddress.html#equals(java.lang.Object)"><B>equals(Object)</B></A> -
Method in class org.apache.mailet.<A HREF="org/apache/mailet/MailAddress.html">MailAddress</A>
<DD>
<DT><A HREF="org/apache/mailet/Mail.html#ERROR"><B>ERROR</B></A> -
Static variable in interface org.apache.mailet.<A HREF="org/apache/mailet/Mail.html">Mail</A>
<DD>
</DL>
<HR>
<A NAME="_G_"><!-- --></A><H2>
<B>G</B></H2>
<DL>
<DT><A HREF="org/apache/mailet/GenericMailet.html"><B>GenericMailet</B></A> - class org.apache.mailet.<A HREF="org/apache/mailet/GenericMailet.html">GenericMailet</A>.<DD>GenericMailet makes writing mailets easier.<DT><A HREF="org/apache/mailet/GenericMailet.html#GenericMailet()"><B>GenericMailet()</B></A> -
Constructor for class org.apache.mailet.<A HREF="org/apache/mailet/GenericMailet.html">GenericMailet</A>
<DD>
<DT><A HREF="org/apache/mailet/GenericMatcher.html"><B>GenericMatcher</B></A> - class org.apache.mailet.<A HREF="org/apache/mailet/GenericMatcher.html">GenericMatcher</A>.<DD>GenericMatcher implements the Matcher and MatcherConfig interfaces.<DT><A HREF="org/apache/mailet/GenericMatcher.html#GenericMatcher()"><B>GenericMatcher()</B></A> -
Constructor for class org.apache.mailet.<A HREF="org/apache/mailet/GenericMatcher.html">GenericMatcher</A>
<DD>
<DT><A HREF="org/apache/mailet/GenericRecipientMatcher.html"><B>GenericRecipientMatcher</B></A> - class org.apache.mailet.<A HREF="org/apache/mailet/GenericRecipientMatcher.html">GenericRecipientMatcher</A>.<DD>GenericMatcher makes writing recipient based matchers easier.<DT><A HREF="org/apache/mailet/GenericRecipientMatcher.html#GenericRecipientMatcher()"><B>GenericRecipientMatcher()</B></A> -
Constructor for class org.apache.mailet.<A HREF="org/apache/mailet/GenericRecipientMatcher.html">GenericRecipientMatcher</A>
<DD>
<DT><A HREF="org/apache/mailet/MailetContext.html#getAttribute(java.lang.String)"><B>getAttribute(String)</B></A> -
Method in interface org.apache.mailet.<A HREF="org/apache/mailet/MailetContext.html">MailetContext</A>
<DD>Returns the mailet container attribute with the given name, or null
if there is no attribute by that name.
<DT><A HREF="org/apache/mailet/MailetContext.html#getAttributeNames()"><B>getAttributeNames()</B></A> -
Method in interface org.apache.mailet.<A HREF="org/apache/mailet/MailetContext.html">MailetContext</A>
<DD>Returns an Iterator containing the attribute names available within
this mailet context.
<DT><A HREF="org/apache/mailet/GenericMatcher.html#getCondition()"><B>getCondition()</B></A> -
Method in class org.apache.mailet.<A HREF="org/apache/mailet/GenericMatcher.html">GenericMatcher</A>
<DD>Returns a String containing the value of the named initialization
parameter, or null if the parameter does not exist.
<DT><A HREF="org/apache/mailet/MatcherConfig.html#getCondition()"><B>getCondition()</B></A> -
Method in interface org.apache.mailet.<A HREF="org/apache/mailet/MatcherConfig.html">MatcherConfig</A>
<DD>The simple condition defined for this matcher, e.g., for
SenderIs=admin@localhost, this would return admin@localhost.
<DT><A HREF="org/apache/mailet/Mail.html#getErrorMessage()"><B>getErrorMessage()</B></A> -
Method in interface org.apache.mailet.<A HREF="org/apache/mailet/Mail.html">Mail</A>
<DD>The error message, if any, associated with this message.
<DT><A HREF="org/apache/mailet/MailAddress.html#getHost()"><B>getHost()</B></A> -
Method in class org.apache.mailet.<A HREF="org/apache/mailet/MailAddress.html">MailAddress</A>
<DD>Return the host part.
<DT><A HREF="org/apache/mailet/MailetConfig.html#getInitParameter(java.lang.String)"><B>getInitParameter(String)</B></A> -
Method in interface org.apache.mailet.<A HREF="org/apache/mailet/MailetConfig.html">MailetConfig</A>
<DD>Returns a String containing the value of the named initialization
parameter, or null if the parameter does not exist.
<DT><A HREF="org/apache/mailet/GenericMailet.html#getInitParameter(java.lang.String)"><B>getInitParameter(String)</B></A> -
Method in class org.apache.mailet.<A HREF="org/apache/mailet/GenericMailet.html">GenericMailet</A>
<DD>Returns a String containing the value of the named initialization
parameter, or null if the parameter does not exist.
<DT><A HREF="org/apache/mailet/MailetConfig.html#getInitParameterNames()"><B>getInitParameterNames()</B></A> -
Method in interface org.apache.mailet.<A HREF="org/apache/mailet/MailetConfig.html">MailetConfig</A>
<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.
<DT><A HREF="org/apache/mailet/GenericMailet.html#getInitParameterNames()"><B>getInitParameterNames()</B></A> -
Method in class org.apache.mailet.<A HREF="org/apache/mailet/GenericMailet.html">GenericMailet</A>
<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.
<DT><A HREF="org/apache/mailet/MailetContext.html#getLocalUsers()"><B>getLocalUsers()</B></A> -
Method in interface org.apache.mailet.<A HREF="org/apache/mailet/MailetContext.html">MailetContext</A>
<DD>Returns a Collection of the local user accounts within this mailet
context.
<DT><A HREF="org/apache/mailet/Mailet.html#getMailetConfig()"><B>getMailetConfig()</B></A> -
Method in interface org.apache.mailet.<A HREF="org/apache/mailet/Mailet.html">Mailet</A>
<DD>Returns a MailetConfig object, which contains initialization and
startup parameters for this mailet.
<DT><A HREF="org/apache/mailet/GenericMailet.html#getMailetConfig()"><B>getMailetConfig()</B></A> -
Method in class org.apache.mailet.<A HREF="org/apache/mailet/GenericMailet.html">GenericMailet</A>
<DD>Returns this matcher's MailetConfig object.
<DT><A HREF="org/apache/mailet/GenericMatcher.html#getMailetContext()"><B>getMailetContext()</B></A> -
Method in class org.apache.mailet.<A HREF="org/apache/mailet/GenericMatcher.html">GenericMatcher</A>
<DD>Returns a reference to the MailetContext in which this matcher is
running.
<DT><A HREF="org/apache/mailet/MailetConfig.html#getMailetContext()"><B>getMailetContext()</B></A> -
Method in interface org.apache.mailet.<A HREF="org/apache/mailet/MailetConfig.html">MailetConfig</A>
<DD>Returns a reference to the MailetContext in which the mailet is
executing.
<DT><A HREF="org/apache/mailet/MatcherConfig.html#getMailetContext()"><B>getMailetContext()</B></A> -
Method in interface org.apache.mailet.<A HREF="org/apache/mailet/MatcherConfig.html">MatcherConfig</A>
<DD>Returns a reference to the MailetContext in which the matcher is executing
<DT><A HREF="org/apache/mailet/GenericMailet.html#getMailetContext()"><B>getMailetContext()</B></A> -
Method in class org.apache.mailet.<A HREF="org/apache/mailet/GenericMailet.html">GenericMailet</A>
<DD>Returns a reference to the MailetContext in which this mailet is
running.
<DT><A HREF="org/apache/mailet/Mailet.html#getMailetInfo()"><B>getMailetInfo()</B></A> -
Method in interface org.apache.mailet.<A HREF="org/apache/mailet/Mailet.html">Mailet</A>
<DD>Returns information about the mailet, such as author, version, and
copyright.
<DT><A HREF="org/apache/mailet/GenericMailet.html#getMailetInfo()"><B>getMailetInfo()</B></A> -
Method in class org.apache.mailet.<A HREF="org/apache/mailet/GenericMailet.html">GenericMailet</A>
<DD>Returns information about the mailet, such as author, version, and
copyright.
<DT><A HREF="org/apache/mailet/MailetConfig.html#getMailetName()"><B>getMailetName()</B></A> -
Method in interface org.apache.mailet.<A HREF="org/apache/mailet/MailetConfig.html">MailetConfig</A>
<DD>Returns the name of this mailet instance.
<DT><A HREF="org/apache/mailet/GenericMailet.html#getMailetName()"><B>getMailetName()</B></A> -
Method in class org.apache.mailet.<A HREF="org/apache/mailet/GenericMailet.html">GenericMailet</A>
<DD>Returns the name of this mailet instance.
<DT><A HREF="org/apache/mailet/MailetContext.html#getMailServers(java.lang.String)"><B>getMailServers(String)</B></A> -
Method in interface org.apache.mailet.<A HREF="org/apache/mailet/MailetContext.html">MailetContext</A>
<DD>Returns a Collection of Strings of hostnames or ip addresses that
are specified as mail server listeners for the given hostname.
<DT><A HREF="org/apache/mailet/MailetContext.html#getMajorVersion()"><B>getMajorVersion()</B></A> -
Method in interface org.apache.mailet.<A HREF="org/apache/mailet/MailetContext.html">MailetContext</A>
<DD>Returns the minor version of the Mailet API that this mailet
container supports.
<DT><A HREF="org/apache/mailet/Matcher.html#getMatcherConfig()"><B>getMatcherConfig()</B></A> -
Method in interface org.apache.mailet.<A HREF="org/apache/mailet/Matcher.html">Matcher</A>
<DD>Returns a MatcherConfig object, which contains initialization and
startup parameters for this matcher.
<DT><A HREF="org/apache/mailet/GenericMatcher.html#getMatcherConfig()"><B>getMatcherConfig()</B></A> -
Method in class org.apache.mailet.<A HREF="org/apache/mailet/GenericMatcher.html">GenericMatcher</A>
<DD>Returns this matcher's MatcherConfig object.
<DT><A HREF="org/apache/mailet/Matcher.html#getMatcherInfo()"><B>getMatcherInfo()</B></A> -
Method in interface org.apache.mailet.<A HREF="org/apache/mailet/Matcher.html">Matcher</A>
<DD>Returns information about the matcher, such as author, version, and copyright.
<DT><A HREF="org/apache/mailet/GenericMatcher.html#getMatcherInfo()"><B>getMatcherInfo()</B></A> -
Method in class org.apache.mailet.<A HREF="org/apache/mailet/GenericMatcher.html">GenericMatcher</A>
<DD>Returns information about the matcher, such as author, version, and
copyright.
<DT><A HREF="org/apache/mailet/GenericMatcher.html#getMatcherName()"><B>getMatcherName()</B></A> -
Method in class org.apache.mailet.<A HREF="org/apache/mailet/GenericMatcher.html">GenericMatcher</A>
<DD>Returns the name of this matcher instance.
<DT><A HREF="org/apache/mailet/MatcherConfig.html#getMatcherName()"><B>getMatcherName()</B></A> -
Method in interface org.apache.mailet.<A HREF="org/apache/mailet/MatcherConfig.html">MatcherConfig</A>
<DD>Returns the name of this matcher instance.
<DT><A HREF="org/apache/mailet/Mail.html#getMessage()"><B>getMessage()</B></A> -
Method in interface org.apache.mailet.<A HREF="org/apache/mailet/Mail.html">Mail</A>
<DD>Returns the MimeMessage stored in this message
<DT><A HREF="org/apache/mailet/MailetContext.html#getMinorVersion()"><B>getMinorVersion()</B></A> -
Method in interface org.apache.mailet.<A HREF="org/apache/mailet/MailetContext.html">MailetContext</A>
<DD>Returns the minor version of the Mailet API that this mailet
container supports.
<DT><A HREF="org/apache/mailet/MailetContext.html#getPostmaster()"><B>getPostmaster()</B></A> -
Method in interface org.apache.mailet.<A HREF="org/apache/mailet/MailetContext.html">MailetContext</A>
<DD>Returns the postmaster's address for this mailet context.
<DT><A HREF="org/apache/mailet/Mail.html#getRecipients()"><B>getRecipients()</B></A> -
Method in interface org.apache.mailet.<A HREF="org/apache/mailet/Mail.html">Mail</A>
<DD>Returns a Collection of MailAddress objects that are recipients of this message
<DT><A HREF="org/apache/mailet/Mail.html#getRemoteAddr()"><B>getRemoteAddr()</B></A> -
Method in interface org.apache.mailet.<A HREF="org/apache/mailet/Mail.html">Mail</A>
<DD>The remote ip address of the server that connected to send this message
<DT><A HREF="org/apache/mailet/Mail.html#getRemoteHost()"><B>getRemoteHost()</B></A> -
Method in interface org.apache.mailet.<A HREF="org/apache/mailet/Mail.html">Mail</A>
<DD>The remote hostname of the server that connected to send this message
<DT><A HREF="org/apache/mailet/MailetException.html#getRootCause()"><B>getRootCause()</B></A> -
Method in class org.apache.mailet.<A HREF="org/apache/mailet/MailetException.html">MailetException</A>
<DD>Returns the exception that caused this mailet exception.
<DT><A HREF="org/apache/mailet/Mail.html#getSender()"><B>getSender()</B></A> -
Method in interface org.apache.mailet.<A HREF="org/apache/mailet/Mail.html">Mail</A>
<DD>The sender of the message, as specified by the MAIL FROM header, or internally defined
<DT><A HREF="org/apache/mailet/MailetContext.html#getServerInfo()"><B>getServerInfo()</B></A> -
Method in interface org.apache.mailet.<A HREF="org/apache/mailet/MailetContext.html">MailetContext</A>
<DD>Returns the name and version of the mailet container on which
the mailet is running.
<DT><A HREF="org/apache/mailet/MailetContext.html#getServerNames()"><B>getServerNames()</B></A> -
Method in interface org.apache.mailet.<A HREF="org/apache/mailet/MailetContext.html">MailetContext</A>
<DD>Returns a Collection of the server names that are considered "local"
by this mailet context.
<DT><A HREF="org/apache/mailet/Mail.html#getState()"><B>getState()</B></A> -
Method in interface org.apache.mailet.<A HREF="org/apache/mailet/Mail.html">Mail</A>
<DD>The current state of the message, such as GHOST, ERROR, or DEFAULT
<DT><A HREF="org/apache/mailet/MailAddress.html#getUser()"><B>getUser()</B></A> -
Method in class org.apache.mailet.<A HREF="org/apache/mailet/MailAddress.html">MailAddress</A>
<DD>Return the user part.
<DT><A HREF="org/apache/mailet/Mail.html#GHOST"><B>GHOST</B></A> -
Static variable in interface org.apache.mailet.<A HREF="org/apache/mailet/Mail.html">Mail</A>
<DD>
</DL>
<HR>
<A NAME="_I_"><!-- --></A><H2>
<B>I</B></H2>
<DL>
<DT><A HREF="org/apache/mailet/GenericMatcher.html#init()"><B>init()</B></A> -
Method in class org.apache.mailet.<A HREF="org/apache/mailet/GenericMatcher.html">GenericMatcher</A>
<DD>A convenience method which can be overridden so that there's no
need to call super.init(config).
<DT><A HREF="org/apache/mailet/GenericMailet.html#init()"><B>init()</B></A> -
Method in class org.apache.mailet.<A HREF="org/apache/mailet/GenericMailet.html">GenericMailet</A>
<DD>A convenience method which can be overridden so that there's no
need to call super.init(config).
<DT><A HREF="org/apache/mailet/Mailet.html#init(org.apache.mailet.MailetConfig)"><B>init(MailetConfig)</B></A> -
Method in interface org.apache.mailet.<A HREF="org/apache/mailet/Mailet.html">Mailet</A>
<DD>Called by the mailet container to indicate to a mailet that the
mailet is being placed into service.
<DT><A HREF="org/apache/mailet/GenericMailet.html#init(org.apache.mailet.MailetConfig)"><B>init(MailetConfig)</B></A> -
Method in class org.apache.mailet.<A HREF="org/apache/mailet/GenericMailet.html">GenericMailet</A>
<DD>Called by the mailet container to indicate to a mailet that the
mailet is being placed into service.
<DT><A HREF="org/apache/mailet/Matcher.html#init(org.apache.mailet.MatcherConfig)"><B>init(MatcherConfig)</B></A> -
Method in interface org.apache.mailet.<A HREF="org/apache/mailet/Matcher.html">Matcher</A>
<DD>Called by the mailet container to indicate to a matcher that the
matcher is being placed into service.
<DT><A HREF="org/apache/mailet/GenericMatcher.html#init(org.apache.mailet.MatcherConfig)"><B>init(MatcherConfig)</B></A> -
Method in class org.apache.mailet.<A HREF="org/apache/mailet/GenericMatcher.html">GenericMatcher</A>
<DD>Called by the matcher container to indicate to a matcher that the
matcher is being placed into service.
</DL>
<HR>
<A NAME="_L_"><!-- --></A><H2>
<B>L</B></H2>
<DL>
<DT><A HREF="org/apache/mailet/GenericMatcher.html#log(java.lang.String)"><B>log(String)</B></A> -
Method in class org.apache.mailet.<A HREF="org/apache/mailet/GenericMatcher.html">GenericMatcher</A>
<DD>Writes the specified message to a matcher log file, prepended by
the matcher's name.
<DT><A HREF="org/apache/mailet/MailetContext.html#log(java.lang.String)"><B>log(String)</B></A> -
Method in interface org.apache.mailet.<A HREF="org/apache/mailet/MailetContext.html">MailetContext</A>
<DD>Writes the specified message to a mailet log file, usually an event
log.
<DT><A HREF="org/apache/mailet/GenericMailet.html#log(java.lang.String)"><B>log(String)</B></A> -
Method in class org.apache.mailet.<A HREF="org/apache/mailet/GenericMailet.html">GenericMailet</A>
<DD>Writes the specified message to a mailet log file, prepended by
the mailet's name.
<DT><A HREF="org/apache/mailet/GenericMatcher.html#log(java.lang.String, java.lang.Throwable)"><B>log(String, Throwable)</B></A> -
Method in class org.apache.mailet.<A HREF="org/apache/mailet/GenericMatcher.html">GenericMatcher</A>
<DD>Writes an explanatory message and a stack trace for a given Throwable
exception to the matcher log file, prepended by the matcher's name.
<DT><A HREF="org/apache/mailet/MailetContext.html#log(java.lang.String, java.lang.Throwable)"><B>log(String, Throwable)</B></A> -
Method in interface org.apache.mailet.<A HREF="org/apache/mailet/MailetContext.html">MailetContext</A>
<DD>Writes an explanatory message and a stack trace for a given Throwable
exception to the mailet log file.
<DT><A HREF="org/apache/mailet/GenericMailet.html#log(java.lang.String, java.lang.Throwable)"><B>log(String, Throwable)</B></A> -
Method in class org.apache.mailet.<A HREF="org/apache/mailet/GenericMailet.html">GenericMailet</A>
<DD>Writes an explanatory message and a stack trace for a given Throwable
exception to the mailet log file, prepended by the mailet's name.
</DL>
<HR>
<A NAME="_M_"><!-- --></A><H2>
<B>M</B></H2>
<DL>
<DT><A HREF="org/apache/mailet/Mail.html"><B>Mail</B></A> - interface org.apache.mailet.<A HREF="org/apache/mailet/Mail.html">Mail</A>.<DD>Wrap a MimeMessage with routing information (from SMTP) such
as SMTP specified recipients, sender, and ip address and hostname
of sending server.<DT><A HREF="org/apache/mailet/MailAddress.html"><B>MailAddress</B></A> - class org.apache.mailet.<A HREF="org/apache/mailet/MailAddress.html">MailAddress</A>.<DD>A representation of an email address.<DT><A HREF="org/apache/mailet/MailAddress.html#MailAddress(java.lang.String)"><B>MailAddress(String)</B></A> -
Constructor for class org.apache.mailet.<A HREF="org/apache/mailet/MailAddress.html">MailAddress</A>
<DD>Construct a MailAddress parsing the provided <code>String</code> object.
<DT><A HREF="org/apache/mailet/MailAddress.html#MailAddress(java.lang.String, java.lang.String)"><B>MailAddress(String, String)</B></A> -
Constructor for class org.apache.mailet.<A HREF="org/apache/mailet/MailAddress.html">MailAddress</A>
<DD>Construct a MailAddress with the provided personal name and email
address.
<DT><A HREF="org/apache/mailet/Mailet.html"><B>Mailet</B></A> - interface org.apache.mailet.<A HREF="org/apache/mailet/Mailet.html">Mailet</A>.<DD>Draft of a Mailet inteface.<DT><A HREF="org/apache/mailet/MailetConfig.html"><B>MailetConfig</B></A> - interface org.apache.mailet.<A HREF="org/apache/mailet/MailetConfig.html">MailetConfig</A>.<DD>A mailet configuration object used by a mailet container used to pass information
to a mailet during initialization.<DT><A HREF="org/apache/mailet/MailetContext.html"><B>MailetContext</B></A> - interface org.apache.mailet.<A HREF="org/apache/mailet/MailetContext.html">MailetContext</A>.<DD>Defines a set of methods that a mailet or matcher uses to communicate
with its mailet container, for example, to send a new message, to
deliver a message locally, or write to a log file.<DT><A HREF="org/apache/mailet/MailetException.html"><B>MailetException</B></A> - exception org.apache.mailet.<A HREF="org/apache/mailet/MailetException.html">MailetException</A>.<DD>Defines a general exception a mailet can throw when it encounters difficulty.<DT><A HREF="org/apache/mailet/MailetException.html#MailetException()"><B>MailetException()</B></A> -
Constructor for class org.apache.mailet.<A HREF="org/apache/mailet/MailetException.html">MailetException</A>
<DD>Constructs a new mailet exception.
<DT><A HREF="org/apache/mailet/MailetException.html#MailetException(java.lang.String)"><B>MailetException(String)</B></A> -
Constructor for class org.apache.mailet.<A HREF="org/apache/mailet/MailetException.html">MailetException</A>
<DD>Constructs a new mailet exception with the specified message.
<DT><A HREF="org/apache/mailet/MailetException.html#MailetException(java.lang.String, java.lang.Throwable)"><B>MailetException(String, Throwable)</B></A> -
Constructor for class org.apache.mailet.<A HREF="org/apache/mailet/MailetException.html">MailetException</A>
<DD>Constructs a new mailet exception when the mailet needs to throw
an exception and include a message about the "root cause" exception
that interfered with its normal operation, including a description
message.
<DT><A HREF="org/apache/mailet/MailetException.html#MailetException(java.lang.Throwable)"><B>MailetException(Throwable)</B></A> -
Constructor for class org.apache.mailet.<A HREF="org/apache/mailet/MailetException.html">MailetException</A>
<DD>Constructs a new mailet exception when the mailet needs to throw
an exception and include a message about the "root cause" exception
that interfered with its normal operation.
<DT><A HREF="org/apache/mailet/Matcher.html#match(org.apache.mailet.Mail)"><B>match(Mail)</B></A> -
Method in interface org.apache.mailet.<A HREF="org/apache/mailet/Matcher.html">Matcher</A>
<DD>Takes a Mail message, looks at any pertinent information, and then returns a subset
of recipients that meet the "match" conditions.
<DT><A HREF="org/apache/mailet/GenericMatcher.html#match(org.apache.mailet.Mail)"><B>match(Mail)</B></A> -
Method in class org.apache.mailet.<A HREF="org/apache/mailet/GenericMatcher.html">GenericMatcher</A>
<DD>Called by the matcher container to allow the matcher to process a
message.
<DT><A HREF="org/apache/mailet/GenericRecipientMatcher.html#match(org.apache.mailet.Mail)"><B>match(Mail)</B></A> -
Method in class org.apache.mailet.<A HREF="org/apache/mailet/GenericRecipientMatcher.html">GenericRecipientMatcher</A>
<DD>Matches each recipient one by one through matchRecipient(MailAddress
recipient) method.
<DT><A HREF="org/apache/mailet/Matcher.html"><B>Matcher</B></A> - interface org.apache.mailet.<A HREF="org/apache/mailet/Matcher.html">Matcher</A>.<DD>This interface define the behaviour of the message "routing" inside
the mailet container.<DT><A HREF="org/apache/mailet/MatcherConfig.html"><B>MatcherConfig</B></A> - interface org.apache.mailet.<A HREF="org/apache/mailet/MatcherConfig.html">MatcherConfig</A>.<DD>A matcher configuration object used by a mailet container used to pass information
to a matcher during initialization.<DT><A HREF="org/apache/mailet/GenericRecipientMatcher.html#matchRecipient(org.apache.mailet.MailAddress)"><B>matchRecipient(MailAddress)</B></A> -
Method in class org.apache.mailet.<A HREF="org/apache/mailet/GenericRecipientMatcher.html">GenericRecipientMatcher</A>
<DD>Simple check to match exclusively on the email address (not
message information).
</DL>
<HR>
<A NAME="_O_"><!-- --></A><H2>
<B>O</B></H2>
<DL>
<DT><A HREF="org/apache/mailet/package-summary.html">org.apache.mailet</A> - package org.apache.mailet<DD> </DL>
<HR>
<A NAME="_R_"><!-- --></A><H2>
<B>R</B></H2>
<DL>
<DT><A HREF="org/apache/mailet/MailetContext.html#removeAttribute(java.lang.String)"><B>removeAttribute(String)</B></A> -
Method in interface org.apache.mailet.<A HREF="org/apache/mailet/MailetContext.html">MailetContext</A>
<DD>Removes the attribute with the given name from the mailet context.
</DL>
<HR>
<A NAME="_S_"><!-- --></A><H2>
<B>S</B></H2>
<DL>
<DT><A HREF="org/apache/mailet/MailetContext.html#sendMail(org.apache.mailet.MailAddress, java.util.Collection, javax.mail.internet.MimeMessage)"><B>sendMail(MailAddress, Collection, MimeMessage)</B></A> -
Method in interface org.apache.mailet.<A HREF="org/apache/mailet/MailetContext.html">MailetContext</A>
<DD>Send an outgoing message to the top of this mailet container's root queue.
<DT><A HREF="org/apache/mailet/MailetContext.html#sendMail(org.apache.mailet.MailAddress, java.util.Collection, javax.mail.internet.MimeMessage, java.lang.String)"><B>sendMail(MailAddress, Collection, MimeMessage, String)</B></A> -
Method in interface org.apache.mailet.<A HREF="org/apache/mailet/MailetContext.html">MailetContext</A>
<DD>Send an outgoing message to the top of this mailet container queue for the
appropriate processor that is specified.
<DT><A HREF="org/apache/mailet/Mailet.html#service(org.apache.mailet.Mail)"><B>service(Mail)</B></A> -
Method in interface org.apache.mailet.<A HREF="org/apache/mailet/Mailet.html">Mailet</A>
<DD>Called by the mailet container to allow the mailet to process to
a message message.
<DT><A HREF="org/apache/mailet/GenericMailet.html#service(org.apache.mailet.Mail)"><B>service(Mail)</B></A> -
Method in class org.apache.mailet.<A HREF="org/apache/mailet/GenericMailet.html">GenericMailet</A>
<DD>Called by the mailet container to allow the mailet to process a
message.
<DT><A HREF="org/apache/mailet/MailetContext.html#setAttribute(java.lang.String, java.lang.Object)"><B>setAttribute(String, Object)</B></A> -
Method in interface org.apache.mailet.<A HREF="org/apache/mailet/MailetContext.html">MailetContext</A>
<DD>Binds an object to a given attribute name in this mailet context.
<DT><A HREF="org/apache/mailet/Mail.html#setErrorMessage(java.lang.String)"><B>setErrorMessage(String)</B></A> -
Method in interface org.apache.mailet.<A HREF="org/apache/mailet/Mail.html">Mail</A>
<DD>Sets the error message associated with this message.
<DT><A HREF="org/apache/mailet/Mail.html#setMessage(java.io.InputStream)"><B>setMessage(InputStream)</B></A> -
Method in interface org.apache.mailet.<A HREF="org/apache/mailet/Mail.html">Mail</A>
<DD>Sets the MimeMessage associated with this message via an inputstream.
<DT><A HREF="org/apache/mailet/Mail.html#setMessage(javax.mail.internet.MimeMessage)"><B>setMessage(MimeMessage)</B></A> -
Method in interface org.apache.mailet.<A HREF="org/apache/mailet/Mail.html">Mail</A>
<DD>Sets the MimeMessage associated with this message via the object.
<DT><A HREF="org/apache/mailet/Mail.html#setState(java.lang.String)"><B>setState(String)</B></A> -
Method in interface org.apache.mailet.<A HREF="org/apache/mailet/Mail.html">Mail</A>
<DD>Sets the state of this message.
<DT><A HREF="org/apache/mailet/MailetContext.html#storeMail(org.apache.mailet.MailAddress, org.apache.mailet.MailAddress, javax.mail.internet.MimeMessage)"><B>storeMail(MailAddress, MailAddress, MimeMessage)</B></A> -
Method in interface org.apache.mailet.<A HREF="org/apache/mailet/MailetContext.html">MailetContext</A>
<DD>Stores mail into local accounts (POP3 by default, or the IMAP4 Inbox)
</DL>
<HR>
<A NAME="_T_"><!-- --></A><H2>
<B>T</B></H2>
<DL>
<DT><A HREF="org/apache/mailet/MailAddress.html#toInternetAddress()"><B>toInternetAddress()</B></A> -
Method in class org.apache.mailet.<A HREF="org/apache/mailet/MailAddress.html">MailAddress</A>
<DD>
<DT><A HREF="org/apache/mailet/MailAddress.html#toString()"><B>toString()</B></A> -
Method in class org.apache.mailet.<A HREF="org/apache/mailet/MailAddress.html">MailAddress</A>
<DD>
<DT><A HREF="org/apache/mailet/Mail.html#TRANSPORT"><B>TRANSPORT</B></A> -
Static variable in interface org.apache.mailet.<A HREF="org/apache/mailet/Mail.html">Mail</A>
<DD>
</DL>
<HR>
<A NAME="_W_"><!-- --></A><H2>
<B>W</B></H2>
<DL>
<DT><A HREF="org/apache/mailet/Mail.html#writeContentTo(java.io.OutputStream, int)"><B>writeContentTo(OutputStream, int)</B></A> -
Method in interface org.apache.mailet.<A HREF="org/apache/mailet/Mail.html">Mail</A>
<DD>Dumps X many number of lines from this message to an output stream
<DT><A HREF="org/apache/mailet/Mail.html#writeMessageTo(java.io.OutputStream)"><B>writeMessageTo(OutputStream)</B></A> -
Method in interface org.apache.mailet.<A HREF="org/apache/mailet/Mail.html">Mail</A>
<DD>Dumps this message to an output stream
</DL>
<HR>
<A HREF="#_B_">B</A> <A HREF="#_D_">D</A> <A HREF="#_E_">E</A> <A HREF="#_G_">G</A> <A HREF="#_I_">I</A> <A HREF="#_L_">L</A> <A HREF="#_M_">M</A> <A HREF="#_O_">O</A> <A HREF="#_R_">R</A> <A HREF="#_S_">S</A> <A HREF="#_T_">T</A> <A HREF="#_W_">W</A>
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_bottom"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" ID="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <FONT ID="NavBarFont1">Package</FONT> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <FONT ID="NavBarFont1">Class</FONT> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="org/apache/mailet/package-tree.html"><FONT ID="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="deprecated-list.html"><FONT ID="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" ID="NavBarCell1Rev"> <FONT ID="NavBarFont1Rev"><B>Index</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="help-doc.html"><FONT ID="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" ID="NavBarCell2"><FONT SIZE="-2">
PREV
NEXT</FONT></TD>
<TD BGCOLOR="white" ID="NavBarCell2"><FONT SIZE="-2">
<A HREF="index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="index-all.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
</BODY>
</HTML>
1.1 jakarta-james/www/mailet/index.html
Index: index.html
===================================================================
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc on Tue Sep 12 18:58:54 EDT 2000-->
<TITLE>
Generated Documentation (Untitled)
</TITLE>
</HEAD>
<FRAMESET cols="20%,80%">
<FRAME src="allclasses-frame.html" name="packageFrame">
<FRAME src="org/apache/mailet/package-summary.html" name="classFrame">
</FRAMESET>
<NOFRAMES>
<H2>
Frame Alert</H2>
<P>
This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client.
<BR>
Link to <A HREF="org/apache/mailet/package-summary.html">Non-frame version.</A></NOFRAMES>
</HTML>
1.1 jakarta-james/www/mailet/overview-tree.html
Index: overview-tree.html
===================================================================
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc on Tue Sep 12 18:58:54 EDT 2000 -->
<TITLE>
: Class Hierarchy
</TITLE>
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
</HEAD>
<BODY BGCOLOR="white">
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_top"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" ID="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <FONT ID="NavBarFont1">Package</FONT> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <FONT ID="NavBarFont1">Class</FONT> </TD>
<TD BGCOLOR="#FFFFFF" ID="NavBarCell1Rev"> <FONT ID="NavBarFont1Rev"><B>Tree</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="deprecated-list.html"><FONT ID="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="index-all.html"><FONT ID="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="help-doc.html"><FONT ID="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" ID="NavBarCell2"><FONT SIZE="-2">
PREV
NEXT</FONT></TD>
<TD BGCOLOR="white" ID="NavBarCell2"><FONT SIZE="-2">
<A HREF="index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="overview-tree.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
<CENTER>
<H2>
Hierarchy For All Packages</H2>
</CENTER>
<DL>
<DT><B>Package Hierarchies: </B><DD><A HREF="org/apache/mailet/package-tree.html">org.apache.mailet</A></DL>
<HR>
<H2>
Class Hierarchy
</H2>
<UL>
<LI TYPE="circle">class java.lang.Object<UL>
<LI TYPE="circle">class org.apache.mailet.<A HREF="org/apache/mailet/GenericMailet.html"><B>GenericMailet</B></A> (implements org.apache.mailet.<A HREF="org/apache/mailet/Mailet.html">Mailet</A>, org.apache.mailet.<A HREF="org/apache/mailet/MailetConfig.html">MailetConfig</A>)
<LI TYPE="circle">class org.apache.mailet.<A HREF="org/apache/mailet/GenericMatcher.html"><B>GenericMatcher</B></A> (implements org.apache.mailet.<A HREF="org/apache/mailet/Matcher.html">Matcher</A>, org.apache.mailet.<A HREF="org/apache/mailet/MatcherConfig.html">MatcherConfig</A>)
<UL>
<LI TYPE="circle">class org.apache.mailet.<A HREF="org/apache/mailet/GenericRecipientMatcher.html"><B>GenericRecipientMatcher</B></A></UL>
<LI TYPE="circle">class org.apache.mailet.<A HREF="org/apache/mailet/MailAddress.html"><B>MailAddress</B></A> (implements java.io.Serializable)
<LI TYPE="circle">class java.lang.Throwable (implements java.io.Serializable)
<UL>
<LI TYPE="circle">class java.lang.Exception<UL>
<LI TYPE="circle">class org.apache.mailet.<A HREF="org/apache/mailet/MailetException.html"><B>MailetException</B></A></UL>
</UL>
</UL>
</UL>
<H2>
Interface Hierarchy
</H2>
<UL>
<LI TYPE="circle">interface java.lang.Cloneable<UL>
<LI TYPE="circle">interface org.apache.mailet.<A HREF="org/apache/mailet/Mail.html"><B>Mail</B></A>(also extends java.io.Serializable)
</UL>
<LI TYPE="circle">interface org.apache.mailet.<A HREF="org/apache/mailet/Mailet.html"><B>Mailet</B></A><LI TYPE="circle">interface org.apache.mailet.<A HREF="org/apache/mailet/MailetConfig.html"><B>MailetConfig</B></A><LI TYPE="circle">interface org.apache.mailet.<A HREF="org/apache/mailet/MailetContext.html"><B>MailetContext</B></A><LI TYPE="circle">interface org.apache.mailet.<A HREF="org/apache/mailet/Matcher.html"><B>Matcher</B></A><LI TYPE="circle">interface org.apache.mailet.<A HREF="org/apache/mailet/MatcherConfig.html"><B>MatcherConfig</B></A><LI TYPE="circle">interface java.io.Serializable<UL>
<LI TYPE="circle">interface org.apache.mailet.<A HREF="org/apache/mailet/Mail.html"><B>Mail</B></A>(also extends java.lang.Cloneable)
</UL>
</UL>
<HR>
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_bottom"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" ID="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <FONT ID="NavBarFont1">Package</FONT> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <FONT ID="NavBarFont1">Class</FONT> </TD>
<TD BGCOLOR="#FFFFFF" ID="NavBarCell1Rev"> <FONT ID="NavBarFont1Rev"><B>Tree</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="deprecated-list.html"><FONT ID="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="index-all.html"><FONT ID="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="help-doc.html"><FONT ID="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" ID="NavBarCell2"><FONT SIZE="-2">
PREV
NEXT</FONT></TD>
<TD BGCOLOR="white" ID="NavBarCell2"><FONT SIZE="-2">
<A HREF="index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="overview-tree.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
</BODY>
</HTML>
1.1 jakarta-james/www/mailet/package-list
Index: package-list
===================================================================
org.apache.mailet
1.1 jakarta-james/www/mailet/packages.html
Index: packages.html
===================================================================
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc on Tue Sep 12 18:58:54 EDT 2000 -->
<TITLE>
</TITLE>
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
</HEAD>
<BODY BGCOLOR="white">
<BR>
<BR>
<BR>
<CENTER>
The front page has been renamed.Please see:
<BR>
<A HREF="index.html">Frame version</A>
<BR>
<A HREF="org/apache/mailet/package-summary.html">Non-frame version.</A></CENTER>
</BODY>
</HTML>
1.1 jakarta-james/www/mailet/serialized-form.html
Index: serialized-form.html
===================================================================
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc on Tue Sep 12 18:58:55 EDT 2000 -->
<TITLE>
Serialized Form
</TITLE>
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
</HEAD>
<BODY BGCOLOR="white">
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_top"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" ID="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <FONT ID="NavBarFont1">Package</FONT> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <FONT ID="NavBarFont1">Class</FONT> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="org/apache/mailet/package-tree.html"><FONT ID="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="deprecated-list.html"><FONT ID="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="index-all.html"><FONT ID="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="help-doc.html"><FONT ID="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" ID="NavBarCell2"><FONT SIZE="-2">
PREV
NEXT</FONT></TD>
<TD BGCOLOR="white" ID="NavBarCell2"><FONT SIZE="-2">
<A HREF="index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="serialized-form.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
<CENTER>
<H1>
Serialized Form</H1>
</CENTER>
<HR SIZE="4" NOSHADE>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" ID="TableSubHeadingColor">
<TD ALIGN="center"><FONT SIZE="+2">
<B>Package</B> <B>org.apache.mailet</B></FONT></TD>
</TR>
</TABLE>
<P>
<A NAME="org.apache.mailet.MailAddress"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" ID="TableSubHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Class <A HREF="org/apache/mailet/MailAddress.html">org.apache.mailet.MailAddress</A> implements Serializable</B></FONT></TD>
</TR>
</TABLE>
<P>
<A NAME="serializedForm"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" ID="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Serialized Fields</B></FONT></TD>
</TR>
</TABLE>
<H3>
host</H3>
<PRE>
java.lang.String <B>host</B></PRE>
<DL>
</DL>
<HR>
<H3>
user</H3>
<PRE>
java.lang.String <B>user</B></PRE>
<DL>
</DL>
<P>
<A NAME="org.apache.mailet.MailetException"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" ID="TableSubHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Class <A HREF="org/apache/mailet/MailetException.html">org.apache.mailet.MailetException</A> implements Serializable</B></FONT></TD>
</TR>
</TABLE>
<P>
<A NAME="serializedForm"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" ID="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Serialized Fields</B></FONT></TD>
</TR>
</TABLE>
<H3>
rootCause</H3>
<PRE>
java.lang.Throwable <B>rootCause</B></PRE>
<DL>
</DL>
<P>
<HR>
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_bottom"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" ID="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <FONT ID="NavBarFont1">Package</FONT> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <FONT ID="NavBarFont1">Class</FONT> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="org/apache/mailet/package-tree.html"><FONT ID="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="deprecated-list.html"><FONT ID="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="index-all.html"><FONT ID="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="help-doc.html"><FONT ID="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" ID="NavBarCell2"><FONT SIZE="-2">
PREV
NEXT</FONT></TD>
<TD BGCOLOR="white" ID="NavBarCell2"><FONT SIZE="-2">
<A HREF="index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="serialized-form.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
</BODY>
</HTML>
1.1 jakarta-james/www/mailet/stylesheet.css
Index: stylesheet.css
===================================================================
/* Javadoc style sheet */
/* Define colors, fonts and other style attributes here to override the defaults */
/* Page background color */
body { background-color: #FFFFFF }
/* Table colors */
#TableHeadingColor { background: #CCCCFF } /* Dark mauve */
#TableSubHeadingColor { background: #EEEEFF } /* Light mauve */
#TableRowColor { background: #FFFFFF } /* White */
/* Font used in left-hand frame lists */
#FrameTitleFont { font-size: normal; font-family: normal }
#FrameHeadingFont { font-size: normal; font-family: normal }
#FrameItemFont { font-size: normal; font-family: normal }
/* Example of smaller, sans-serif font in frames */
/* #FrameItemFont { font-size: 10pt; font-family: Helvetica, Arial, sans-serif } */
/* Navigation bar fonts and colors */
#NavBarCell1 { background-color:#EEEEFF;}/* Light mauve */
#NavBarCell1Rev { background-color:#00008B;}/* Dark Blue */
#NavBarFont1 { font-family: Arial, Helvetica, sans-serif; color:#000000;}
#NavBarFont1Rev { font-family: Arial, Helvetica, sans-serif; color:#FFFFFF;}
#NavBarCell2 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF;}
#NavBarCell3 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF;}
1.1 jakarta-james/www/mailet/org/apache/mailet/GenericMailet.html
Index: GenericMailet.html
===================================================================
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc on Tue Sep 12 18:58:55 EDT 2000 -->
<TITLE>
: Class GenericMailet
</TITLE>
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
</HEAD>
<BODY BGCOLOR="white">
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_top"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" ID="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="package-summary.html"><FONT ID="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" ID="NavBarCell1Rev"> <FONT ID="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="package-tree.html"><FONT ID="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT ID="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../index-all.html"><FONT ID="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT ID="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" ID="NavBarCell2"><FONT SIZE="-2">
PREV CLASS
<A HREF="../../../org/apache/mailet/GenericMatcher.html"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" ID="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="GenericMailet.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
<TR>
<TD VALIGN="top" ID="NavBarCell3"><FONT SIZE="-2">
SUMMARY: INNER | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" ID="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.apache.mailet</FONT>
<BR>
Class GenericMailet</H2>
<PRE>
java.lang.Object
|
+--<B>org.apache.mailet.GenericMailet</B>
</PRE>
<HR>
<DL>
<DT>public abstract class <B>GenericMailet</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../org/apache/mailet/Mailet.html">Mailet</A>, <A HREF="../../../org/apache/mailet/MailetConfig.html">MailetConfig</A></DL>
<P>
GenericMailet makes writing mailets easier. It provides simple
versions of the lifecycle methods init and destroy and of the methods
in the MailetConfig interface. GenericMailet also implements the log
method, declared in the MailetContext interface.
<p>
To write a generic mailet, you need only override the abstract service
method.
<P>
<DL>
<DT><B>Version: </B><DD>1.0.0, 24/04/1999</DD>
<DT><B>Author: </B><DD>Federico Barbieri <sc...@pop.systemy.it>, Stefano Mazzocchi <st...@apache.org>, Pierpaolo Fumagalli <pi...@apache.org>, Serge Knystautas <se...@lokitech.com></DD>
</DL>
<HR>
<P>
<!-- ======== INNER CLASS SUMMARY ======== -->
<!-- =========== FIELD SUMMARY =========== -->
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" ID="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" ID="TableRowColor">
<TD><CODE><B><A HREF="../../../org/apache/mailet/GenericMailet.html#GenericMailet()">GenericMailet</A></B>()</CODE>
<BR>
</TD>
</TR>
</TABLE>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" ID="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Method Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" ID="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/mailet/GenericMailet.html#destroy()">destroy</A></B>()</CODE>
<BR>
Called by the mailer container to indicate to a mailet that the
mailet is being taken out of service.</TD>
</TR>
<TR BGCOLOR="white" ID="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/GenericMailet.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" ID="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/GenericMailet.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" ID="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../org/apache/mailet/MailetConfig.html">MailetConfig</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/mailet/GenericMailet.html#getMailetConfig()">getMailetConfig</A></B>()</CODE>
<BR>
Returns this matcher's MailetConfig object.</TD>
</TR>
<TR BGCOLOR="white" ID="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../org/apache/mailet/MailetContext.html">MailetContext</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/mailet/GenericMailet.html#getMailetContext()">getMailetContext</A></B>()</CODE>
<BR>
Returns a reference to the MailetContext in which this mailet is
running.</TD>
</TR>
<TR BGCOLOR="white" ID="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/GenericMailet.html#getMailetInfo()">getMailetInfo</A></B>()</CODE>
<BR>
Returns information about the mailet, such as author, version, and
copyright.</TD>
</TR>
<TR BGCOLOR="white" ID="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/GenericMailet.html#getMailetName()">getMailetName</A></B>()</CODE>
<BR>
Returns the name of this mailet instance.</TD>
</TR>
<TR BGCOLOR="white" ID="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/mailet/GenericMailet.html#init()">init</A></B>()</CODE>
<BR>
A convenience method which can be overridden so that there's no
need to call super.init(config).</TD>
</TR>
<TR BGCOLOR="white" ID="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/mailet/GenericMailet.html#init(org.apache.mailet.MailetConfig)">init</A></B>(<A HREF="../../../org/apache/mailet/MailetConfig.html">MailetConfig</A> newConfig)</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" ID="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/mailet/GenericMailet.html#log(java.lang.String)">log</A></B>(java.lang.String message)</CODE>
<BR>
Writes the specified message to a mailet log file, prepended by
the mailet's name.</TD>
</TR>
<TR BGCOLOR="white" ID="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/mailet/GenericMailet.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, prepended by the mailet's name.</TD>
</TR>
<TR BGCOLOR="white" ID="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>abstract void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/mailet/GenericMailet.html#service(org.apache.mailet.Mail)">service</A></B>(<A HREF="../../../org/apache/mailet/Mail.html">Mail</A> mail)</CODE>
<BR>
Called by the mailet container to allow the mailet to process a
message.</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#EEEEFF" ID="TableSubHeadingColor">
<TD><B>Methods inherited from class java.lang.Object</B></TD>
</TR>
<TR BGCOLOR="white" ID="TableRowColor">
<TD><CODE>clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait</CODE></TD>
</TR>
</TABLE>
<P>
<!-- ============ FIELD DETAIL =========== -->
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" ID="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TD>
</TR>
</TABLE>
<A NAME="GenericMailet()"><!-- --></A><H3>
GenericMailet</H3>
<PRE>
public <B>GenericMailet</B>()</PRE>
<DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" ID="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>
<A NAME="destroy()"><!-- --></A><H3>
destroy</H3>
<PRE>
public void <B>destroy</B>()</PRE>
<DL>
<DD>Called by the mailer container to indicate to a mailet that the
mailet is being taken out of service.<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../org/apache/mailet/Mailet.html#destroy()">destroy</A> in interface <A HREF="../../../org/apache/mailet/Mailet.html">Mailet</A></DL>
</DD>
</DL>
<HR>
<A NAME="getInitParameter(java.lang.String)"><!-- --></A><H3>
getInitParameter</H3>
<PRE>
public 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>
This method is supplied for convenience. It gets the value of the
named parameter from the mailet's MailetConfig object.<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../org/apache/mailet/MailetConfig.html#getInitParameter(java.lang.String)">getInitParameter</A> in interface <A HREF="../../../org/apache/mailet/MailetConfig.html">MailetConfig</A><DT><B>Parameters:</B><DD><CODE>name</CODE> - - a String specifying the name of the initialization parameter<DT><B>Returns:</B><DD>String a String containing the value of the initalization parameter</DL>
</DD>
</DL>
<HR>
<A NAME="getInitParameterNames()"><!-- --></A><H3>
getInitParameterNames</H3>
<PRE>
public 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>
This method is supplied for convenience. It gets the parameter names from
the mailet's MailetConfig object.<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../org/apache/mailet/MailetConfig.html#getInitParameterNames()">getInitParameterNames</A> in interface <A HREF="../../../org/apache/mailet/MailetConfig.html">MailetConfig</A><DT><B>Returns:</B><DD>Iterator an iterator of String objects containing the names of
the mailet's initialization parameters</DL>
</DD>
</DL>
<HR>
<A NAME="getMailetConfig()"><!-- --></A><H3>
getMailetConfig</H3>
<PRE>
public <A HREF="../../../org/apache/mailet/MailetConfig.html">MailetConfig</A> <B>getMailetConfig</B>()</PRE>
<DL>
<DD>Returns this matcher's MailetConfig object.<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../org/apache/mailet/Mailet.html#getMailetConfig()">getMailetConfig</A> in interface <A HREF="../../../org/apache/mailet/Mailet.html">Mailet</A><DT><B>Returns:</B><DD>MailetConfig the MailetConfig object that initialized this mailet</DL>
</DD>
</DL>
<HR>
<A NAME="getMailetContext()"><!-- --></A><H3>
getMailetContext</H3>
<PRE>
public <A HREF="../../../org/apache/mailet/MailetContext.html">MailetContext</A> <B>getMailetContext</B>()</PRE>
<DL>
<DD>Returns a reference to the MailetContext in which this mailet is
running.<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../org/apache/mailet/MailetConfig.html#getMailetContext()">getMailetContext</A> in interface <A HREF="../../../org/apache/mailet/MailetConfig.html">MailetConfig</A><DT><B>Returns:</B><DD>MailetContext the MailetContext object passed to this mailet by the init method</DL>
</DD>
</DL>
<HR>
<A NAME="getMailetInfo()"><!-- --></A><H3>
getMailetInfo</H3>
<PRE>
public java.lang.String <B>getMailetInfo</B>()</PRE>
<DL>
<DD>Returns information about the mailet, such as author, version, and
copyright. By default, this method returns an empty string. Override
this method to have it return a meaningful value.<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../org/apache/mailet/Mailet.html#getMailetInfo()">getMailetInfo</A> in interface <A HREF="../../../org/apache/mailet/Mailet.html">Mailet</A><DT><B>Returns:</B><DD>String information about this mailet, by default an empty string</DL>
</DD>
</DL>
<HR>
<A NAME="getMailetName()"><!-- --></A><H3>
getMailetName</H3>
<PRE>
public java.lang.String <B>getMailetName</B>()</PRE>
<DL>
<DD>Returns the name of this mailet instance.<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../org/apache/mailet/MailetConfig.html#getMailetName()">getMailetName</A> in interface <A HREF="../../../org/apache/mailet/MailetConfig.html">MailetConfig</A><DT><B>Returns:</B><DD>the name of this mailet instance</DL>
</DD>
</DL>
<HR>
<A NAME="init(org.apache.mailet.MailetConfig)"><!-- --></A><H3>
init</H3>
<PRE>
public void <B>init</B>(<A HREF="../../../org/apache/mailet/MailetConfig.html">MailetConfig</A> newConfig)
throws <A HREF="../../../org/apache/mailet/MailetException.html">MailetException</A></PRE>
<DL>
<DD>Called by the mailet container to indicate to a mailet that the
mailet is being placed into service.
This implementation stores the MailetConfig object it receives from
the mailet container for alter use. When overriding this form of the
method, call super.init(config).<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../org/apache/mailet/Mailet.html#init(org.apache.mailet.MailetConfig)">init</A> in interface <A HREF="../../../org/apache/mailet/Mailet.html">Mailet</A><DT><B>Parameters:</B><DD><CODE>MailetConfig</CODE> - config - the MailetConfig object that contains
configutation information for this mailet<DT><B>Throws:</B><DD><A HREF="../../../org/apache/mailet/MailetException.html">MailetException</A> - if an exception occurs that interrupts the mailet's normal operation</DL>
</DD>
</DL>
<HR>
<A NAME="init()"><!-- --></A><H3>
init</H3>
<PRE>
public void <B>init</B>()
throws <A HREF="../../../org/apache/mailet/MailetException.html">MailetException</A></PRE>
<DL>
<DD>A convenience method which can be overridden so that there's no
need to call super.init(config).
Instead of overriding init(MailetConfig), simply override this
method and it will be called by GenericMailet.init(MailetConfig config).
The MailetConfig object can still be retrieved via getMailetConfig().<DD><DL>
<DT><B>Throws:</B><DD><A HREF="../../../org/apache/mailet/MailetException.html">MailetException</A> - if an exception occurs that interrupts the mailet's normal operation</DL>
</DD>
</DL>
<HR>
<A NAME="log(java.lang.String)"><!-- --></A><H3>
log</H3>
<PRE>
public void <B>log</B>(java.lang.String message)</PRE>
<DL>
<DD>Writes the specified message to a mailet log file, prepended by
the mailet's name.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>msg</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>
public 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, prepended by the mailet's name.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>message</CODE> - - a String that describes the error or exception<DD><CODE>t</CODE> - - the java.lang.Throwable error or exception</DL>
</DD>
</DL>
<HR>
<A NAME="service(org.apache.mailet.Mail)"><!-- --></A><H3>
service</H3>
<PRE>
public abstract void <B>service</B>(<A HREF="../../../org/apache/mailet/Mail.html">Mail</A> mail)
throws <A HREF="../../../org/apache/mailet/MailetException.html">MailetException</A>,
javax.mail.MessagingException</PRE>
<DL>
<DD>Called by the mailet container to allow the mailet to process a
message.
This method is declared abstract so subclasses must override it.<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../org/apache/mailet/Mailet.html#service(org.apache.mailet.Mail)">service</A> in interface <A HREF="../../../org/apache/mailet/Mailet.html">Mailet</A><DT><B>Parameters:</B><DD><CODE>mail</CODE> - - the Mail object that contains the MimeMessage and
routing information<DT><B>Throws:</B><DD><A HREF="../../../org/apache/mailet/MailetException.html">MailetException</A> - - if an exception occurs that interferes with the mailet's normal operation
occurred</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_bottom"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" ID="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="package-summary.html"><FONT ID="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" ID="NavBarCell1Rev"> <FONT ID="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="package-tree.html"><FONT ID="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT ID="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../index-all.html"><FONT ID="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT ID="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" ID="NavBarCell2"><FONT SIZE="-2">
PREV CLASS
<A HREF="../../../org/apache/mailet/GenericMatcher.html"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" ID="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="GenericMailet.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
<TR>
<TD VALIGN="top" ID="NavBarCell3"><FONT SIZE="-2">
SUMMARY: INNER | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" ID="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
</BODY>
</HTML>
1.1 jakarta-james/www/mailet/org/apache/mailet/GenericMatcher.html
Index: GenericMatcher.html
===================================================================
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc on Tue Sep 12 18:58:55 EDT 2000 -->
<TITLE>
: Class GenericMatcher
</TITLE>
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
</HEAD>
<BODY BGCOLOR="white">
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_top"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" ID="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="package-summary.html"><FONT ID="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" ID="NavBarCell1Rev"> <FONT ID="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="package-tree.html"><FONT ID="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT ID="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../index-all.html"><FONT ID="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT ID="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" ID="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../org/apache/mailet/GenericMailet.html"><B>PREV CLASS</B></A>
<A HREF="../../../org/apache/mailet/GenericRecipientMatcher.html"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" ID="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="GenericMatcher.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
<TR>
<TD VALIGN="top" ID="NavBarCell3"><FONT SIZE="-2">
SUMMARY: INNER | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" ID="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.apache.mailet</FONT>
<BR>
Class GenericMatcher</H2>
<PRE>
java.lang.Object
|
+--<B>org.apache.mailet.GenericMatcher</B>
</PRE>
<DL>
<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../org/apache/mailet/GenericRecipientMatcher.html">GenericRecipientMatcher</A></DD>
</DL>
<HR>
<DL>
<DT>public abstract class <B>GenericMatcher</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../org/apache/mailet/Matcher.html">Matcher</A>, <A HREF="../../../org/apache/mailet/MatcherConfig.html">MatcherConfig</A></DL>
<P>
GenericMatcher implements the Matcher and MatcherConfig interfaces.
GenericMatcher makes writing matchers easier. It provides simple versions of
the lifecycle methods init and destroy and of the methods in the MatcherConfig
interface. GenericMatcher also implements the log method, declared in the
MatcherContext interface.
<p>
To write a generic matcher, you need only override the abstract match method.
<P>
<DL>
<DT><B>Version: </B><DD>1.0.0, 24/04/1999</DD>
<DT><B>Author: </B><DD>Serge Knystautas <se...@lokitech.com></DD>
</DL>
<HR>
<P>
<!-- ======== INNER CLASS SUMMARY ======== -->
<!-- =========== FIELD SUMMARY =========== -->
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" ID="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" ID="TableRowColor">
<TD><CODE><B><A HREF="../../../org/apache/mailet/GenericMatcher.html#GenericMatcher()">GenericMatcher</A></B>()</CODE>
<BR>
</TD>
</TR>
</TABLE>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" ID="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Method Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" ID="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/mailet/GenericMatcher.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" ID="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/GenericMatcher.html#getCondition()">getCondition</A></B>()</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" ID="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../org/apache/mailet/MailetContext.html">MailetContext</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/mailet/GenericMatcher.html#getMailetContext()">getMailetContext</A></B>()</CODE>
<BR>
Returns a reference to the MailetContext in which this matcher is
running.</TD>
</TR>
<TR BGCOLOR="white" ID="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../org/apache/mailet/MatcherConfig.html">MatcherConfig</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/mailet/GenericMatcher.html#getMatcherConfig()">getMatcherConfig</A></B>()</CODE>
<BR>
Returns this matcher's MatcherConfig object.</TD>
</TR>
<TR BGCOLOR="white" ID="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/GenericMatcher.html#getMatcherInfo()">getMatcherInfo</A></B>()</CODE>
<BR>
Returns information about the matcher, such as author, version, and
copyright.</TD>
</TR>
<TR BGCOLOR="white" ID="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/GenericMatcher.html#getMatcherName()">getMatcherName</A></B>()</CODE>
<BR>
Returns the name of this matcher instance.</TD>
</TR>
<TR BGCOLOR="white" ID="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/mailet/GenericMatcher.html#init()">init</A></B>()</CODE>
<BR>
A convenience method which can be overridden so that there's no
need to call super.init(config).</TD>
</TR>
<TR BGCOLOR="white" ID="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/mailet/GenericMatcher.html#init(org.apache.mailet.MatcherConfig)">init</A></B>(<A HREF="../../../org/apache/mailet/MatcherConfig.html">MatcherConfig</A> newConfig)</CODE>
<BR>
Called by the matcher container to indicate to a matcher that the
matcher is being placed into service.</TD>
</TR>
<TR BGCOLOR="white" ID="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/mailet/GenericMatcher.html#log(java.lang.String)">log</A></B>(java.lang.String message)</CODE>
<BR>
Writes the specified message to a matcher log file, prepended by
the matcher's name.</TD>
</TR>
<TR BGCOLOR="white" ID="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/mailet/GenericMatcher.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 matcher log file, prepended by the matcher's name.</TD>
</TR>
<TR BGCOLOR="white" ID="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>abstract java.util.Collection</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/mailet/GenericMatcher.html#match(org.apache.mailet.Mail)">match</A></B>(<A HREF="../../../org/apache/mailet/Mail.html">Mail</A> mail)</CODE>
<BR>
Called by the matcher container to allow the matcher to process a
message.</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#EEEEFF" ID="TableSubHeadingColor">
<TD><B>Methods inherited from class java.lang.Object</B></TD>
</TR>
<TR BGCOLOR="white" ID="TableRowColor">
<TD><CODE>clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait</CODE></TD>
</TR>
</TABLE>
<P>
<!-- ============ FIELD DETAIL =========== -->
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" ID="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TD>
</TR>
</TABLE>
<A NAME="GenericMatcher()"><!-- --></A><H3>
GenericMatcher</H3>
<PRE>
public <B>GenericMatcher</B>()</PRE>
<DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" ID="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>
<A NAME="destroy()"><!-- --></A><H3>
destroy</H3>
<PRE>
public 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.<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../org/apache/mailet/Matcher.html#destroy()">destroy</A> in interface <A HREF="../../../org/apache/mailet/Matcher.html">Matcher</A></DL>
</DD>
</DL>
<HR>
<A NAME="getCondition()"><!-- --></A><H3>
getCondition</H3>
<PRE>
public java.lang.String <B>getCondition</B>()</PRE>
<DL>
<DD>Returns a String containing the value of the named initialization
parameter, or null if the parameter does not exist.
<p>
This method is supplied for convenience. It gets the value of the
named parameter from the matcher's MatcherConfig object.<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../org/apache/mailet/MatcherConfig.html#getCondition()">getCondition</A> in interface <A HREF="../../../org/apache/mailet/MatcherConfig.html">MatcherConfig</A><DT><B>Returns:</B><DD>String a String containing the value of the initalization parameter</DL>
</DD>
</DL>
<HR>
<A NAME="getMatcherConfig()"><!-- --></A><H3>
getMatcherConfig</H3>
<PRE>
public <A HREF="../../../org/apache/mailet/MatcherConfig.html">MatcherConfig</A> <B>getMatcherConfig</B>()</PRE>
<DL>
<DD>Returns this matcher's MatcherConfig object.<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../org/apache/mailet/Matcher.html#getMatcherConfig()">getMatcherConfig</A> in interface <A HREF="../../../org/apache/mailet/Matcher.html">Matcher</A><DT><B>Returns:</B><DD>MatcherConfig the MatcherConfig object that initialized this matcher</DL>
</DD>
</DL>
<HR>
<A NAME="getMailetContext()"><!-- --></A><H3>
getMailetContext</H3>
<PRE>
public <A HREF="../../../org/apache/mailet/MailetContext.html">MailetContext</A> <B>getMailetContext</B>()</PRE>
<DL>
<DD>Returns a reference to the MailetContext in which this matcher is
running.<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../org/apache/mailet/MatcherConfig.html#getMailetContext()">getMailetContext</A> in interface <A HREF="../../../org/apache/mailet/MatcherConfig.html">MatcherConfig</A><DT><B>Returns:</B><DD>MailetContext the MailetContext object passed to this matcher by the init method</DL>
</DD>
</DL>
<HR>
<A NAME="getMatcherInfo()"><!-- --></A><H3>
getMatcherInfo</H3>
<PRE>
public java.lang.String <B>getMatcherInfo</B>()</PRE>
<DL>
<DD>Returns information about the matcher, such as author, version, and
copyright. By default, this method returns an empty string. Override
this method to have it return a meaningful value.<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../org/apache/mailet/Matcher.html#getMatcherInfo()">getMatcherInfo</A> in interface <A HREF="../../../org/apache/mailet/Matcher.html">Matcher</A><DT><B>Returns:</B><DD>String information about this matcher, by default an empty string</DL>
</DD>
</DL>
<HR>
<A NAME="getMatcherName()"><!-- --></A><H3>
getMatcherName</H3>
<PRE>
public java.lang.String <B>getMatcherName</B>()</PRE>
<DL>
<DD>Returns the name of this matcher instance.<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../org/apache/mailet/MatcherConfig.html#getMatcherName()">getMatcherName</A> in interface <A HREF="../../../org/apache/mailet/MatcherConfig.html">MatcherConfig</A><DT><B>Returns:</B><DD>the name of this matcher instance</DL>
</DD>
</DL>
<HR>
<A NAME="init(org.apache.mailet.MatcherConfig)"><!-- --></A><H3>
init</H3>
<PRE>
public void <B>init</B>(<A HREF="../../../org/apache/mailet/MatcherConfig.html">MatcherConfig</A> newConfig)
throws <A HREF="../../../org/apache/mailet/MailetException.html">MailetException</A></PRE>
<DL>
<DD>Called by the matcher container to indicate to a matcher that the
matcher is being placed into service.
This implementation stores the MatcherConfig object it receives from
the matcher container for alter use. When overriding this form of the
method, call super.init(config).<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../org/apache/mailet/Matcher.html#init(org.apache.mailet.MatcherConfig)">init</A> in interface <A HREF="../../../org/apache/mailet/Matcher.html">Matcher</A><DT><B>Parameters:</B><DD><CODE>MatcherConfig</CODE> - config - the MatcherConfig object that contains
configutation information for this matcher<DT><B>Throws:</B><DD><A HREF="../../../org/apache/mailet/MailetException.html">MailetException</A> - if an exception occurs that interrupts the matcher's normal operation</DL>
</DD>
</DL>
<HR>
<A NAME="init()"><!-- --></A><H3>
init</H3>
<PRE>
public void <B>init</B>()
throws <A HREF="../../../org/apache/mailet/MailetException.html">MailetException</A></PRE>
<DL>
<DD>A convenience method which can be overridden so that there's no
need to call super.init(config).
Instead of overriding init(MatcherConfig), simply override this
method and it will be called by GenericMatcher.init(MatcherConfig config).
The MatcherConfig object can still be retrieved via getMatcherConfig().<DD><DL>
<DT><B>Throws:</B><DD>MatcherException - if an exception occurs that interrupts the matcher's normal operation</DL>
</DD>
</DL>
<HR>
<A NAME="log(java.lang.String)"><!-- --></A><H3>
log</H3>
<PRE>
public void <B>log</B>(java.lang.String message)</PRE>
<DL>
<DD>Writes the specified message to a matcher log file, prepended by
the matcher's name.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>msg</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>
public 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 matcher log file, prepended by the matcher's name.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>message</CODE> - - a String that describes the error or exception<DD><CODE>t</CODE> - - the java.lang.Throwable error or exception</DL>
</DD>
</DL>
<HR>
<A NAME="match(org.apache.mailet.Mail)"><!-- --></A><H3>
match</H3>
<PRE>
public abstract java.util.Collection <B>match</B>(<A HREF="../../../org/apache/mailet/Mail.html">Mail</A> mail)
throws <A HREF="../../../org/apache/mailet/MailetException.html">MailetException</A>,
javax.mail.MessagingException</PRE>
<DL>
<DD>Called by the matcher container to allow the matcher to process a
message.
This method is declared abstract so subclasses must override it.<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../org/apache/mailet/Matcher.html#match(org.apache.mailet.Mail)">match</A> in interface <A HREF="../../../org/apache/mailet/Matcher.html">Matcher</A><DT><B>Parameters:</B><DD><CODE>mail</CODE> - - the Mail object that contains the MimeMessage and
routing information<DT><B>Returns:</B><DD>Collection - the recipients that the mailet container should have the
mailet affect.<DT><B>Throws:</B><DD><A HREF="../../../org/apache/mailet/MailetException.html">MailetException</A> - - if an exception occurs that interferes with the mailet's normal operation
occurred</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_bottom"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" ID="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="package-summary.html"><FONT ID="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" ID="NavBarCell1Rev"> <FONT ID="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="package-tree.html"><FONT ID="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT ID="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../index-all.html"><FONT ID="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT ID="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" ID="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../org/apache/mailet/GenericMailet.html"><B>PREV CLASS</B></A>
<A HREF="../../../org/apache/mailet/GenericRecipientMatcher.html"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" ID="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="GenericMatcher.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
<TR>
<TD VALIGN="top" ID="NavBarCell3"><FONT SIZE="-2">
SUMMARY: INNER | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" ID="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
</BODY>
</HTML>
1.1 jakarta-james/www/mailet/org/apache/mailet/GenericRecipientMatcher.html
Index: GenericRecipientMatcher.html
===================================================================
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc on Tue Sep 12 18:58:55 EDT 2000 -->
<TITLE>
: Class GenericRecipientMatcher
</TITLE>
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
</HEAD>
<BODY BGCOLOR="white">
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_top"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" ID="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="package-summary.html"><FONT ID="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" ID="NavBarCell1Rev"> <FONT ID="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="package-tree.html"><FONT ID="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT ID="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../index-all.html"><FONT ID="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT ID="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" ID="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../org/apache/mailet/GenericMatcher.html"><B>PREV CLASS</B></A>
<A HREF="../../../org/apache/mailet/MailAddress.html"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" ID="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="GenericRecipientMatcher.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
<TR>
<TD VALIGN="top" ID="NavBarCell3"><FONT SIZE="-2">
SUMMARY: INNER | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" ID="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.apache.mailet</FONT>
<BR>
Class GenericRecipientMatcher</H2>
<PRE>
java.lang.Object
|
+--<A HREF="../../../org/apache/mailet/GenericMatcher.html">org.apache.mailet.GenericMatcher</A>
|
+--<B>org.apache.mailet.GenericRecipientMatcher</B>
</PRE>
<HR>
<DL>
<DT>public abstract class <B>GenericRecipientMatcher</B><DT>extends <A HREF="../../../org/apache/mailet/GenericMatcher.html">GenericMatcher</A></DL>
<P>
GenericMatcher makes writing recipient based matchers easier. It provides
simple versions of the lifecycle methods init and destroy and of the methods
in the MatcherConfig interface. GenericMatcher also implements the log method,
declared in the
MatcherContext interface.
<P>
<DL>
<DT><B>Version: </B><DD>1.0.0, 24/04/1999</DD>
<DT><B>Author: </B><DD>Federico Barbieri <sc...@pop.systemy.it>, Serge Knystautas <se...@lokitech.com></DD>
</DL>
<HR>
<P>
<!-- ======== INNER CLASS SUMMARY ======== -->
<!-- =========== FIELD SUMMARY =========== -->
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" ID="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" ID="TableRowColor">
<TD><CODE><B><A HREF="../../../org/apache/mailet/GenericRecipientMatcher.html#GenericRecipientMatcher()">GenericRecipientMatcher</A></B>()</CODE>
<BR>
</TD>
</TR>
</TABLE>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" ID="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Method Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" ID="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/GenericRecipientMatcher.html#match(org.apache.mailet.Mail)">match</A></B>(<A HREF="../../../org/apache/mailet/Mail.html">Mail</A> mail)</CODE>
<BR>
Matches each recipient one by one through matchRecipient(MailAddress
recipient) method.</TD>
</TR>
<TR BGCOLOR="white" ID="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>abstract boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/mailet/GenericRecipientMatcher.html#matchRecipient(org.apache.mailet.MailAddress)">matchRecipient</A></B>(<A HREF="../../../org/apache/mailet/MailAddress.html">MailAddress</A> recipient)</CODE>
<BR>
Simple check to match exclusively on the email address (not
message information).</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_org.apache.mailet.GenericMatcher"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#EEEEFF" ID="TableSubHeadingColor">
<TD><B>Methods inherited from class org.apache.mailet.<A HREF="../../../org/apache/mailet/GenericMatcher.html">GenericMatcher</A></B></TD>
</TR>
<TR BGCOLOR="white" ID="TableRowColor">
<TD><CODE><A HREF="../../../org/apache/mailet/GenericMatcher.html#destroy()">destroy</A>,
<A HREF="../../../org/apache/mailet/GenericMatcher.html#getCondition()">getCondition</A>,
<A HREF="../../../org/apache/mailet/GenericMatcher.html#getMailetContext()">getMailetContext</A>,
<A HREF="../../../org/apache/mailet/GenericMatcher.html#getMatcherConfig()">getMatcherConfig</A>,
<A HREF="../../../org/apache/mailet/GenericMatcher.html#getMatcherInfo()">getMatcherInfo</A>,
<A HREF="../../../org/apache/mailet/GenericMatcher.html#getMatcherName()">getMatcherName</A>,
<A HREF="../../../org/apache/mailet/GenericMatcher.html#init()">init</A>,
<A HREF="../../../org/apache/mailet/GenericMatcher.html#init(org.apache.mailet.MatcherConfig)">init</A>,
<A HREF="../../../org/apache/mailet/GenericMatcher.html#log(java.lang.String)">log</A>,
<A HREF="../../../org/apache/mailet/GenericMatcher.html#log(java.lang.String, java.lang.Throwable)">log</A></CODE></TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#EEEEFF" ID="TableSubHeadingColor">
<TD><B>Methods inherited from class java.lang.Object</B></TD>
</TR>
<TR BGCOLOR="white" ID="TableRowColor">
<TD><CODE>clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait</CODE></TD>
</TR>
</TABLE>
<P>
<!-- ============ FIELD DETAIL =========== -->
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" ID="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TD>
</TR>
</TABLE>
<A NAME="GenericRecipientMatcher()"><!-- --></A><H3>
GenericRecipientMatcher</H3>
<PRE>
public <B>GenericRecipientMatcher</B>()</PRE>
<DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" ID="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>
<A NAME="match(org.apache.mailet.Mail)"><!-- --></A><H3>
match</H3>
<PRE>
public final java.util.Collection <B>match</B>(<A HREF="../../../org/apache/mailet/Mail.html">Mail</A> mail)</PRE>
<DL>
<DD>Matches each recipient one by one through matchRecipient(MailAddress
recipient) method. Handles splitting the recipients Collection
as appropriate.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>mail</CODE> - - the message and routing information to determine whether to match<DT><B>Returns:</B><DD>Collection the Collection of MailAddress objects that have been matched<DT><B>Overrides:</B><DD><A HREF="../../../org/apache/mailet/GenericMatcher.html#match(org.apache.mailet.Mail)">match</A> in class <A HREF="../../../org/apache/mailet/GenericMatcher.html">GenericMatcher</A></DL>
</DD>
</DL>
<HR>
<A NAME="matchRecipient(org.apache.mailet.MailAddress)"><!-- --></A><H3>
matchRecipient</H3>
<PRE>
public abstract boolean <B>matchRecipient</B>(<A HREF="../../../org/apache/mailet/MailAddress.html">MailAddress</A> recipient)</PRE>
<DL>
<DD>Simple check to match exclusively on the email address (not
message information).<DD><DL>
<DT><B>Parameters:</B><DD><CODE>recipient</CODE> - - the address to determine whether to match<DT><B>Returns:</B><DD>boolean whether the recipient is a match</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_bottom"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" ID="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="package-summary.html"><FONT ID="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" ID="NavBarCell1Rev"> <FONT ID="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="package-tree.html"><FONT ID="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT ID="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../index-all.html"><FONT ID="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT ID="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" ID="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../org/apache/mailet/GenericMatcher.html"><B>PREV CLASS</B></A>
<A HREF="../../../org/apache/mailet/MailAddress.html"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" ID="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="GenericRecipientMatcher.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
<TR>
<TD VALIGN="top" ID="NavBarCell3"><FONT SIZE="-2">
SUMMARY: INNER | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" ID="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
</BODY>
</HTML>
1.1 jakarta-james/www/mailet/org/apache/mailet/Mail.html
Index: Mail.html
===================================================================
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc on Tue Sep 12 18:58:55 EDT 2000 -->
<TITLE>
: Interface Mail
</TITLE>
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
</HEAD>
<BODY BGCOLOR="white">
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_top"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" ID="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="package-summary.html"><FONT ID="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" ID="NavBarCell1Rev"> <FONT ID="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="package-tree.html"><FONT ID="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT ID="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../index-all.html"><FONT ID="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT ID="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" ID="NavBarCell2"><FONT SIZE="-2">
PREV CLASS
<A HREF="../../../org/apache/mailet/Mailet.html"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" ID="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="Mail.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
<TR>
<TD VALIGN="top" ID="NavBarCell3"><FONT SIZE="-2">
SUMMARY: INNER | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" ID="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.apache.mailet</FONT>
<BR>
Interface Mail</H2>
<HR>
<DL>
<DT>public abstract interface <B>Mail</B><DT>extends java.io.Serializable, java.lang.Cloneable</DL>
<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>
<DL>
<DT><B>Version: </B><DD>0.9</DD>
<DT><B>Author: </B><DD>Federico Barbieri <sc...@systemy.it>, Serge Knystautas <se...@lokitech.com></DD>
</DL>
<HR>
<P>
<!-- ======== INNER CLASS SUMMARY ======== -->
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" ID="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Field Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" ID="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" ID="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" ID="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" ID="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>
<A NAME="fields_inherited_from_class_java.io.Serializable"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#EEEEFF" ID="TableSubHeadingColor">
<TD><B>Fields inherited from class java.io.Serializable</B></TD>
</TR>
<TR BGCOLOR="white" ID="TableRowColor">
<TD><CODE>serialVersionUID</CODE></TD>
</TR>
</TABLE>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" ID="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Method Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" ID="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" ID="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" ID="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" ID="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" ID="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" ID="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../org/apache/mailet/MailAddress.html">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" ID="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" ID="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" ID="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(java.io.InputStream)">setMessage</A></B>(java.io.InputStream in)</CODE>
<BR>
Sets the MimeMessage associated with this message via an inputstream.</TD>
</TR>
<TR BGCOLOR="white" ID="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" ID="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>
<TR BGCOLOR="white" ID="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#writeContentTo(java.io.OutputStream, int)">writeContentTo</A></B>(java.io.OutputStream out,
int lines)</CODE>
<BR>
Dumps X many number of lines from this message to an output stream</TD>
</TR>
<TR BGCOLOR="white" ID="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#writeMessageTo(java.io.OutputStream)">writeMessageTo</A></B>(java.io.OutputStream out)</CODE>
<BR>
Dumps this message to an output stream</TD>
</TR>
</TABLE>
<P>
<!-- ============ FIELD DETAIL =========== -->
<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" ID="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Field Detail</B></FONT></TD>
</TR>
</TABLE>
<A NAME="GHOST"><!-- --></A><H3>
GHOST</H3>
<PRE>
public static final java.lang.String <B>GHOST</B></PRE>
<DL>
</DL>
<HR>
<A NAME="DEFAULT"><!-- --></A><H3>
DEFAULT</H3>
<PRE>
public static final java.lang.String <B>DEFAULT</B></PRE>
<DL>
</DL>
<HR>
<A NAME="ERROR"><!-- --></A><H3>
ERROR</H3>
<PRE>
public static final java.lang.String <B>ERROR</B></PRE>
<DL>
</DL>
<HR>
<A NAME="TRANSPORT"><!-- --></A><H3>
TRANSPORT</H3>
<PRE>
public static final java.lang.String <B>TRANSPORT</B></PRE>
<DL>
</DL>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" ID="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>
<A NAME="getMessage()"><!-- --></A><H3>
getMessage</H3>
<PRE>
public javax.mail.internet.MimeMessage <B>getMessage</B>()
throws javax.mail.MessagingException</PRE>
<DL>
<DD>Returns the MimeMessage stored in this message<DD><DL>
<DT><B>Returns:</B><DD>the MimeMessage that this Mail object wraps<DT><B>Throws:</B><DD>javax.mail.MessagingException - - an error occured while loading this object</DL>
</DD>
</DL>
<HR>
<A NAME="getRecipients()"><!-- --></A><H3>
getRecipients</H3>
<PRE>
public java.util.Collection <B>getRecipients</B>()</PRE>
<DL>
<DD>Returns a Collection of MailAddress objects that are recipients of this message<DD><DL>
<DT><B>Returns:</B><DD>a Collection of MailAddress objects that are recipients of this message</DL>
</DD>
</DL>
<HR>
<A NAME="getSender()"><!-- --></A><H3>
getSender</H3>
<PRE>
public <A HREF="../../../org/apache/mailet/MailAddress.html">MailAddress</A> <B>getSender</B>()</PRE>
<DL>
<DD>The sender of the message, as specified by the MAIL FROM header, or internally defined<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>
public java.lang.String <B>getState</B>()</PRE>
<DL>
<DD>The current state of the message, such as GHOST, ERROR, or DEFAULT<DD><DL>
<DT><B>Returns:</B><DD>the state of this message</DL>
</DD>
</DL>
<HR>
<A NAME="getRemoteHost()"><!-- --></A><H3>
getRemoteHost</H3>
<PRE>
public java.lang.String <B>getRemoteHost</B>()</PRE>
<DL>
<DD>The remote hostname of the server that connected to send this message<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>
public java.lang.String <B>getRemoteAddr</B>()</PRE>
<DL>
<DD>The remote ip address of the server that connected to send this message<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>
public java.lang.String <B>getErrorMessage</B>()</PRE>
<DL>
<DD>The error message, if any, associated with this message. Not sure why this is needed.<DD><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>
public void <B>setErrorMessage</B>(java.lang.String msg)</PRE>
<DL>
<DD>Sets the error message associated with this message. Not sure why this is needed.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>msg</CODE> - - a descriptive error message</DL>
</DD>
</DL>
<HR>
<A NAME="setMessage(java.io.InputStream)"><!-- --></A><H3>
setMessage</H3>
<PRE>
public void <B>setMessage</B>(java.io.InputStream in)
throws javax.mail.MessagingException</PRE>
<DL>
<DD>Sets the MimeMessage associated with this message via an inputstream. The Mail
object will parse out the inputstream and construct a MimeMessage object.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>in</CODE> - - the inputstream to read to construct the MimeMessage<DT><B>Throws:</B><DD>javax.mail.MessagingException - - if there was an error parsing the inputstream</DL>
</DD>
</DL>
<HR>
<A NAME="setMessage(javax.mail.internet.MimeMessage)"><!-- --></A><H3>
setMessage</H3>
<PRE>
public void <B>setMessage</B>(javax.mail.internet.MimeMessage message)</PRE>
<DL>
<DD>Sets the MimeMessage associated with this message via the object.<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>
public void <B>setState</B>(java.lang.String state)</PRE>
<DL>
<DD>Sets the state of this message.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>state</CODE> - - the new state of this message</DL>
</DD>
</DL>
<HR>
<A NAME="writeMessageTo(java.io.OutputStream)"><!-- --></A><H3>
writeMessageTo</H3>
<PRE>
public void <B>writeMessageTo</B>(java.io.OutputStream out)
throws java.io.IOException,
javax.mail.MessagingException</PRE>
<DL>
<DD>Dumps this message to an output stream<DD><DL>
<DT><B>Parameters:</B><DD><CODE>out</CODE> - - the outputstream to send the MimeMessage headers and body content</DL>
</DD>
</DL>
<HR>
<A NAME="writeContentTo(java.io.OutputStream, int)"><!-- --></A><H3>
writeContentTo</H3>
<PRE>
public void <B>writeContentTo</B>(java.io.OutputStream out,
int lines)
throws java.io.IOException,
javax.mail.MessagingException</PRE>
<DL>
<DD>Dumps X many number of lines from this message to an output stream<DD><DL>
<DT><B>Parameters:</B><DD><CODE>out</CODE> - - the outputstream to send the MimeMessage headers and body content<DD><CODE>lines</CODE> - - the number of lines to return of the message</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_bottom"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" ID="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="package-summary.html"><FONT ID="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" ID="NavBarCell1Rev"> <FONT ID="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="package-tree.html"><FONT ID="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT ID="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../index-all.html"><FONT ID="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT ID="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" ID="NavBarCell2"><FONT SIZE="-2">
PREV CLASS
<A HREF="../../../org/apache/mailet/Mailet.html"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" ID="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="Mail.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
<TR>
<TD VALIGN="top" ID="NavBarCell3"><FONT SIZE="-2">
SUMMARY: INNER | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" ID="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
</BODY>
</HTML>
1.1 jakarta-james/www/mailet/org/apache/mailet/MailAddress.html
Index: MailAddress.html
===================================================================
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc on Tue Sep 12 18:58:55 EDT 2000 -->
<TITLE>
: Class MailAddress
</TITLE>
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
</HEAD>
<BODY BGCOLOR="white">
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_top"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" ID="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="package-summary.html"><FONT ID="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" ID="NavBarCell1Rev"> <FONT ID="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="package-tree.html"><FONT ID="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT ID="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../index-all.html"><FONT ID="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT ID="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" ID="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../org/apache/mailet/GenericRecipientMatcher.html"><B>PREV CLASS</B></A>
NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" ID="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="MailAddress.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
<TR>
<TD VALIGN="top" ID="NavBarCell3"><FONT SIZE="-2">
SUMMARY: INNER | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" ID="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.apache.mailet</FONT>
<BR>
Class MailAddress</H2>
<PRE>
java.lang.Object
|
+--<B>org.apache.mailet.MailAddress</B>
</PRE>
<HR>
<DL>
<DT>public class <B>MailAddress</B><DT>extends java.lang.Object<DT>implements java.io.Serializable</DL>
<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>
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>
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. The MailAddress's "user" is the <local-part> of
the <mailbox> and "host" is the <domain> of the mailbox.
<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 user and
lokitech.com is the host). This means all current parsing to date
is incorrect as we just find the first @ and use that to separate
user from host.
<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>
<DL>
<DT><B>Version: </B><DD>1.0</DD>
<DT><B>Author: </B><DD>Roberto Lo Giacco <rl...@mail.com>, Serge Knystautas <se...@lokitech.com></DD>
<DT><B>See Also: </B><DD><A HREF="../../../serialized-form.html#org.apache.mailet.MailAddress">Serialized Form</A></DL>
<HR>
<P>
<!-- ======== INNER CLASS SUMMARY ======== -->
<!-- =========== FIELD SUMMARY =========== -->
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" ID="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" ID="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" ID="TableRowColor">
<TD><CODE><B><A HREF="../../../org/apache/mailet/MailAddress.html#MailAddress(java.lang.String, java.lang.String)">MailAddress</A></B>(java.lang.String newUser,
java.lang.String newHost)</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" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" ID="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Method Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" ID="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 object)</CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" ID="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>
Return the host part.</TD>
</TR>
<TR BGCOLOR="white" ID="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>
Return the user part.</TD>
</TR>
<TR BGCOLOR="white" ID="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>
</TD>
</TR>
<TR BGCOLOR="white" ID="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" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#EEEEFF" ID="TableSubHeadingColor">
<TD><B>Methods inherited from class java.lang.Object</B></TD>
</TR>
<TR BGCOLOR="white" ID="TableRowColor">
<TD><CODE>clone,
finalize,
getClass,
hashCode,
notify,
notifyAll,
wait,
wait,
wait</CODE></TD>
</TR>
</TABLE>
<P>
<!-- ============ FIELD DETAIL =========== -->
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" ID="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TD>
</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.ParseException</PRE>
<DL>
<DD>Construct a MailAddress parsing the provided <code>String</code> object.
<p>The <code>personal</code> variable is left empty.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>address</CODE> - the email address compliant to the RFC822 format<DT><B>Throws:</B><DD>javax.mail.internet.ParseException - if the parse failed</DL>
</DD>
</DL>
<HR>
<A NAME="MailAddress(java.lang.String, java.lang.String)"><!-- --></A><H3>
MailAddress</H3>
<PRE>
public <B>MailAddress</B>(java.lang.String newUser,
java.lang.String newHost)</PRE>
<DL>
<DD>Construct a MailAddress with the provided personal name and email
address.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>user</CODE> - the username or account name on the mail server<DD><CODE>host</CODE> - the server that should accept messages for this user<DT><B>Throws:</B><DD>javax.mail.internet.ParseException - if the parse failed</DL>
</DD>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" ID="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>
<A NAME="getHost()"><!-- --></A><H3>
getHost</H3>
<PRE>
public java.lang.String <B>getHost</B>()</PRE>
<DL>
<DD>Return the host part.<DD><DL>
<DT><B>Returns:</B><DD>a <code>String</code> object representing the host part
of this email address.<DT><B>Throws:</B><DD>AddressException - if the parse failed</DL>
</DD>
</DL>
<HR>
<A NAME="getUser()"><!-- --></A><H3>
getUser</H3>
<PRE>
public java.lang.String <B>getUser</B>()</PRE>
<DL>
<DD>Return the user part.<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>AddressException - 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>toString in class java.lang.Object</DL>
</DD>
</DL>
<HR>
<A NAME="equals(java.lang.Object)"><!-- --></A><H3>
equals</H3>
<PRE>
public boolean <B>equals</B>(java.lang.Object object)</PRE>
<DL>
<DD><DL>
<DT><B>Overrides:</B><DD>equals in class java.lang.Object</DL>
</DD>
</DL>
<HR>
<A NAME="toInternetAddress()"><!-- --></A><H3>
toInternetAddress</H3>
<PRE>
public javax.mail.internet.InternetAddress <B>toInternetAddress</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_bottom"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" ID="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="package-summary.html"><FONT ID="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" ID="NavBarCell1Rev"> <FONT ID="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="package-tree.html"><FONT ID="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT ID="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../index-all.html"><FONT ID="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT ID="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" ID="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../org/apache/mailet/GenericRecipientMatcher.html"><B>PREV CLASS</B></A>
NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" ID="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="MailAddress.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
<TR>
<TD VALIGN="top" ID="NavBarCell3"><FONT SIZE="-2">
SUMMARY: INNER | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" ID="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
</BODY>
</HTML>
1.1 jakarta-james/www/mailet/org/apache/mailet/Mailet.html
Index: Mailet.html
===================================================================
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc on Tue Sep 12 18:58:55 EDT 2000 -->
<TITLE>
: Interface Mailet
</TITLE>
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
</HEAD>
<BODY BGCOLOR="white">
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_top"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" ID="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="package-summary.html"><FONT ID="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" ID="NavBarCell1Rev"> <FONT ID="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="package-tree.html"><FONT ID="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT ID="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../index-all.html"><FONT ID="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT ID="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" ID="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../org/apache/mailet/Mail.html"><B>PREV CLASS</B></A>
<A HREF="../../../org/apache/mailet/MailetConfig.html"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" ID="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="Mailet.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
<TR>
<TD VALIGN="top" ID="NavBarCell3"><FONT SIZE="-2">
SUMMARY: INNER | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" ID="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.apache.mailet</FONT>
<BR>
Interface Mailet</H2>
<DL>
<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../org/apache/mailet/GenericMailet.html">GenericMailet</A></DD>
</DL>
<HR>
<DL>
<DT>public abstract interface <B>Mailet</B></DL>
<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 getMailletConfig
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>
<DL>
<DT><B>Version: </B><DD>1.0.0, 24/04/1999</DD>
<DT><B>Author: </B><DD>Federico Barbieri <sc...@pop.systemy.it>, Stefano Mazzocchi <st...@apache.org>, Pierpaolo Fumagalli <pi...@apache.org>, Serge Knystautas <se...@lokitech.com></DD>
</DL>
<HR>
<P>
<!-- ======== INNER CLASS SUMMARY ======== -->
<!-- =========== FIELD SUMMARY =========== -->
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" ID="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Method Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" ID="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" ID="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../org/apache/mailet/MailetConfig.html">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" ID="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" ID="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">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" ID="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">Mail</A> mail)</CODE>
<BR>
Called by the mailet container to allow the mailet to process to
a message message.</TD>
</TR>
</TABLE>
<P>
<!-- ============ FIELD DETAIL =========== -->
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" ID="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>
<A NAME="destroy()"><!-- --></A><H3>
destroy</H3>
<PRE>
public 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.</DL>
<HR>
<A NAME="getMailetInfo()"><!-- --></A><H3>
getMailetInfo</H3>
<PRE>
public 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.).<DD><DL>
<DT><B>Returns:</B><DD>a String containing servlet information</DL>
</DD>
</DL>
<HR>
<A NAME="getMailetConfig()"><!-- --></A><H3>
getMailetConfig</H3>
<PRE>
public <A HREF="../../../org/apache/mailet/MailetConfig.html">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.<DD><DL>
<DT><B>Returns:</B><DD>the MailletConfig object that initializes this mailet</DL>
</DD>
</DL>
<HR>
<A NAME="init(org.apache.mailet.MailetConfig)"><!-- --></A><H3>
init</H3>
<PRE>
public void <B>init</B>(<A HREF="../../../org/apache/mailet/MailetConfig.html">MailetConfig</A> config)
throws <A HREF="../../../org/apache/mailet/MailetException.html">MailetException</A></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.<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><A HREF="../../../org/apache/mailet/MailetException.html">MailetException</A> - - 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>
public void <B>service</B>(<A HREF="../../../org/apache/mailet/Mail.html">Mail</A> mail)
throws <A HREF="../../../org/apache/mailet/MailetException.html">MailetException</A>,
javax.mail.MessagingException</PRE>
<DL>
<DD>Called by the mailet container to allow the mailet to process to
a message 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, and 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>.<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><A HREF="../../../org/apache/mailet/MailetException.html">MailetException</A> - - if an exception occurs that interferes with the mailet's
normal operation<DD>MessagingException - - if an message or address parsing exception occurs</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_bottom"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" ID="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="package-summary.html"><FONT ID="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" ID="NavBarCell1Rev"> <FONT ID="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="package-tree.html"><FONT ID="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT ID="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../index-all.html"><FONT ID="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT ID="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" ID="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../org/apache/mailet/Mail.html"><B>PREV CLASS</B></A>
<A HREF="../../../org/apache/mailet/MailetConfig.html"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" ID="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="Mailet.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
<TR>
<TD VALIGN="top" ID="NavBarCell3"><FONT SIZE="-2">
SUMMARY: INNER | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" ID="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
</BODY>
</HTML>
1.1 jakarta-james/www/mailet/org/apache/mailet/MailetConfig.html
Index: MailetConfig.html
===================================================================
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc on Tue Sep 12 18:58:55 EDT 2000 -->
<TITLE>
: Interface MailetConfig
</TITLE>
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
</HEAD>
<BODY BGCOLOR="white">
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_top"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" ID="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="package-summary.html"><FONT ID="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" ID="NavBarCell1Rev"> <FONT ID="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="package-tree.html"><FONT ID="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT ID="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../index-all.html"><FONT ID="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT ID="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" ID="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../org/apache/mailet/Mailet.html"><B>PREV CLASS</B></A>
<A HREF="../../../org/apache/mailet/MailetContext.html"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" ID="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="MailetConfig.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
<TR>
<TD VALIGN="top" ID="NavBarCell3"><FONT SIZE="-2">
SUMMARY: INNER | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" ID="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.apache.mailet</FONT>
<BR>
Interface MailetConfig</H2>
<DL>
<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../org/apache/mailet/GenericMailet.html">GenericMailet</A></DD>
</DL>
<HR>
<DL>
<DT>public abstract interface <B>MailetConfig</B></DL>
<P>
A mailet configuration object used by a mailet container used 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>
<DL>
<DT><B>Version: </B><DD>1.0.0, 24/04/1999</DD>
<DT><B>Author: </B><DD>Serge Knystautas <se...@lokitech.com></DD>
</DL>
<HR>
<P>
<!-- ======== INNER CLASS SUMMARY ======== -->
<!-- =========== FIELD SUMMARY =========== -->
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" ID="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Method Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" ID="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" ID="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" ID="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../org/apache/mailet/MailetContext.html">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" ID="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>
<!-- ============ FIELD DETAIL =========== -->
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" ID="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>
<A NAME="getInitParameter(java.lang.String)"><!-- --></A><H3>
getInitParameter</H3>
<PRE>
public 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.<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>
public 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.<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>
public <A HREF="../../../org/apache/mailet/MailetContext.html">MailetContext</A> <B>getMailetContext</B>()</PRE>
<DL>
<DD>Returns a reference to the MailetContext in which the mailet is
executing.<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>
public 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.<DD><DL>
<DT><B>Returns:</B><DD>the name of the mailet instance</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_bottom"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" ID="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="package-summary.html"><FONT ID="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" ID="NavBarCell1Rev"> <FONT ID="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="package-tree.html"><FONT ID="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT ID="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../index-all.html"><FONT ID="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT ID="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" ID="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../org/apache/mailet/Mailet.html"><B>PREV CLASS</B></A>
<A HREF="../../../org/apache/mailet/MailetContext.html"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" ID="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="MailetConfig.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
<TR>
<TD VALIGN="top" ID="NavBarCell3"><FONT SIZE="-2">
SUMMARY: INNER | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" ID="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
</BODY>
</HTML>
1.1 jakarta-james/www/mailet/org/apache/mailet/MailetContext.html
Index: MailetContext.html
===================================================================
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc on Tue Sep 12 18:58:55 EDT 2000 -->
<TITLE>
: Interface MailetContext
</TITLE>
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
</HEAD>
<BODY BGCOLOR="white">
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_top"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" ID="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="package-summary.html"><FONT ID="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" ID="NavBarCell1Rev"> <FONT ID="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="package-tree.html"><FONT ID="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT ID="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../index-all.html"><FONT ID="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT ID="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" ID="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../org/apache/mailet/MailetConfig.html"><B>PREV CLASS</B></A>
<A HREF="../../../org/apache/mailet/Matcher.html"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" ID="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="MailetContext.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
<TR>
<TD VALIGN="top" ID="NavBarCell3"><FONT SIZE="-2">
SUMMARY: INNER | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" ID="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.apache.mailet</FONT>
<BR>
Interface MailetContext</H2>
<HR>
<DL>
<DT>public abstract interface <B>MailetContext</B></DL>
<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 the
mailets and matchers when they are initialized.
<P>
<DL>
<DT><B>Version: </B><DD>1.0.0, 24/04/1999</DD>
<DT><B>Author: </B><DD>Federico Barbieri <sc...@pop.systemy.it>, Stefano Mazzocchi <st...@apache.org>, Pierpaolo Fumagalli <pi...@apache.org>, Serge Knystautas <se...@lokitech.com></DD>
</DL>
<HR>
<P>
<!-- ======== INNER CLASS SUMMARY ======== -->
<!-- =========== FIELD SUMMARY =========== -->
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" ID="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Method Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" ID="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">Mail</A> mail,
java.lang.String message)</CODE>
<BR>
Bounces the message using a stanard format with the given message.</TD>
</TR>
<TR BGCOLOR="white" ID="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, java.lang.String)">bounce</A></B>(<A HREF="../../../org/apache/mailet/Mail.html">Mail</A> mail,
java.lang.String message,
java.lang.String bouncer)</CODE>
<BR>
Bounces the email message using the provided email address as the
sender of the bounce.</TD>
</TR>
<TR BGCOLOR="white" ID="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" ID="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" ID="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#getLocalUsers()">getLocalUsers</A></B>()</CODE>
<BR>
Returns a Collection of the local user accounts within this mailet
context.</TD>
</TR>
<TR BGCOLOR="white" ID="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" ID="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 minor version of the Mailet API that this mailet
container supports.</TD>
</TR>
<TR BGCOLOR="white" ID="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" ID="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../org/apache/mailet/MailAddress.html">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" ID="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" ID="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#getServerNames()">getServerNames</A></B>()</CODE>
<BR>
Returns a Collection of the server names that are considered "local"
by this mailet context.</TD>
</TR>
<TR BGCOLOR="white" ID="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" ID="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" ID="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" ID="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">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" ID="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">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" ID="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" ID="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">MailAddress</A> sender,
<A HREF="../../../org/apache/mailet/MailAddress.html">MailAddress</A> recipient,
javax.mail.internet.MimeMessage msg)</CODE>
<BR>
Stores mail into local accounts (POP3 by default, or the IMAP4 Inbox)</TD>
</TR>
</TABLE>
<P>
<!-- ============ FIELD DETAIL =========== -->
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" ID="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>
<A NAME="bounce(org.apache.mailet.Mail, java.lang.String)"><!-- --></A><H3>
bounce</H3>
<PRE>
public void <B>bounce</B>(<A HREF="../../../org/apache/mailet/Mail.html">Mail</A> mail,
java.lang.String message)</PRE>
<DL>
<DD>Bounces the message using a stanard format with the given 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().<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</DL>
</DD>
</DL>
<HR>
<A NAME="bounce(org.apache.mailet.Mail, java.lang.String, java.lang.String)"><!-- --></A><H3>
bounce</H3>
<PRE>
public void <B>bounce</B>(<A HREF="../../../org/apache/mailet/Mail.html">Mail</A> mail,
java.lang.String message,
java.lang.String bouncer)</PRE>
<DL>
<DD>Bounces the email message using the provided email address as the
sender of the bounce.<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</DL>
</DD>
</DL>
<HR>
<A NAME="getMailServers(java.lang.String)"><!-- --></A><H3>
getMailServers</H3>
<PRE>
public 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.<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>
public <A HREF="../../../org/apache/mailet/MailAddress.html">MailAddress</A> <B>getPostmaster</B>()</PRE>
<DL>
<DD>Returns the postmaster's address for this mailet context.<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>
public 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.*<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>
public 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.<DD><DL>
<DT><B>Returns:</B><DD>an Iterator of attribute names</DL>
</DD>
</DL>
<HR>
<A NAME="getMajorVersion()"><!-- --></A><H3>
getMajorVersion</H3>
<PRE>
public int <B>getMajorVersion</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 1.<DD><DL>
<DT><B>Returns:</B><DD>1</DL>
</DD>
</DL>
<HR>
<A NAME="getMinorVersion()"><!-- --></A><H3>
getMinorVersion</H3>
<PRE>
public 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.<DD><DL>
<DT><B>Returns:</B><DD>2</DL>
</DD>
</DL>
<HR>
<A NAME="getServerInfo()"><!-- --></A><H3>
getServerInfo</H3>
<PRE>
public 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).<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="getServerNames()"><!-- --></A><H3>
getServerNames</H3>
<PRE>
public java.util.Collection <B>getServerNames</B>()</PRE>
<DL>
<DD>Returns a Collection of the server names that are considered "local"
by this mailet context.<DD><DL>
<DT><B>Returns:</B><DD>a Collection of Strings of hostnames that are considered "local"</DL>
</DD>
</DL>
<HR>
<A NAME="getLocalUsers()"><!-- --></A><H3>
getLocalUsers</H3>
<PRE>
public java.util.Collection <B>getLocalUsers</B>()</PRE>
<DL>
<DD>Returns a Collection of the local user accounts within this mailet
context.<DD><DL>
<DT><B>Returns:</B><DD>a Collection of Strings of usernames that are considered "local"</DL>
</DD>
</DL>
<HR>
<A NAME="log(java.lang.String)"><!-- --></A><H3>
log</H3>
<PRE>
public 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.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>msg</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>
public 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.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>message</CODE> - - a String that describes the error or exception<DD><CODE>throwable</CODE> - - the Throwable error or exception</DL>
</DD>
</DL>
<HR>
<A NAME="removeAttribute(java.lang.String)"><!-- --></A><H3>
removeAttribute</H3>
<PRE>
public 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.<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(org.apache.mailet.MailAddress, java.util.Collection, javax.mail.internet.MimeMessage)"><!-- --></A><H3>
sendMail</H3>
<PRE>
public void <B>sendMail</B>(<A HREF="../../../org/apache/mailet/MailAddress.html">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.
Is the equivalent of opening an SMTP session to localhost.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>sender</CODE> - - the sender of the message<DD><CODE>recipients</CODE> - - a Collection of String objects of recipients<DD><CODE>msg</CODE> - - the MimeMessage of the headers and body content of the outgoing message<DT><B>Throws:</B><DD>javax.mail.MessagingException - - 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>
public void <B>sendMail</B>(<A HREF="../../../org/apache/mailet/MailAddress.html">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.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>sender</CODE> - - the sender of the message<DD><CODE>recipients</CODE> - - a Collection of String 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<DT><B>Throws:</B><DD>javax.mail.MessagingException - - if the message fails to parse</DL>
</DD>
</DL>
<HR>
<A NAME="setAttribute(java.lang.String, java.lang.Object)"><!-- --></A><H3>
setAttribute</H3>
<PRE>
public 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.*.<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>
public void <B>storeMail</B>(<A HREF="../../../org/apache/mailet/MailAddress.html">MailAddress</A> sender,
<A HREF="../../../org/apache/mailet/MailAddress.html">MailAddress</A> recipient,
javax.mail.internet.MimeMessage msg)
throws javax.mail.MessagingException</PRE>
<DL>
<DD>Stores mail into local accounts (POP3 by default, or the IMAP4 Inbox)<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>javax.mail.MessagingException - - if the message fails to parse</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_bottom"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" ID="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="package-summary.html"><FONT ID="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" ID="NavBarCell1Rev"> <FONT ID="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="package-tree.html"><FONT ID="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT ID="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../index-all.html"><FONT ID="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT ID="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" ID="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../org/apache/mailet/MailetConfig.html"><B>PREV CLASS</B></A>
<A HREF="../../../org/apache/mailet/Matcher.html"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" ID="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="MailetContext.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
<TR>
<TD VALIGN="top" ID="NavBarCell3"><FONT SIZE="-2">
SUMMARY: INNER | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" ID="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
</BODY>
</HTML>
1.1 jakarta-james/www/mailet/org/apache/mailet/MailetException.html
Index: MailetException.html
===================================================================
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc on Tue Sep 12 18:58:55 EDT 2000 -->
<TITLE>
: Class MailetException
</TITLE>
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
</HEAD>
<BODY BGCOLOR="white">
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_top"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" ID="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="package-summary.html"><FONT ID="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" ID="NavBarCell1Rev"> <FONT ID="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="package-tree.html"><FONT ID="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT ID="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../index-all.html"><FONT ID="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT ID="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" ID="NavBarCell2"><FONT SIZE="-2">
PREV CLASS
NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" ID="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="MailetException.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
<TR>
<TD VALIGN="top" ID="NavBarCell3"><FONT SIZE="-2">
SUMMARY: INNER | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" ID="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.apache.mailet</FONT>
<BR>
Class MailetException</H2>
<PRE>
java.lang.Object
|
+--java.lang.Throwable
|
+--java.lang.Exception
|
+--<B>org.apache.mailet.MailetException</B>
</PRE>
<HR>
<DL>
<DT>public class <B>MailetException</B><DT>extends java.lang.Exception</DL>
<P>
Defines a general exception a mailet can throw when it encounters difficulty.
<P>
<DL>
<DT><B>Version: </B><DD>1.0.0, 24/04/1999</DD>
<DT><B>Author: </B><DD>Serge Knystautas <se...@lokitech.com></DD>
<DT><B>See Also: </B><DD><A HREF="../../../serialized-form.html#org.apache.mailet.MailetException">Serialized Form</A></DL>
<HR>
<P>
<!-- ======== INNER CLASS SUMMARY ======== -->
<!-- =========== FIELD SUMMARY =========== -->
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" ID="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" ID="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" ID="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" ID="TableRowColor">
<TD><CODE><B><A HREF="../../../org/apache/mailet/MailetException.html#MailetException(java.lang.String, java.lang.Throwable)">MailetException</A></B>(java.lang.String message,
java.lang.Throwable t)</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>
<TR BGCOLOR="white" ID="TableRowColor">
<TD><CODE><B><A HREF="../../../org/apache/mailet/MailetException.html#MailetException(java.lang.Throwable)">MailetException</A></B>(java.lang.Throwable t)</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.</TD>
</TR>
</TABLE>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" ID="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Method Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" ID="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.Throwable</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/mailet/MailetException.html#getRootCause()">getRootCause</A></B>()</CODE>
<BR>
Returns the exception that caused this mailet exception.</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Throwable"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#EEEEFF" ID="TableSubHeadingColor">
<TD><B>Methods inherited from class java.lang.Throwable</B></TD>
</TR>
<TR BGCOLOR="white" ID="TableRowColor">
<TD><CODE>fillInStackTrace,
getLocalizedMessage,
getMessage,
printStackTrace,
printStackTrace,
printStackTrace,
toString</CODE></TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#EEEEFF" ID="TableSubHeadingColor">
<TD><B>Methods inherited from class java.lang.Object</B></TD>
</TR>
<TR BGCOLOR="white" ID="TableRowColor">
<TD><CODE>clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
wait,
wait,
wait</CODE></TD>
</TR>
</TABLE>
<P>
<!-- ============ FIELD DETAIL =========== -->
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" ID="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TD>
</TR>
</TABLE>
<A NAME="MailetException()"><!-- --></A><H3>
MailetException</H3>
<PRE>
public <B>MailetException</B>()</PRE>
<DL>
<DD>Constructs a new mailet exception.</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.</DL>
<HR>
<A NAME="MailetException(java.lang.String, java.lang.Throwable)"><!-- --></A><H3>
MailetException</H3>
<PRE>
public <B>MailetException</B>(java.lang.String message,
java.lang.Throwable t)</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.</DL>
<HR>
<A NAME="MailetException(java.lang.Throwable)"><!-- --></A><H3>
MailetException</H3>
<PRE>
public <B>MailetException</B>(java.lang.Throwable t)</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.</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" ID="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>
<A NAME="getRootCause()"><!-- --></A><H3>
getRootCause</H3>
<PRE>
public java.lang.Throwable <B>getRootCause</B>()</PRE>
<DL>
<DD>Returns the exception that caused this mailet exception.</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_bottom"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" ID="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="package-summary.html"><FONT ID="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" ID="NavBarCell1Rev"> <FONT ID="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="package-tree.html"><FONT ID="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT ID="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../index-all.html"><FONT ID="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT ID="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" ID="NavBarCell2"><FONT SIZE="-2">
PREV CLASS
NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" ID="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="MailetException.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
<TR>
<TD VALIGN="top" ID="NavBarCell3"><FONT SIZE="-2">
SUMMARY: INNER | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" ID="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
</BODY>
</HTML>
1.1 jakarta-james/www/mailet/org/apache/mailet/Matcher.html
Index: Matcher.html
===================================================================
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc on Tue Sep 12 18:58:55 EDT 2000 -->
<TITLE>
: Interface Matcher
</TITLE>
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
</HEAD>
<BODY BGCOLOR="white">
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_top"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" ID="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="package-summary.html"><FONT ID="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" ID="NavBarCell1Rev"> <FONT ID="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="package-tree.html"><FONT ID="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT ID="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../index-all.html"><FONT ID="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT ID="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" ID="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../org/apache/mailet/MailetContext.html"><B>PREV CLASS</B></A>
<A HREF="../../../org/apache/mailet/MatcherConfig.html"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" ID="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="Matcher.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
<TR>
<TD VALIGN="top" ID="NavBarCell3"><FONT SIZE="-2">
SUMMARY: INNER | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" ID="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.apache.mailet</FONT>
<BR>
Interface Matcher</H2>
<DL>
<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../org/apache/mailet/GenericMatcher.html">GenericMatcher</A></DD>
</DL>
<HR>
<DL>
<DT>public abstract interface <B>Matcher</B></DL>
<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>
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.
<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>
<DL>
<DT><B>Version: </B><DD>1.0.0, 24/04/1999</DD>
<DT><B>Author: </B><DD>Federico Barbieri <sc...@pop.systemy.it>, Serge Knystautas <se...@lokitech.com></DD>
</DL>
<HR>
<P>
<!-- ======== INNER CLASS SUMMARY ======== -->
<!-- =========== FIELD SUMMARY =========== -->
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" ID="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Method Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" ID="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" ID="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../org/apache/mailet/MatcherConfig.html">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" ID="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" ID="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">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" ID="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">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>
<!-- ============ FIELD DETAIL =========== -->
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" ID="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>
<A NAME="destroy()"><!-- --></A><H3>
destroy</H3>
<PRE>
public 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.</DL>
<HR>
<A NAME="getMatcherConfig()"><!-- --></A><H3>
getMatcherConfig</H3>
<PRE>
public <A HREF="../../../org/apache/mailet/MatcherConfig.html">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.<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>
public 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.).<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>
public void <B>init</B>(<A HREF="../../../org/apache/mailet/MatcherConfig.html">MatcherConfig</A> config)
throws <A HREF="../../../org/apache/mailet/MailetException.html">MailetException</A></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.<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><A HREF="../../../org/apache/mailet/MailetException.html">MailetException</A> - - 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>
public java.util.Collection <B>match</B>(<A HREF="../../../org/apache/mailet/Mail.html">Mail</A> mail)
throws <A HREF="../../../org/apache/mailet/MailetException.html">MailetException</A>,
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>.<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><A HREF="../../../org/apache/mailet/MailetException.html">MailetException</A> - - if an exception occurs that interferes with the matcher's
normal operation<DD>MessagingException - - if an message or address parsing exception occurs</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_bottom"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" ID="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="package-summary.html"><FONT ID="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" ID="NavBarCell1Rev"> <FONT ID="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="package-tree.html"><FONT ID="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT ID="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../index-all.html"><FONT ID="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT ID="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" ID="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../org/apache/mailet/MailetContext.html"><B>PREV CLASS</B></A>
<A HREF="../../../org/apache/mailet/MatcherConfig.html"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" ID="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="Matcher.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
<TR>
<TD VALIGN="top" ID="NavBarCell3"><FONT SIZE="-2">
SUMMARY: INNER | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" ID="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
</BODY>
</HTML>
1.1 jakarta-james/www/mailet/org/apache/mailet/MatcherConfig.html
Index: MatcherConfig.html
===================================================================
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc on Tue Sep 12 18:58:55 EDT 2000 -->
<TITLE>
: Interface MatcherConfig
</TITLE>
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
</HEAD>
<BODY BGCOLOR="white">
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_top"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" ID="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="package-summary.html"><FONT ID="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" ID="NavBarCell1Rev"> <FONT ID="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="package-tree.html"><FONT ID="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT ID="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../index-all.html"><FONT ID="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT ID="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" ID="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../org/apache/mailet/Matcher.html"><B>PREV CLASS</B></A>
NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" ID="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="MatcherConfig.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
<TR>
<TD VALIGN="top" ID="NavBarCell3"><FONT SIZE="-2">
SUMMARY: INNER | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" ID="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.apache.mailet</FONT>
<BR>
Interface MatcherConfig</H2>
<DL>
<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../org/apache/mailet/GenericMatcher.html">GenericMatcher</A></DD>
</DL>
<HR>
<DL>
<DT>public abstract interface <B>MatcherConfig</B></DL>
<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>
<DL>
<DT><B>Version: </B><DD>1.0.0, 24/04/1999</DD>
<DT><B>Author: </B><DD>Serge Knystautas <se...@lokitech.com></DD>
</DL>
<HR>
<P>
<!-- ======== INNER CLASS SUMMARY ======== -->
<!-- =========== FIELD SUMMARY =========== -->
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" ID="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Method Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" ID="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" ID="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../org/apache/mailet/MailetContext.html">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" ID="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>
<!-- ============ FIELD DETAIL =========== -->
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" ID="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>
<A NAME="getCondition()"><!-- --></A><H3>
getCondition</H3>
<PRE>
public 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.<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>
public <A HREF="../../../org/apache/mailet/MailetContext.html">MailetContext</A> <B>getMailetContext</B>()</PRE>
<DL>
<DD>Returns a reference to the MailetContext in which the matcher is executing<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>
public 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.<DD><DL>
<DT><B>Returns:</B><DD>the name of the matcher instance</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_bottom"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" ID="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="package-summary.html"><FONT ID="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" ID="NavBarCell1Rev"> <FONT ID="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="package-tree.html"><FONT ID="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT ID="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../index-all.html"><FONT ID="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT ID="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" ID="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../org/apache/mailet/Matcher.html"><B>PREV CLASS</B></A>
NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" ID="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="MatcherConfig.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
<TR>
<TD VALIGN="top" ID="NavBarCell3"><FONT SIZE="-2">
SUMMARY: INNER | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" ID="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
</BODY>
</HTML>
1.1 jakarta-james/www/mailet/org/apache/mailet/package-frame.html
Index: package-frame.html
===================================================================
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc on Tue Sep 12 18:58:55 EDT 2000 -->
<TITLE>
: Package org.apache.mailet
</TITLE>
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
</HEAD>
<BODY BGCOLOR="white">
<FONT size="+1" ID="FrameTitleFont">
<A HREF="../../../org/apache/mailet/package-summary.html" TARGET="classFrame">org.apache.mailet</A></FONT>
<TABLE BORDER="0" WIDTH="100%">
<TR>
<TD NOWRAP><FONT size="+1" ID="FrameHeadingFont">
Interfaces</FONT>
<FONT ID="FrameItemFont">
<BR>
<A HREF="Mail.html" TARGET="classFrame"><I>Mail</I></A>
<BR>
<A HREF="Mailet.html" TARGET="classFrame"><I>Mailet</I></A>
<BR>
<A HREF="MailetConfig.html" TARGET="classFrame"><I>MailetConfig</I></A>
<BR>
<A HREF="MailetContext.html" TARGET="classFrame"><I>MailetContext</I></A>
<BR>
<A HREF="Matcher.html" TARGET="classFrame"><I>Matcher</I></A>
<BR>
<A HREF="MatcherConfig.html" TARGET="classFrame"><I>MatcherConfig</I></A></FONT></TD>
</TR>
</TABLE>
<TABLE BORDER="0" WIDTH="100%">
<TR>
<TD NOWRAP><FONT size="+1" ID="FrameHeadingFont">
Classes</FONT>
<FONT ID="FrameItemFont">
<BR>
<A HREF="GenericMailet.html" TARGET="classFrame">GenericMailet</A>
<BR>
<A HREF="GenericMatcher.html" TARGET="classFrame">GenericMatcher</A>
<BR>
<A HREF="GenericRecipientMatcher.html" TARGET="classFrame">GenericRecipientMatcher</A>
<BR>
<A HREF="MailAddress.html" TARGET="classFrame">MailAddress</A></FONT></TD>
</TR>
</TABLE>
<TABLE BORDER="0" WIDTH="100%">
<TR>
<TD NOWRAP><FONT size="+1" ID="FrameHeadingFont">
Exceptions</FONT>
<FONT ID="FrameItemFont">
<BR>
<A HREF="MailetException.html" TARGET="classFrame">MailetException</A></FONT></TD>
</TR>
</TABLE>
</BODY>
</HTML>
1.1 jakarta-james/www/mailet/org/apache/mailet/package-summary.html
Index: package-summary.html
===================================================================
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc on Tue Sep 12 18:58:54 EDT 2000 -->
<TITLE>
: Package org.apache.mailet
</TITLE>
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
</HEAD>
<BODY BGCOLOR="white">
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_top"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" ID="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#FFFFFF" ID="NavBarCell1Rev"> <FONT ID="NavBarFont1Rev"><B>Package</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <FONT ID="NavBarFont1">Class</FONT> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="package-tree.html"><FONT ID="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT ID="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../index-all.html"><FONT ID="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT ID="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" ID="NavBarCell2"><FONT SIZE="-2">
PREV PACKAGE
NEXT PACKAGE</FONT></TD>
<TD BGCOLOR="white" ID="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="package-summary.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
<H2>
Package org.apache.mailet
</H2>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" ID="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Interface Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" ID="TableRowColor">
<TD WIDTH="15%"><B><A HREF="Mail.html"><I>Mail</I></A></B></TD>
<TD>Wrap a MimeMessage with routing information (from SMTP) such
as SMTP specified recipients, sender, and ip address and hostname
of sending server.</TD>
</TR>
<TR BGCOLOR="white" ID="TableRowColor">
<TD WIDTH="15%"><B><A HREF="Mailet.html"><I>Mailet</I></A></B></TD>
<TD>Draft of a Mailet inteface.</TD>
</TR>
<TR BGCOLOR="white" ID="TableRowColor">
<TD WIDTH="15%"><B><A HREF="MailetConfig.html"><I>MailetConfig</I></A></B></TD>
<TD>A mailet configuration object used by a mailet container used to pass information
to a mailet during initialization.</TD>
</TR>
<TR BGCOLOR="white" ID="TableRowColor">
<TD WIDTH="15%"><B><A HREF="MailetContext.html"><I>MailetContext</I></A></B></TD>
<TD>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.</TD>
</TR>
<TR BGCOLOR="white" ID="TableRowColor">
<TD WIDTH="15%"><B><A HREF="Matcher.html"><I>Matcher</I></A></B></TD>
<TD>This interface define the behaviour of the message "routing" inside
the mailet container.</TD>
</TR>
<TR BGCOLOR="white" ID="TableRowColor">
<TD WIDTH="15%"><B><A HREF="MatcherConfig.html"><I>MatcherConfig</I></A></B></TD>
<TD>A matcher configuration object used by a mailet container used to pass information
to a matcher during initialization.</TD>
</TR>
</TABLE>
<P>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" ID="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Class Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" ID="TableRowColor">
<TD WIDTH="15%"><B><A HREF="GenericMailet.html">GenericMailet</A></B></TD>
<TD>GenericMailet makes writing mailets easier.</TD>
</TR>
<TR BGCOLOR="white" ID="TableRowColor">
<TD WIDTH="15%"><B><A HREF="GenericMatcher.html">GenericMatcher</A></B></TD>
<TD>GenericMatcher implements the Matcher and MatcherConfig interfaces.</TD>
</TR>
<TR BGCOLOR="white" ID="TableRowColor">
<TD WIDTH="15%"><B><A HREF="GenericRecipientMatcher.html">GenericRecipientMatcher</A></B></TD>
<TD>GenericMatcher makes writing recipient based matchers easier.</TD>
</TR>
<TR BGCOLOR="white" ID="TableRowColor">
<TD WIDTH="15%"><B><A HREF="MailAddress.html">MailAddress</A></B></TD>
<TD>A representation of an email address.</TD>
</TR>
</TABLE>
<P>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" ID="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Exception Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" ID="TableRowColor">
<TD WIDTH="15%"><B><A HREF="MailetException.html">MailetException</A></B></TD>
<TD>Defines a general exception a mailet can throw when it encounters difficulty.</TD>
</TR>
</TABLE>
<P>
<HR>
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_bottom"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" ID="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#FFFFFF" ID="NavBarCell1Rev"> <FONT ID="NavBarFont1Rev"><B>Package</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <FONT ID="NavBarFont1">Class</FONT> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="package-tree.html"><FONT ID="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT ID="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../index-all.html"><FONT ID="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT ID="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" ID="NavBarCell2"><FONT SIZE="-2">
PREV PACKAGE
NEXT PACKAGE</FONT></TD>
<TD BGCOLOR="white" ID="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="package-summary.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
</BODY>
</HTML>
1.1 jakarta-james/www/mailet/org/apache/mailet/package-tree.html
Index: package-tree.html
===================================================================
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc on Tue Sep 12 18:58:55 EDT 2000 -->
<TITLE>
: org.apache.mailet Class Hierarchy
</TITLE>
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
</HEAD>
<BODY BGCOLOR="white">
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_top"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" ID="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="package-summary.html"><FONT ID="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <FONT ID="NavBarFont1">Class</FONT> </TD>
<TD BGCOLOR="#FFFFFF" ID="NavBarCell1Rev"> <FONT ID="NavBarFont1Rev"><B>Tree</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT ID="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../index-all.html"><FONT ID="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT ID="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" ID="NavBarCell2"><FONT SIZE="-2">
PREV
NEXT</FONT></TD>
<TD BGCOLOR="white" ID="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="package-tree.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
<CENTER>
<H2>
Hierarchy For Package org.apache.mailet
</H2>
</CENTER>
<H2>
Class Hierarchy
</H2>
<UL>
<LI TYPE="circle">class java.lang.Object<UL>
<LI TYPE="circle">class org.apache.mailet.<A HREF="../../../org/apache/mailet/GenericMailet.html"><B>GenericMailet</B></A> (implements org.apache.mailet.<A HREF="../../../org/apache/mailet/Mailet.html">Mailet</A>, org.apache.mailet.<A HREF="../../../org/apache/mailet/MailetConfig.html">MailetConfig</A>)
<LI TYPE="circle">class org.apache.mailet.<A HREF="../../../org/apache/mailet/GenericMatcher.html"><B>GenericMatcher</B></A> (implements org.apache.mailet.<A HREF="../../../org/apache/mailet/Matcher.html">Matcher</A>, org.apache.mailet.<A HREF="../../../org/apache/mailet/MatcherConfig.html">MatcherConfig</A>)
<UL>
<LI TYPE="circle">class org.apache.mailet.<A HREF="../../../org/apache/mailet/GenericRecipientMatcher.html"><B>GenericRecipientMatcher</B></A></UL>
<LI TYPE="circle">class org.apache.mailet.<A HREF="../../../org/apache/mailet/MailAddress.html"><B>MailAddress</B></A> (implements java.io.Serializable)
<LI TYPE="circle">class java.lang.Throwable (implements java.io.Serializable)
<UL>
<LI TYPE="circle">class java.lang.Exception<UL>
<LI TYPE="circle">class org.apache.mailet.<A HREF="../../../org/apache/mailet/MailetException.html"><B>MailetException</B></A></UL>
</UL>
</UL>
</UL>
<H2>
Interface Hierarchy
</H2>
<UL>
<LI TYPE="circle">interface java.lang.Cloneable<UL>
<LI TYPE="circle">interface org.apache.mailet.<A HREF="../../../org/apache/mailet/Mail.html"><B>Mail</B></A>(also extends java.io.Serializable)
</UL>
<LI TYPE="circle">interface org.apache.mailet.<A HREF="../../../org/apache/mailet/Mailet.html"><B>Mailet</B></A><LI TYPE="circle">interface org.apache.mailet.<A HREF="../../../org/apache/mailet/MailetConfig.html"><B>MailetConfig</B></A><LI TYPE="circle">interface org.apache.mailet.<A HREF="../../../org/apache/mailet/MailetContext.html"><B>MailetContext</B></A><LI TYPE="circle">interface org.apache.mailet.<A HREF="../../../org/apache/mailet/Matcher.html"><B>Matcher</B></A><LI TYPE="circle">interface org.apache.mailet.<A HREF="../../../org/apache/mailet/MatcherConfig.html"><B>MatcherConfig</B></A><LI TYPE="circle">interface java.io.Serializable<UL>
<LI TYPE="circle">interface org.apache.mailet.<A HREF="../../../org/apache/mailet/Mail.html"><B>Mail</B></A>(also extends java.lang.Cloneable)
</UL>
</UL>
<HR>
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_bottom"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" ID="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="package-summary.html"><FONT ID="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <FONT ID="NavBarFont1">Class</FONT> </TD>
<TD BGCOLOR="#FFFFFF" ID="NavBarCell1Rev"> <FONT ID="NavBarFont1Rev"><B>Tree</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT ID="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../index-all.html"><FONT ID="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" ID="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT ID="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" ID="NavBarCell2"><FONT SIZE="-2">
PREV
NEXT</FONT></TD>
<TD BGCOLOR="white" ID="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="package-tree.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
</BODY>
</HTML>
---------------------------------------------------------------------
To unsubscribe, e-mail: james-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: james-dev-help@jakarta.apache.org