You are viewing a plain text version of this content. The canonical link for it is here.
Posted to site-dev@james.apache.org by rd...@apache.org on 2008/08/31 21:25:38 UTC
svn commit: r690765 [4/20] - in /james/site/trunk/www/mailet/base: ./
apidocs/ apidocs/org/ apidocs/org/apache/ apidocs/org/apache/james/
apidocs/org/apache/james/util/ apidocs/org/apache/james/util/mailet/
apidocs/org/apache/james/util/mailet/class-us...
Added: james/site/trunk/www/mailet/base/apidocs/org/apache/mailet/GenericMailet.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/mailet/base/apidocs/org/apache/mailet/GenericMailet.html?rev=690765&view=auto
==============================================================================
--- james/site/trunk/www/mailet/base/apidocs/org/apache/mailet/GenericMailet.html (added)
+++ james/site/trunk/www/mailet/base/apidocs/org/apache/mailet/GenericMailet.html Sun Aug 31 12:25:33 2008
@@ -0,0 +1,679 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!--NewPage-->
+<HTML>
+<HEAD>
+<!-- Generated by javadoc (build 1.5.0_16) on Sun Aug 31 19:51:38 BST 2008 -->
+<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<TITLE>
+GenericMailet (Apache JAMES Basic Mailet Toolkit 1.0-SNAPSHOT API)
+</TITLE>
+
+<META NAME="keywords" CONTENT="org.apache.mailet.GenericMailet class">
+
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
+
+<SCRIPT type="text/javascript">
+function windowTitle()
+{
+ parent.document.title="GenericMailet (Apache JAMES Basic Mailet Toolkit 1.0-SNAPSHOT API)";
+}
+</SCRIPT>
+<NOSCRIPT>
+</NOSCRIPT>
+
+</HEAD>
+
+<BODY BGCOLOR="white" onload="windowTitle();">
+
+
+<!-- ========= START OF TOP NAVBAR ======= -->
+<A NAME="navbar_top"><!-- --></A>
+<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
+<TR>
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_top_firstrow"><!-- --></A>
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
+ <TR ALIGN="center" VALIGN="top">
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/GenericMailet.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ PREV CLASS
+ <A HREF="../../../org/apache/mailet/GenericMatcher.html" title="class in org.apache.mailet"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../index.html?org/apache/mailet/GenericMailet.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="GenericMailet.html" target="_top"><B>NO FRAMES</B></A>
+ <SCRIPT type="text/javascript">
+ <!--
+ if(window==top) {
+ document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
+ }
+ //-->
+</SCRIPT>
+<NOSCRIPT>
+ <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
+</NOSCRIPT>
+
+
+</FONT></TD>
+</TR>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+ SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<A NAME="skip-navbar_top"></A>
+<!-- ========= END OF TOP NAVBAR ========= -->
+
+<HR>
+<!-- ======== START OF CLASS DATA ======== -->
+<H2>
+<FONT SIZE="-1">
+org.apache.mailet</FONT>
+<BR>
+Class GenericMailet</H2>
+<PRE>
+java.lang.Object
+ <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>org.apache.mailet.GenericMailet</B>
+</PRE>
+<DL>
+<DT><B>All Implemented Interfaces:</B> <DD>org.apache.mailet.Mailet, org.apache.mailet.MailetConfig</DD>
+</DL>
+<HR>
+<DL>
+<DT><PRE>public abstract class <B>GenericMailet</B><DT>extends java.lang.Object<DT>implements org.apache.mailet.Mailet, org.apache.mailet.MailetConfig</DL>
+</PRE>
+
+<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>
+
+<P>
+<DL>
+<DT><B>Version:</B></DT>
+ <DD>1.0.0, 24/04/1999</DD>
+</DL>
+<HR>
+
+<P>
+
+<!-- ======== CONSTRUCTOR SUMMARY ======== -->
+
+<A NAME="constructor_summary"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
+<B>Constructor Summary</B></FONT></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE><B><A HREF="../../../org/apache/mailet/GenericMailet.html#GenericMailet()">GenericMailet</A></B>()</CODE>
+
+<BR>
+ </TD>
+</TR>
+</TABLE>
+
+<!-- ========== METHOD SUMMARY =========== -->
+
+<A NAME="method_summary"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
+<B>Method Summary</B></FONT></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>protected java.lang.String</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/mailet/GenericMailet.html#arrayToString(java.lang.Object[])">arrayToString</A></B>(java.lang.Object[] array)</CODE>
+
+<BR>
+ Utility method for obtaining a string representation of an array of Objects.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>protected void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/mailet/GenericMailet.html#checkInitParameters(java.lang.String[])">checkInitParameters</A></B>(java.lang.String[] allowedArray)</CODE>
+
+<BR>
+ Utility method: Checks if there are unallowed init parameters specified in the
+ configuration file against the String[] allowedInitParameters.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/mailet/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" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.lang.String</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/mailet/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" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.lang.String</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/mailet/GenericMailet.html#getInitParameter(java.lang.String, java.lang.String)">getInitParameter</A></B>(java.lang.String name,
+ java.lang.String defValue)</CODE>
+
+<BR>
+ Returns a String containing the value of the named initialization
+ parameter, or defValue if the parameter does not exist.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.util.Iterator</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/mailet/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" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> org.apache.mailet.MailetConfig</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/mailet/GenericMailet.html#getMailetConfig()">getMailetConfig</A></B>()</CODE>
+
+<BR>
+ Returns this Mailet's MailetConfig object.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> org.apache.mailet.MailetContext</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" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.lang.String</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/mailet/GenericMailet.html#getMailetInfo()">getMailetInfo</A></B>()</CODE>
+
+<BR>
+ Returns information about the mailet, such as author, version, and
+ copyright.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> 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" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/mailet/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" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/mailet/GenericMailet.html#init(org.apache.mailet.MailetConfig)">init</A></B>(org.apache.mailet.MailetConfig 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" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/mailet/GenericMailet.html#log(java.lang.String)">log</A></B>(java.lang.String message)</CODE>
+
+<BR>
+ Writes the specified message to a mailet log file.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/mailet/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.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="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>(org.apache.mailet.Mail 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" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
+<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
+</TR>
+</TABLE>
+
+<P>
+
+<!-- ========= CONSTRUCTOR DETAIL ======== -->
+
+<A NAME="constructor_detail"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Constructor Detail</B></FONT></TH>
+</TR>
+</TABLE>
+
+<A NAME="GenericMailet()"><!-- --></A><H3>
+GenericMailet</H3>
+<PRE>
+public <B>GenericMailet</B>()</PRE>
+<DL>
+</DL>
+
+<!-- ============ METHOD DETAIL ========== -->
+
+<A NAME="method_detail"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Method Detail</B></FONT></TH>
+</TR>
+</TABLE>
+
+<A NAME="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.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE>destroy</CODE> in interface <CODE>org.apache.mailet.Mailet</CODE></DL>
+</DD>
+<DD><DL>
+</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.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE>getInitParameter</CODE> in interface <CODE>org.apache.mailet.MailetConfig</CODE></DL>
+</DD>
+<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 initalization parameter</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getInitParameter(java.lang.String, java.lang.String)"><!-- --></A><H3>
+getInitParameter</H3>
+<PRE>
+public java.lang.String <B>getInitParameter</B>(java.lang.String name,
+ java.lang.String defValue)</PRE>
+<DL>
+<DD>Returns a String containing the value of the named initialization
+ parameter, or defValue 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.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>name</CODE> - - a String specifying the name of the initialization parameter<DD><CODE>defValue</CODE> - - a String specifying the default value when the parameter
+ is not present
+<DT><B>Returns:</B><DD>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.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE>getInitParameterNames</CODE> in interface <CODE>org.apache.mailet.MailetConfig</CODE></DL>
+</DD>
+<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="getMailetConfig()"><!-- --></A><H3>
+getMailetConfig</H3>
+<PRE>
+public org.apache.mailet.MailetConfig <B>getMailetConfig</B>()</PRE>
+<DL>
+<DD>Returns this Mailet's MailetConfig object.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE>getMailetConfig</CODE> in interface <CODE>org.apache.mailet.Mailet</CODE></DL>
+</DD>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>the MailetConfig object that initialized this mailet</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getMailetContext()"><!-- --></A><H3>
+getMailetContext</H3>
+<PRE>
+public org.apache.mailet.MailetContext <B>getMailetContext</B>()</PRE>
+<DL>
+<DD>Returns a reference to the MailetContext in which this mailet is
+ running.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE>getMailetContext</CODE> in interface <CODE>org.apache.mailet.MailetConfig</CODE></DL>
+</DD>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>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.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE>getMailetInfo</CODE> in interface <CODE>org.apache.mailet.Mailet</CODE></DL>
+</DD>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>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.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE>getMailetName</CODE> in interface <CODE>org.apache.mailet.MailetConfig</CODE></DL>
+</DD>
+<DD><DL>
+
+<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>(org.apache.mailet.MailetConfig newConfig)
+ throws javax.mail.MessagingException</PRE>
+<DL>
+<DD><p>Called by the mailet container to indicate to a mailet that the
+ mailet is being placed into service.</p>
+
+ <p>This implementation stores the MailetConfig object it receives from
+ the mailet container for later use. When overriding this form of the
+ method, call super.init(config).</p>
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE>init</CODE> in interface <CODE>org.apache.mailet.Mailet</CODE></DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>newConfig</CODE> - - the MailetConfig object that contains
+ configutation information for this mailet
+<DT><B>Throws:</B>
+<DD><CODE>javax.mail.MessagingException</CODE> - 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 javax.mail.MessagingException</PRE>
+<DL>
+<DD><p>A convenience method which can be overridden so that there's no
+ need to call super.init(config).</p>
+
+ 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().
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+
+<DT><B>Throws:</B>
+<DD><CODE>javax.mail.MessagingException</CODE> - 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.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>message</CODE> - - a String specifying the message to be written to the log file</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="log(java.lang.String, java.lang.Throwable)"><!-- --></A><H3>
+log</H3>
+<PRE>
+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.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<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 to be logged</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="service(org.apache.mailet.Mail)"><!-- --></A><H3>
+service</H3>
+<PRE>
+public abstract void <B>service</B>(org.apache.mailet.Mail mail)
+ throws javax.mail.MessagingException</PRE>
+<DL>
+<DD><p>Called by the mailet container to allow the mailet to process a
+ message.</p>
+
+ <p>This method is declared abstract so subclasses must override it.</p>
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE>service</CODE> in interface <CODE>org.apache.mailet.Mailet</CODE></DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>mail</CODE> - - the Mail object that contains the MimeMessage and
+ routing information
+<DT><B>Throws:</B>
+<DD><CODE>javax.mail.MessagingException</CODE> - - if an exception occurs that interferes with the mailet's normal operation</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="checkInitParameters(java.lang.String[])"><!-- --></A><H3>
+checkInitParameters</H3>
+<PRE>
+protected final void <B>checkInitParameters</B>(java.lang.String[] allowedArray)
+ throws javax.mail.MessagingException</PRE>
+<DL>
+<DD>Utility method: Checks if there are unallowed init parameters specified in the
+ configuration file against the String[] allowedInitParameters.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>allowedArray</CODE> - array of strings containing the allowed parameter names
+<DT><B>Throws:</B>
+<DD><CODE>javax.mail.MessagingException</CODE> - if an unknown parameter name is found</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="arrayToString(java.lang.Object[])"><!-- --></A><H3>
+arrayToString</H3>
+<PRE>
+protected final java.lang.String <B>arrayToString</B>(java.lang.Object[] array)</PRE>
+<DL>
+<DD>Utility method for obtaining a string representation of an array of Objects.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<!-- ========= END OF CLASS DATA ========= -->
+<HR>
+
+
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<A NAME="navbar_bottom"><!-- --></A>
+<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
+<TR>
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_bottom_firstrow"><!-- --></A>
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
+ <TR ALIGN="center" VALIGN="top">
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/GenericMailet.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ PREV CLASS
+ <A HREF="../../../org/apache/mailet/GenericMatcher.html" title="class in org.apache.mailet"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../index.html?org/apache/mailet/GenericMailet.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="GenericMailet.html" target="_top"><B>NO FRAMES</B></A>
+ <SCRIPT type="text/javascript">
+ <!--
+ if(window==top) {
+ document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
+ }
+ //-->
+</SCRIPT>
+<NOSCRIPT>
+ <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
+</NOSCRIPT>
+
+
+</FONT></TD>
+</TR>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+ SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<A NAME="skip-navbar_bottom"></A>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+
+<HR>
+Copyright © 2008 <a href="http://www.apache.org">The Apache Software Foundation</a>. All Rights Reserved.
+</BODY>
+</HTML>
Added: james/site/trunk/www/mailet/base/apidocs/org/apache/mailet/GenericMatcher.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/mailet/base/apidocs/org/apache/mailet/GenericMatcher.html?rev=690765&view=auto
==============================================================================
--- james/site/trunk/www/mailet/base/apidocs/org/apache/mailet/GenericMatcher.html (added)
+++ james/site/trunk/www/mailet/base/apidocs/org/apache/mailet/GenericMatcher.html Sun Aug 31 12:25:33 2008
@@ -0,0 +1,566 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!--NewPage-->
+<HTML>
+<HEAD>
+<!-- Generated by javadoc (build 1.5.0_16) on Sun Aug 31 19:51:38 BST 2008 -->
+<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<TITLE>
+GenericMatcher (Apache JAMES Basic Mailet Toolkit 1.0-SNAPSHOT API)
+</TITLE>
+
+<META NAME="keywords" CONTENT="org.apache.mailet.GenericMatcher class">
+
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
+
+<SCRIPT type="text/javascript">
+function windowTitle()
+{
+ parent.document.title="GenericMatcher (Apache JAMES Basic Mailet Toolkit 1.0-SNAPSHOT API)";
+}
+</SCRIPT>
+<NOSCRIPT>
+</NOSCRIPT>
+
+</HEAD>
+
+<BODY BGCOLOR="white" onload="windowTitle();">
+
+
+<!-- ========= START OF TOP NAVBAR ======= -->
+<A NAME="navbar_top"><!-- --></A>
+<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
+<TR>
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_top_firstrow"><!-- --></A>
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
+ <TR ALIGN="center" VALIGN="top">
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/GenericMatcher.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../org/apache/mailet/GenericMailet.html" title="class in org.apache.mailet"><B>PREV CLASS</B></A>
+ <A HREF="../../../org/apache/mailet/GenericRecipientMatcher.html" title="class in org.apache.mailet"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../index.html?org/apache/mailet/GenericMatcher.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="GenericMatcher.html" target="_top"><B>NO FRAMES</B></A>
+ <SCRIPT type="text/javascript">
+ <!--
+ if(window==top) {
+ document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
+ }
+ //-->
+</SCRIPT>
+<NOSCRIPT>
+ <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
+</NOSCRIPT>
+
+
+</FONT></TD>
+</TR>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+ SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<A NAME="skip-navbar_top"></A>
+<!-- ========= END OF TOP NAVBAR ========= -->
+
+<HR>
+<!-- ======== START OF CLASS DATA ======== -->
+<H2>
+<FONT SIZE="-1">
+org.apache.mailet</FONT>
+<BR>
+Class GenericMatcher</H2>
+<PRE>
+java.lang.Object
+ <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>org.apache.mailet.GenericMatcher</B>
+</PRE>
+<DL>
+<DT><B>All Implemented Interfaces:</B> <DD>org.apache.mailet.Matcher, org.apache.mailet.MatcherConfig</DD>
+</DL>
+<DL>
+<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../org/apache/mailet/GenericRecipientMatcher.html" title="class in org.apache.mailet">GenericRecipientMatcher</A></DD>
+</DL>
+<HR>
+<DL>
+<DT><PRE>public abstract class <B>GenericMatcher</B><DT>extends java.lang.Object<DT>implements org.apache.mailet.Matcher, org.apache.mailet.MatcherConfig</DL>
+</PRE>
+
+<P>
+<p>GenericMatcher implements the Matcher and MatcherConfig interfaces.</p>
+ <p>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>
+
+ <p>To write a generic matcher, you need only override the abstract match method.</p>
+<P>
+
+<P>
+<DL>
+<DT><B>Version:</B></DT>
+ <DD>1.0.0, 24/04/1999</DD>
+</DL>
+<HR>
+
+<P>
+
+<!-- ======== CONSTRUCTOR SUMMARY ======== -->
+
+<A NAME="constructor_summary"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
+<B>Constructor Summary</B></FONT></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE><B><A HREF="../../../org/apache/mailet/GenericMatcher.html#GenericMatcher()">GenericMatcher</A></B>()</CODE>
+
+<BR>
+ </TD>
+</TR>
+</TABLE>
+
+<!-- ========== METHOD SUMMARY =========== -->
+
+<A NAME="method_summary"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
+<B>Method Summary</B></FONT></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> 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" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.lang.String</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/mailet/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" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> org.apache.mailet.MailetContext</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" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> org.apache.mailet.MatcherConfig</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" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.lang.String</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/mailet/GenericMatcher.html#getMatcherInfo()">getMatcherInfo</A></B>()</CODE>
+
+<BR>
+ Returns information about the matcher, such as author, version, and
+ copyright.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> 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" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/mailet/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" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/mailet/GenericMatcher.html#init(org.apache.mailet.MatcherConfig)">init</A></B>(org.apache.mailet.MatcherConfig 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" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/mailet/GenericMatcher.html#log(java.lang.String)">log</A></B>(java.lang.String message)</CODE>
+
+<BR>
+ Writes the specified message to a matcher log file.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/mailet/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.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="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>(org.apache.mailet.Mail 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" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
+<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
+</TR>
+</TABLE>
+
+<P>
+
+<!-- ========= CONSTRUCTOR DETAIL ======== -->
+
+<A NAME="constructor_detail"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Constructor Detail</B></FONT></TH>
+</TR>
+</TABLE>
+
+<A NAME="GenericMatcher()"><!-- --></A><H3>
+GenericMatcher</H3>
+<PRE>
+public <B>GenericMatcher</B>()</PRE>
+<DL>
+</DL>
+
+<!-- ============ METHOD DETAIL ========== -->
+
+<A NAME="method_detail"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Method Detail</B></FONT></TH>
+</TR>
+</TABLE>
+
+<A NAME="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.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE>destroy</CODE> in interface <CODE>org.apache.mailet.Matcher</CODE></DL>
+</DD>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getCondition()"><!-- --></A><H3>
+getCondition</H3>
+<PRE>
+public java.lang.String <B>getCondition</B>()</PRE>
+<DL>
+<DD><p>Returns a String containing the value of the named initialization
+ parameter, or null if the parameter does not exist.</p>
+
+ <p>This method is supplied for convenience. It gets the value of the
+ named parameter from the matcher's MatcherConfig object.</p>
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE>getCondition</CODE> in interface <CODE>org.apache.mailet.MatcherConfig</CODE></DL>
+</DD>
+<DD><DL>
+
+<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 org.apache.mailet.MatcherConfig <B>getMatcherConfig</B>()</PRE>
+<DL>
+<DD>Returns this matcher's MatcherConfig object.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE>getMatcherConfig</CODE> in interface <CODE>org.apache.mailet.Matcher</CODE></DL>
+</DD>
+<DD><DL>
+
+<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 org.apache.mailet.MailetContext <B>getMailetContext</B>()</PRE>
+<DL>
+<DD>Returns a reference to the MailetContext in which this matcher is
+ running.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE>getMailetContext</CODE> in interface <CODE>org.apache.mailet.MatcherConfig</CODE></DL>
+</DD>
+<DD><DL>
+
+<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.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE>getMatcherInfo</CODE> in interface <CODE>org.apache.mailet.Matcher</CODE></DL>
+</DD>
+<DD><DL>
+
+<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.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE>getMatcherName</CODE> in interface <CODE>org.apache.mailet.MatcherConfig</CODE></DL>
+</DD>
+<DD><DL>
+
+<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>(org.apache.mailet.MatcherConfig newConfig)
+ throws javax.mail.MessagingException</PRE>
+<DL>
+<DD><p>Called by the matcher container to indicate to a matcher that the
+ matcher is being placed into service.</p>
+
+ <p>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).</p>
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE>init</CODE> in interface <CODE>org.apache.mailet.Matcher</CODE></DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>newConfig</CODE> - - the MatcherConfig object that contains
+ configutation information for this matcher
+<DT><B>Throws:</B>
+<DD><CODE>javax.mail.MessagingException</CODE> - 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 javax.mail.MessagingException</PRE>
+<DL>
+<DD><p>A convenience method which can be overridden so that there's no
+ need to call super.init(config).</p>
+
+ <p>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().</p>
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+
+<DT><B>Throws:</B>
+<DD><CODE>javax.mail.MessagingException</CODE> - 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.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>message</CODE> - - a String specifying the message to be written to the log file</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="log(java.lang.String, java.lang.Throwable)"><!-- --></A><H3>
+log</H3>
+<PRE>
+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.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<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>(org.apache.mailet.Mail mail)
+ throws javax.mail.MessagingException</PRE>
+<DL>
+<DD><p>Called by the matcher container to allow the matcher to process a
+ message.</p>
+
+ <p>This method is declared abstract so subclasses must override it.</p>
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE>match</CODE> in interface <CODE>org.apache.mailet.Matcher</CODE></DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>mail</CODE> - - the Mail object that contains the MimeMessage and
+ routing information
+<DT><B>Returns:</B><DD>java.util.Collection - the recipients that the mailet container should have the
+ mailet affect.
+<DT><B>Throws:</B>
+<DD><CODE>javax.mail.MessagingException</CODE> - - if an exception occurs that interferes with the mailet's normal operation
+ occurred</DL>
+</DD>
+</DL>
+<!-- ========= END OF CLASS DATA ========= -->
+<HR>
+
+
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<A NAME="navbar_bottom"><!-- --></A>
+<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
+<TR>
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_bottom_firstrow"><!-- --></A>
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
+ <TR ALIGN="center" VALIGN="top">
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/GenericMatcher.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../org/apache/mailet/GenericMailet.html" title="class in org.apache.mailet"><B>PREV CLASS</B></A>
+ <A HREF="../../../org/apache/mailet/GenericRecipientMatcher.html" title="class in org.apache.mailet"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../index.html?org/apache/mailet/GenericMatcher.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="GenericMatcher.html" target="_top"><B>NO FRAMES</B></A>
+ <SCRIPT type="text/javascript">
+ <!--
+ if(window==top) {
+ document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
+ }
+ //-->
+</SCRIPT>
+<NOSCRIPT>
+ <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
+</NOSCRIPT>
+
+
+</FONT></TD>
+</TR>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+ SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<A NAME="skip-navbar_bottom"></A>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+
+<HR>
+Copyright © 2008 <a href="http://www.apache.org">The Apache Software Foundation</a>. All Rights Reserved.
+</BODY>
+</HTML>
Added: james/site/trunk/www/mailet/base/apidocs/org/apache/mailet/GenericRecipientMatcher.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/mailet/base/apidocs/org/apache/mailet/GenericRecipientMatcher.html?rev=690765&view=auto
==============================================================================
--- james/site/trunk/www/mailet/base/apidocs/org/apache/mailet/GenericRecipientMatcher.html (added)
+++ james/site/trunk/www/mailet/base/apidocs/org/apache/mailet/GenericRecipientMatcher.html Sun Aug 31 12:25:33 2008
@@ -0,0 +1,314 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!--NewPage-->
+<HTML>
+<HEAD>
+<!-- Generated by javadoc (build 1.5.0_16) on Sun Aug 31 19:51:38 BST 2008 -->
+<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<TITLE>
+GenericRecipientMatcher (Apache JAMES Basic Mailet Toolkit 1.0-SNAPSHOT API)
+</TITLE>
+
+<META NAME="keywords" CONTENT="org.apache.mailet.GenericRecipientMatcher class">
+
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
+
+<SCRIPT type="text/javascript">
+function windowTitle()
+{
+ parent.document.title="GenericRecipientMatcher (Apache JAMES Basic Mailet Toolkit 1.0-SNAPSHOT API)";
+}
+</SCRIPT>
+<NOSCRIPT>
+</NOSCRIPT>
+
+</HEAD>
+
+<BODY BGCOLOR="white" onload="windowTitle();">
+
+
+<!-- ========= START OF TOP NAVBAR ======= -->
+<A NAME="navbar_top"><!-- --></A>
+<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
+<TR>
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_top_firstrow"><!-- --></A>
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
+ <TR ALIGN="center" VALIGN="top">
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/GenericRecipientMatcher.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../org/apache/mailet/GenericMatcher.html" title="class in org.apache.mailet"><B>PREV CLASS</B></A>
+ <A HREF="../../../org/apache/mailet/RFC2822Headers.html" title="class in org.apache.mailet"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../index.html?org/apache/mailet/GenericRecipientMatcher.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="GenericRecipientMatcher.html" target="_top"><B>NO FRAMES</B></A>
+ <SCRIPT type="text/javascript">
+ <!--
+ if(window==top) {
+ document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
+ }
+ //-->
+</SCRIPT>
+<NOSCRIPT>
+ <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
+</NOSCRIPT>
+
+
+</FONT></TD>
+</TR>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+ SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<A NAME="skip-navbar_top"></A>
+<!-- ========= END OF TOP NAVBAR ========= -->
+
+<HR>
+<!-- ======== START OF CLASS DATA ======== -->
+<H2>
+<FONT SIZE="-1">
+org.apache.mailet</FONT>
+<BR>
+Class GenericRecipientMatcher</H2>
+<PRE>
+java.lang.Object
+ <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../org/apache/mailet/GenericMatcher.html" title="class in org.apache.mailet">org.apache.mailet.GenericMatcher</A>
+ <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>org.apache.mailet.GenericRecipientMatcher</B>
+</PRE>
+<DL>
+<DT><B>All Implemented Interfaces:</B> <DD>org.apache.mailet.Matcher, org.apache.mailet.MatcherConfig</DD>
+</DL>
+<HR>
+<DL>
+<DT><PRE>public abstract class <B>GenericRecipientMatcher</B><DT>extends <A HREF="../../../org/apache/mailet/GenericMatcher.html" title="class in org.apache.mailet">GenericMatcher</A></DL>
+</PRE>
+
+<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>
+
+<P>
+<DL>
+<DT><B>Version:</B></DT>
+ <DD>1.0.0, 24/04/1999</DD>
+</DL>
+<HR>
+
+<P>
+
+<!-- ======== CONSTRUCTOR SUMMARY ======== -->
+
+<A NAME="constructor_summary"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
+<B>Constructor Summary</B></FONT></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE><B><A HREF="../../../org/apache/mailet/GenericRecipientMatcher.html#GenericRecipientMatcher()">GenericRecipientMatcher</A></B>()</CODE>
+
+<BR>
+ </TD>
+</TR>
+</TABLE>
+
+<!-- ========== METHOD SUMMARY =========== -->
+
+<A NAME="method_summary"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
+<B>Method Summary</B></FONT></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.util.Collection</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/mailet/GenericRecipientMatcher.html#match(org.apache.mailet.Mail)">match</A></B>(org.apache.mailet.Mail mail)</CODE>
+
+<BR>
+ Matches each recipient one by one through matchRecipient(MailAddress
+ recipient) method.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="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>(org.apache.mailet.MailAddress 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" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
+<TH ALIGN="left"><B>Methods inherited from class org.apache.mailet.<A HREF="../../../org/apache/mailet/GenericMatcher.html" title="class in org.apache.mailet">GenericMatcher</A></B></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="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" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
+<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
+</TR>
+</TABLE>
+
+<P>
+
+<!-- ========= CONSTRUCTOR DETAIL ======== -->
+
+<A NAME="constructor_detail"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Constructor Detail</B></FONT></TH>
+</TR>
+</TABLE>
+
+<A NAME="GenericRecipientMatcher()"><!-- --></A><H3>
+GenericRecipientMatcher</H3>
+<PRE>
+public <B>GenericRecipientMatcher</B>()</PRE>
+<DL>
+</DL>
+
+<!-- ============ METHOD DETAIL ========== -->
+
+<A NAME="method_detail"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Method Detail</B></FONT></TH>
+</TR>
+</TABLE>
+
+<A NAME="match(org.apache.mailet.Mail)"><!-- --></A><H3>
+match</H3>
+<PRE>
+public final java.util.Collection <B>match</B>(org.apache.mailet.Mail mail)
+ throws javax.mail.MessagingException</PRE>
+<DL>
+<DD>Matches each recipient one by one through matchRecipient(MailAddress
+ recipient) method. Handles splitting the recipients Collection
+ as appropriate.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE>match</CODE> in interface <CODE>org.apache.mailet.Matcher</CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../org/apache/mailet/GenericMatcher.html#match(org.apache.mailet.Mail)">match</A></CODE> in class <CODE><A HREF="../../../org/apache/mailet/GenericMatcher.html" title="class in org.apache.mailet">GenericMatcher</A></CODE></DL>
+</DD>
+<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>Throws:</B>
+<DD><CODE>javax.mail.MessagingException</CODE> - - if an exception occurs that interferes with the mailet's normal operation
+ occurred</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="matchRecipient(org.apache.mailet.MailAddress)"><!-- --></A><H3>
+matchRecipient</H3>
+<PRE>
+public abstract boolean <B>matchRecipient</B>(org.apache.mailet.MailAddress recipient)
+ throws javax.mail.MessagingException</PRE>
+<DL>
+<DD>Simple check to match exclusively on the email address (not
+ message information).
+<P>
+<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
+<DT><B>Throws:</B>
+<DD><CODE>javax.mail.MessagingException</CODE></DL>
+</DD>
+</DL>
+<!-- ========= END OF CLASS DATA ========= -->
+<HR>
+
+
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<A NAME="navbar_bottom"><!-- --></A>
+<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
+<TR>
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_bottom_firstrow"><!-- --></A>
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
+ <TR ALIGN="center" VALIGN="top">
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/GenericRecipientMatcher.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../org/apache/mailet/GenericMatcher.html" title="class in org.apache.mailet"><B>PREV CLASS</B></A>
+ <A HREF="../../../org/apache/mailet/RFC2822Headers.html" title="class in org.apache.mailet"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../index.html?org/apache/mailet/GenericRecipientMatcher.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="GenericRecipientMatcher.html" target="_top"><B>NO FRAMES</B></A>
+ <SCRIPT type="text/javascript">
+ <!--
+ if(window==top) {
+ document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
+ }
+ //-->
+</SCRIPT>
+<NOSCRIPT>
+ <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
+</NOSCRIPT>
+
+
+</FONT></TD>
+</TR>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+ SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<A NAME="skip-navbar_bottom"></A>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+
+<HR>
+Copyright © 2008 <a href="http://www.apache.org">The Apache Software Foundation</a>. All Rights Reserved.
+</BODY>
+</HTML>