You are viewing a plain text version of this content. The canonical link for it is here.
Posted to site-dev@james.apache.org by rd...@apache.org on 2008/08/23 15:40:31 UTC
svn commit: r688320 [4/47] - in /james/site/trunk/www/mailet/standard: ./
apidocs/ apidocs/org/ apidocs/org/apache/ apidocs/org/apache/james/
apidocs/org/apache/james/transport/
apidocs/org/apache/james/transport/mailets/ apidocs/org/apache/james/trans...
Added: james/site/trunk/www/mailet/standard/apidocs/org/apache/james/transport/mailets/ClamAVScan.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/mailet/standard/apidocs/org/apache/james/transport/mailets/ClamAVScan.html?rev=688320&view=auto
==============================================================================
--- james/site/trunk/www/mailet/standard/apidocs/org/apache/james/transport/mailets/ClamAVScan.html (added)
+++ james/site/trunk/www/mailet/standard/apidocs/org/apache/james/transport/mailets/ClamAVScan.html Sat Aug 23 06:40:23 2008
@@ -0,0 +1,1092 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!--NewPage-->
+<HTML>
+<HEAD>
+<!-- Generated by javadoc (build 1.5.0_16) on Sat Aug 23 14:34:52 BST 2008 -->
+<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<TITLE>
+ClamAVScan (Apache JAMES Standard Mailets 1.0-SNAPSHOT API)
+</TITLE>
+
+<META NAME="keywords" CONTENT="org.apache.james.transport.mailets.ClamAVScan class">
+
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
+
+<SCRIPT type="text/javascript">
+function windowTitle()
+{
+ parent.document.title="ClamAVScan (Apache JAMES Standard Mailets 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/ClamAVScan.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/james/transport/mailets/AddSubjectPrefix.html" title="class in org.apache.james.transport.mailets"><B>PREV CLASS</B></A>
+ <A HREF="../../../../../org/apache/james/transport/mailets/LogMessage.html" title="class in org.apache.james.transport.mailets"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../../../index.html?org/apache/james/transport/mailets/ClamAVScan.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="ClamAVScan.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.james.transport.mailets</FONT>
+<BR>
+Class ClamAVScan</H2>
+<PRE>
+java.lang.Object
+ <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by ">GenericMailet
+ <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.james.transport.mailets.ClamAVScan</B>
+</PRE>
+<HR>
+<DL>
+<DT><PRE>public class <B>ClamAVScan</B><DT>extends GenericMailet</DL>
+</PRE>
+
+<P>
+<P>Does an antivirus scan check using a ClamAV daemon (CLAMD)</P>
+
+ <P> Interacts directly with the daemon using the "stream" method,
+ which should have the lowest possible overhead.</P>
+ <P>The CLAMD daemon will typically reside on <I>localhost</I>, but could reside on a
+ different host.
+ It may also consist on a set of multiple daemons, each residing on a different
+ server and on different IP number.
+ In such case a DNS host name with multiple IP addresses (round-robin load sharing)
+ is supported by the mailet (but on the same port number).</P>
+
+ <P>Handles the following init parameters:</P>
+ <UL>
+ <LI><CODE><debug></CODE>.</LI>
+ <LI><CODE><host></CODE>: the host name of the server where CLAMD runs. It can either be
+ a machine name, such as
+ "<code>java.sun.com</code>", or a textual representation of its
+ IP address. If a literal IP address is supplied, only the
+ validity of the address format is checked.
+ If the machine name resolves to multiple IP addresses, <I>round-robin load sharing</I> will
+ be used.
+ The default is <CODE>localhost</CODE>.</LI>
+ <LI><CODE><port></CODE>: the port on which CLAMD listens. The default is <I>3310</I>.</LI>
+ <LI><CODE><maxPings></CODE>: the maximum number of connection retries during startup.
+ If the value is <I>0</I> no startup test will be done.
+ The default is <I>6</I>.</LI>
+ <LI><CODE><pingIntervalMilli></CODE>: the interval (in milliseconds)
+ between each connection retry during startup.
+ The default is <I>30000</I> (30 seconds).</LI>
+ <LI><CODE><streamBufferSize></CODE>: the BufferedOutputStream buffer size to use
+ writing to the <I>stream connection</I>. The default is <I>8192</I>.</LI>
+ </UL>
+
+ <P>The actions performed are as follows:</P>
+ <UL>
+ <LI>During initialization:</LI>
+ <OL>
+ <LI>Gets all <CODE>config.xml</CODE> parameters, handling the defaults;</LI>
+ <LI>resolves the <CODE><host></CODE> parameter, creating the round-robin IP list;</LI>
+ <LI>connects to CLAMD at the first IP in the round-robin list, on
+ the specified <CODE><port></CODE>;</LI>
+ <LI>if unsuccessful, retries every <CODE><pingIntervalMilli></CODE> milliseconds up to
+ <CODE><maxPings></CODE> times;</LI>
+ <LI>sends a <CODE>PING</CODE> request;</LI>
+ <LI>waits for a <CODE>PONG</CODE> answer;</LI>
+ <LI>repeats steps 3-6 for every other IP resolved.
+ </OL>
+ <LI>For every mail</LI>
+ <OL>
+ <LI>connects to CLAMD at the "next" IP in the round-robin list, on
+ the specified <CODE><port></CODE>, and increments the "next" index;
+ if the connection request is not accepted tries with the next one
+ in the list unless all of them have failed;</LI>
+ <LI>sends a "<CODE>STREAM</CODE>" request;</LI>
+ <LI>parses the "<CODE>PORT <I>streamPort</I></CODE>" answer obtaining the port number;</LI>
+ <LI>makes a second connection (the <I>stream connection</I>) to CLAMD at the same host (or IP)
+ on the <I>streamPort</I> just obtained;</LI>
+ <LI>sends the mime message to CLAMD (using <CODE>MimeMessage.writeTo(java.io.OutputStream)</CODE>)
+ through the <I>stream connection</I>;</LI>
+ <LI>closes the <I>stream connection</I>;</LI>
+ <LI>gets the "<CODE>OK</CODE>" or "<CODE>... FOUND</CODE>" answer from the main connection;</LI>
+ <LI>closes the main connection;</LI>
+ <LI>sets the "<CODE>org.apache.james.infected</CODE>" <I>mail attribute</I> to either
+ "<CODE>true</CODE>" or "<CODE>false</CODE>";</LI>
+ <LI>adds the "<CODE>X-MessageIsInfected</CODE>" <I>header</I> to either
+ "<CODE>true</CODE>" or "<CODE>false</CODE>";</LI>
+ </OL>
+ </UL>
+
+ <P>Some notes regarding <a href="http://www.clamav.net/">clamav.conf</a>:</p>
+ <UL>
+ <LI><CODE>LocalSocket</CODE> must be commented out</LI>
+ <LI><CODE>TCPSocket</CODE> must be set to a port# (typically 3310)</LI>
+ <LI><CODE>StreamMaxLength</CODE> must be >= the James config.xml parameter
+ <<CODE>maxmessagesize</CODE>> in SMTP <<CODE>handler</CODE>></LI>
+ <LI><CODE>MaxThreads</CODE> should? be >= the James config.xml parameter
+ <<CODE>threads</CODE>> in <<CODE>spoolmanager</CODE>></LI>
+ <LI><CODE>ScanMail</CODE> must be uncommented</LI>
+ </UL>
+
+ <P>Here follows an example of config.xml definitions deploying CLAMD on localhost,
+ and handling the infected messages:</P>
+ <PRE><CODE>
+
+ ...
+
+ <!-- Do an antivirus scan -->
+ <mailet match="All" class="ClamAVScan" onMailetException="ignore"/>
+
+ <!-- If infected go to virus processor -->
+ <mailet match="HasMailAttributeWithValue=org.apache.james.infected, true" class="ToProcessor">
+ <processor> virus </processor>
+ </mailet>
+
+ <!-- Check attachment extensions for possible viruses -->
+ <mailet match="AttachmentFileNameIs=-d -z *.exe *.com *.bat *.cmd *.pif *.scr *.vbs *.avi *.mp3 *.mpeg *.shs" class="ToProcessor">
+ <processor> bad-extensions </processor>
+ </mailet>
+
+ ...
+
+ <!-- Messages containing viruses -->
+ <processor name="virus">
+
+ <!-- To avoid a loop while bouncing -->
+ <mailet match="All" class="SetMailAttribute">
+ <org.apache.james.infected>true, bouncing</org.apache.james.infected>
+ </mailet>
+
+ <mailet match="SMTPAuthSuccessful" class="Bounce">
+ <sender>bounce-admin@xxx.com</sender>
+ <inline>heads</inline>
+ <attachment>none</attachment>
+ <notice> Warning: We were unable to deliver the message below because it was found infected by virus(es). </notice>
+ </mailet>
+
+ <!--
+ <mailet match="All" class="ToRepository">
+ <repositoryPath>file://var/mail/infected/</repositoryPath>
+ </mailet>
+ -->
+
+ <mailet match="All" class="Null" />
+ </processor>
+ </CODE></PRE>
+<P>
+
+<P>
+<DL>
+<DT><B>Since:</B></DT>
+ <DD>2.2.1</DD>
+<DT><B>Version:</B></DT>
+ <DD>2.2.1</DD>
+<DT><B>See Also:</B><DD><a href="http://www.clamav.net/">ClamAV Home Page</a>,
+<a href="http://www.sosdg.org/clamav-win32/">ClamAV For Windows</a></DL>
+<HR>
+
+<P>
+
+<!-- ======== CONSTRUCTOR SUMMARY ======== -->
+
+<A NAME="constructor_summary"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
+<B>Constructor Summary</B></FONT></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE><B><A HREF="../../../../../org/apache/james/transport/mailets/ClamAVScan.html#ClamAVScan()">ClamAVScan</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.net.InetAddress[]</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../org/apache/james/transport/mailets/ClamAVScan.html#getAddresses()">getAddresses</A></B>()</CODE>
+
+<BR>
+ Getter for property addresses.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>protected java.net.InetAddress</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../org/apache/james/transport/mailets/ClamAVScan.html#getAddresses(int)">getAddresses</A></B>(int index)</CODE>
+
+<BR>
+ Indexed getter for property addresses.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> int</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../org/apache/james/transport/mailets/ClamAVScan.html#getAddressesCount()">getAddressesCount</A></B>()</CODE>
+
+<BR>
+ Getter for property addressesCount.</TD>
+</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/james/transport/mailets/ClamAVScan.html#getAllowedInitParameters()">getAllowedInitParameters</A></B>()</CODE>
+
+<BR>
+ Gets the expected init parameters.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>protected java.net.Socket</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../org/apache/james/transport/mailets/ClamAVScan.html#getClamdSocket()">getClamdSocket</A></B>()</CODE>
+
+<BR>
+ Gets a Socket connected to CLAMD.</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/james/transport/mailets/ClamAVScan.html#getHost()">getHost</A></B>()</CODE>
+
+<BR>
+ Getter for property host.</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/james/transport/mailets/ClamAVScan.html#getMailetInfo()">getMailetInfo</A></B>()</CODE>
+
+<BR>
+ Return a string describing this mailet.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> int</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../org/apache/james/transport/mailets/ClamAVScan.html#getMaxPings()">getMaxPings</A></B>()</CODE>
+
+<BR>
+ Getter for property maxPings.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>protected java.net.InetAddress</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../org/apache/james/transport/mailets/ClamAVScan.html#getNextAddress()">getNextAddress</A></B>()</CODE>
+
+<BR>
+ Getter for property nextAddress.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> int</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../org/apache/james/transport/mailets/ClamAVScan.html#getPingIntervalMilli()">getPingIntervalMilli</A></B>()</CODE>
+
+<BR>
+ Getter for property pingIntervalMilli.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> int</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../org/apache/james/transport/mailets/ClamAVScan.html#getPort()">getPort</A></B>()</CODE>
+
+<BR>
+ Getter for property port.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> int</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../org/apache/james/transport/mailets/ClamAVScan.html#getStreamBufferSize()">getStreamBufferSize</A></B>()</CODE>
+
+<BR>
+ Getter for property streamBufferSize.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>protected int</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../org/apache/james/transport/mailets/ClamAVScan.html#getStreamPortFromAnswer(java.lang.String)">getStreamPortFromAnswer</A></B>(java.lang.String answer)</CODE>
+
+<BR>
+ Parses the answer from a STREAM request and gets the port number.</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/james/transport/mailets/ClamAVScan.html#init()">init</A></B>()</CODE>
+
+<BR>
+ Mailet initialization routine.</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/james/transport/mailets/ClamAVScan.html#initDebug()">initDebug</A></B>()</CODE>
+
+<BR>
+ Initializer for property debug.</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/james/transport/mailets/ClamAVScan.html#initHost()">initHost</A></B>()</CODE>
+
+<BR>
+ Initializer for property host.</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/james/transport/mailets/ClamAVScan.html#initMaxPings()">initMaxPings</A></B>()</CODE>
+
+<BR>
+ Initializer for property maxPings.</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/james/transport/mailets/ClamAVScan.html#initPingIntervalMilli()">initPingIntervalMilli</A></B>()</CODE>
+
+<BR>
+ Initializer for property pingIntervalMilli.</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/james/transport/mailets/ClamAVScan.html#initPort()">initPort</A></B>()</CODE>
+
+<BR>
+ Initializer for property port.</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/james/transport/mailets/ClamAVScan.html#initStreamBufferSize()">initStreamBufferSize</A></B>()</CODE>
+
+<BR>
+ Initializer for property streamBufferSize.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> boolean</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../org/apache/james/transport/mailets/ClamAVScan.html#isDebug()">isDebug</A></B>()</CODE>
+
+<BR>
+ Getter for property debug.</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/james/transport/mailets/ClamAVScan.html#ping()">ping</A></B>()</CODE>
+
+<BR>
+ Tries to "ping" all the CLAMD daemons to
+ check if they are up and accepting requests.</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/james/transport/mailets/ClamAVScan.html#ping(java.net.InetAddress)">ping</A></B>(java.net.InetAddress address)</CODE>
+
+<BR>
+ Tries (and retries as specified up to 'getMaxPings()') to "ping" the specified CLAMD daemon to
+ check if it is up and accepting requests.</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/james/transport/mailets/ClamAVScan.html#saveChanges(javax.mail.internet.MimeMessage)">saveChanges</A></B>(javax.mail.internet.MimeMessage message)</CODE>
+
+<BR>
+ Saves changes resetting the original message id.</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/james/transport/mailets/ClamAVScan.html#service(org.apache.mailet.Mail)">service</A></B>(org.apache.mailet.Mail mail)</CODE>
+
+<BR>
+ Scans the mail.</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/james/transport/mailets/ClamAVScan.html#setAddresses(java.net.InetAddress[])">setAddresses</A></B>(java.net.InetAddress[] addresses)</CODE>
+
+<BR>
+ Setter for property addresses.</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/james/transport/mailets/ClamAVScan.html#setDebug(boolean)">setDebug</A></B>(boolean debug)</CODE>
+
+<BR>
+ Setter for property debug.</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/james/transport/mailets/ClamAVScan.html#setHost(java.lang.String)">setHost</A></B>(java.lang.String host)</CODE>
+
+<BR>
+ Setter for property host.</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/james/transport/mailets/ClamAVScan.html#setMaxPings(int)">setMaxPings</A></B>(int maxPings)</CODE>
+
+<BR>
+ Setter for property maxPings.</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/james/transport/mailets/ClamAVScan.html#setPingIntervalMilli(int)">setPingIntervalMilli</A></B>(int pingIntervalMilli)</CODE>
+
+<BR>
+ Setter for property pingIntervalMilli.</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/james/transport/mailets/ClamAVScan.html#setPort(int)">setPort</A></B>(int port)</CODE>
+
+<BR>
+ Setter for property port.</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/james/transport/mailets/ClamAVScan.html#setStreamBufferSize(int)">setStreamBufferSize</A></B>(int streamBufferSize)</CODE>
+
+<BR>
+ Setter for property streamBufferSize.</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="ClamAVScan()"><!-- --></A><H3>
+ClamAVScan</H3>
+<PRE>
+public <B>ClamAVScan</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="getMailetInfo()"><!-- --></A><H3>
+getMailetInfo</H3>
+<PRE>
+public java.lang.String <B>getMailetInfo</B>()</PRE>
+<DL>
+<DD>Return a string describing this mailet.
+<P>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>a string describing this mailet</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getAllowedInitParameters()"><!-- --></A><H3>
+getAllowedInitParameters</H3>
+<PRE>
+protected java.lang.String[] <B>getAllowedInitParameters</B>()</PRE>
+<DL>
+<DD>Gets the expected init parameters.
+<P>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="initDebug()"><!-- --></A><H3>
+initDebug</H3>
+<PRE>
+protected void <B>initDebug</B>()</PRE>
+<DL>
+<DD>Initializer for property debug.
+<P>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="isDebug()"><!-- --></A><H3>
+isDebug</H3>
+<PRE>
+public boolean <B>isDebug</B>()</PRE>
+<DL>
+<DD>Getter for property debug.
+<P>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>Value of property debug.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="setDebug(boolean)"><!-- --></A><H3>
+setDebug</H3>
+<PRE>
+public void <B>setDebug</B>(boolean debug)</PRE>
+<DL>
+<DD>Setter for property debug.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>debug</CODE> - New value of property debug.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="initHost()"><!-- --></A><H3>
+initHost</H3>
+<PRE>
+protected void <B>initHost</B>()
+ throws java.net.UnknownHostException</PRE>
+<DL>
+<DD>Initializer for property host.
+<P>
+<DD><DL>
+
+<DT><B>Throws:</B>
+<DD><CODE>java.net.UnknownHostException</CODE> - if unable to resolve the host name, or if invalid</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getHost()"><!-- --></A><H3>
+getHost</H3>
+<PRE>
+public java.lang.String <B>getHost</B>()</PRE>
+<DL>
+<DD>Getter for property host.
+<P>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>Value of property host.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="setHost(java.lang.String)"><!-- --></A><H3>
+setHost</H3>
+<PRE>
+public void <B>setHost</B>(java.lang.String host)
+ throws java.net.UnknownHostException</PRE>
+<DL>
+<DD>Setter for property host.
+ Resolves also the host name into the corresponding IP addresses, issues
+ a <A HREF="../../../../../org/apache/james/transport/mailets/ClamAVScan.html#setAddresses(java.net.InetAddress[])"><CODE>setAddresses(java.net.InetAddress[])</CODE></A> and resets the <CODE>nextAddressIndex</CODE>
+ variable to <I>0</I> for dealing with <I>round-robin</I>.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>host</CODE> - New value of property host.
+<DT><B>Throws:</B>
+<DD><CODE>java.net.UnknownHostException</CODE> - if unable to resolve the host name, or if invalid</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="initPort()"><!-- --></A><H3>
+initPort</H3>
+<PRE>
+protected void <B>initPort</B>()</PRE>
+<DL>
+<DD>Initializer for property port.
+<P>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getPort()"><!-- --></A><H3>
+getPort</H3>
+<PRE>
+public int <B>getPort</B>()</PRE>
+<DL>
+<DD>Getter for property port.
+<P>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>Value of property port.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="setPort(int)"><!-- --></A><H3>
+setPort</H3>
+<PRE>
+public void <B>setPort</B>(int port)</PRE>
+<DL>
+<DD>Setter for property port.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>port</CODE> - New value of property port.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="initMaxPings()"><!-- --></A><H3>
+initMaxPings</H3>
+<PRE>
+protected void <B>initMaxPings</B>()</PRE>
+<DL>
+<DD>Initializer for property maxPings.
+<P>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getMaxPings()"><!-- --></A><H3>
+getMaxPings</H3>
+<PRE>
+public int <B>getMaxPings</B>()</PRE>
+<DL>
+<DD>Getter for property maxPings.
+<P>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>Value of property maxPings.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="setMaxPings(int)"><!-- --></A><H3>
+setMaxPings</H3>
+<PRE>
+public void <B>setMaxPings</B>(int maxPings)</PRE>
+<DL>
+<DD>Setter for property maxPings.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>maxPings</CODE> - New value of property maxPings.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="initPingIntervalMilli()"><!-- --></A><H3>
+initPingIntervalMilli</H3>
+<PRE>
+protected void <B>initPingIntervalMilli</B>()</PRE>
+<DL>
+<DD>Initializer for property pingIntervalMilli.
+<P>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getPingIntervalMilli()"><!-- --></A><H3>
+getPingIntervalMilli</H3>
+<PRE>
+public int <B>getPingIntervalMilli</B>()</PRE>
+<DL>
+<DD>Getter for property pingIntervalMilli.
+<P>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>Value of property pingIntervalMilli.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="setPingIntervalMilli(int)"><!-- --></A><H3>
+setPingIntervalMilli</H3>
+<PRE>
+public void <B>setPingIntervalMilli</B>(int pingIntervalMilli)</PRE>
+<DL>
+<DD>Setter for property pingIntervalMilli.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>pingIntervalMilli</CODE> - New value of property pingIntervalMilli.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="initStreamBufferSize()"><!-- --></A><H3>
+initStreamBufferSize</H3>
+<PRE>
+protected void <B>initStreamBufferSize</B>()</PRE>
+<DL>
+<DD>Initializer for property streamBufferSize.
+<P>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getStreamBufferSize()"><!-- --></A><H3>
+getStreamBufferSize</H3>
+<PRE>
+public int <B>getStreamBufferSize</B>()</PRE>
+<DL>
+<DD>Getter for property streamBufferSize.
+<P>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>Value of property streamBufferSize.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="setStreamBufferSize(int)"><!-- --></A><H3>
+setStreamBufferSize</H3>
+<PRE>
+public void <B>setStreamBufferSize</B>(int streamBufferSize)</PRE>
+<DL>
+<DD>Setter for property streamBufferSize.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>streamBufferSize</CODE> - New value of property streamBufferSize.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getAddresses(int)"><!-- --></A><H3>
+getAddresses</H3>
+<PRE>
+protected java.net.InetAddress <B>getAddresses</B>(int index)</PRE>
+<DL>
+<DD>Indexed getter for property addresses.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>index</CODE> - Index of the property.
+<DT><B>Returns:</B><DD>Value of the property at <CODE>index</CODE>.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getAddresses()"><!-- --></A><H3>
+getAddresses</H3>
+<PRE>
+protected java.net.InetAddress[] <B>getAddresses</B>()</PRE>
+<DL>
+<DD>Getter for property addresses.
+<P>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>Value of property addresses.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="setAddresses(java.net.InetAddress[])"><!-- --></A><H3>
+setAddresses</H3>
+<PRE>
+protected void <B>setAddresses</B>(java.net.InetAddress[] addresses)</PRE>
+<DL>
+<DD>Setter for property addresses.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>addresses</CODE> - New value of property addresses.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getNextAddress()"><!-- --></A><H3>
+getNextAddress</H3>
+<PRE>
+protected java.net.InetAddress <B>getNextAddress</B>()</PRE>
+<DL>
+<DD>Getter for property nextAddress.
+
+ Gets the address of the next CLAMD server to connect to in this round, using round-robin.
+ Increments the nextAddressIndex for the next round.
+<P>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>Value of property address.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getAddressesCount()"><!-- --></A><H3>
+getAddressesCount</H3>
+<PRE>
+public int <B>getAddressesCount</B>()</PRE>
+<DL>
+<DD>Getter for property addressesCount.
+<P>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>Value of property addressesCount.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getClamdSocket()"><!-- --></A><H3>
+getClamdSocket</H3>
+<PRE>
+protected java.net.Socket <B>getClamdSocket</B>()
+ throws javax.mail.MessagingException</PRE>
+<DL>
+<DD>Gets a Socket connected to CLAMD.
+
+ Will loop though the round-robin address list until the first one accepts
+ the connection.
+<P>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>a socket connected to CLAMD
+<DT><B>Throws:</B>
+<DD><CODE>javax.mail.MessagingException</CODE> - if no CLAMD in the round-robin address list has accepted the connection</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="init()"><!-- --></A><H3>
+init</H3>
+<PRE>
+public void <B>init</B>()
+ throws javax.mail.MessagingException</PRE>
+<DL>
+<DD>Mailet initialization routine.
+<P>
+<DD><DL>
+
+<DT><B>Throws:</B>
+<DD><CODE>javax.mail.MessagingException</CODE></DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="service(org.apache.mailet.Mail)"><!-- --></A><H3>
+service</H3>
+<PRE>
+public void <B>service</B>(org.apache.mailet.Mail mail)
+ throws javax.mail.MessagingException</PRE>
+<DL>
+<DD>Scans the mail.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>mail</CODE> - the mail to scan
+<DT><B>Throws:</B>
+<DD><CODE>javax.mail.MessagingException</CODE> - if a problem arises</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="ping()"><!-- --></A><H3>
+ping</H3>
+<PRE>
+protected void <B>ping</B>()
+ throws java.lang.Exception</PRE>
+<DL>
+<DD>Tries to "ping" all the CLAMD daemons to
+ check if they are up and accepting requests.
+<P>
+<DD><DL>
+
+<DT><B>Throws:</B>
+<DD><CODE>java.lang.Exception</CODE></DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="ping(java.net.InetAddress)"><!-- --></A><H3>
+ping</H3>
+<PRE>
+protected void <B>ping</B>(java.net.InetAddress address)
+ throws java.lang.Exception</PRE>
+<DL>
+<DD>Tries (and retries as specified up to 'getMaxPings()') to "ping" the specified CLAMD daemon to
+ check if it is up and accepting requests.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>address</CODE> - the address to "ping"
+<DT><B>Throws:</B>
+<DD><CODE>java.lang.Exception</CODE></DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getStreamPortFromAnswer(java.lang.String)"><!-- --></A><H3>
+getStreamPortFromAnswer</H3>
+<PRE>
+protected final int <B>getStreamPortFromAnswer</B>(java.lang.String answer)
+ throws java.net.ConnectException</PRE>
+<DL>
+<DD>Parses the answer from a STREAM request and gets the port number.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>answer</CODE> - the answer from CLAMD containing the port number
+<DT><B>Returns:</B><DD>the port number for streaming out the data to scan
+<DT><B>Throws:</B>
+<DD><CODE>java.net.ConnectException</CODE></DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="saveChanges(javax.mail.internet.MimeMessage)"><!-- --></A><H3>
+saveChanges</H3>
+<PRE>
+protected final void <B>saveChanges</B>(javax.mail.internet.MimeMessage message)
+ throws javax.mail.MessagingException</PRE>
+<DL>
+<DD>Saves changes resetting the original message id.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>message</CODE> - the message to save
+<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/ClamAVScan.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/james/transport/mailets/AddSubjectPrefix.html" title="class in org.apache.james.transport.mailets"><B>PREV CLASS</B></A>
+ <A HREF="../../../../../org/apache/james/transport/mailets/LogMessage.html" title="class in org.apache.james.transport.mailets"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../../../index.html?org/apache/james/transport/mailets/ClamAVScan.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="ClamAVScan.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/standard/apidocs/org/apache/james/transport/mailets/LogMessage.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/mailet/standard/apidocs/org/apache/james/transport/mailets/LogMessage.html?rev=688320&view=auto
==============================================================================
--- james/site/trunk/www/mailet/standard/apidocs/org/apache/james/transport/mailets/LogMessage.html (added)
+++ james/site/trunk/www/mailet/standard/apidocs/org/apache/james/transport/mailets/LogMessage.html Sat Aug 23 06:40:23 2008
@@ -0,0 +1,306 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!--NewPage-->
+<HTML>
+<HEAD>
+<!-- Generated by javadoc (build 1.5.0_16) on Sat Aug 23 14:34:52 BST 2008 -->
+<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<TITLE>
+LogMessage (Apache JAMES Standard Mailets 1.0-SNAPSHOT API)
+</TITLE>
+
+<META NAME="keywords" CONTENT="org.apache.james.transport.mailets.LogMessage class">
+
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
+
+<SCRIPT type="text/javascript">
+function windowTitle()
+{
+ parent.document.title="LogMessage (Apache JAMES Standard Mailets 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/LogMessage.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/james/transport/mailets/ClamAVScan.html" title="class in org.apache.james.transport.mailets"><B>PREV CLASS</B></A>
+ <A HREF="../../../../../org/apache/james/transport/mailets/MailAttributesToMimeHeaders.html" title="class in org.apache.james.transport.mailets"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../../../index.html?org/apache/james/transport/mailets/LogMessage.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="LogMessage.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.james.transport.mailets</FONT>
+<BR>
+Class LogMessage</H2>
+<PRE>
+java.lang.Object
+ <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by ">GenericMailet
+ <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.james.transport.mailets.LogMessage</B>
+</PRE>
+<HR>
+<DL>
+<DT><PRE>public class <B>LogMessage</B><DT>extends GenericMailet</DL>
+</PRE>
+
+<P>
+Logs Message Headers and/or Body.
+ If the "passThrough" in confs is true the mail will be left untouched in
+ the pipe. If false will be destroyed. Default is true.
+<P>
+
+<P>
+<DL>
+<DT><B>Version:</B></DT>
+ <DD>This is $Revision: 1.8.4.2 $</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/james/transport/mailets/LogMessage.html#LogMessage()">LogMessage</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.lang.String</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../org/apache/james/transport/mailets/LogMessage.html#getMailetInfo()">getMailetInfo</A></B>()</CODE>
+
+<BR>
+ Return a string describing this mailet.</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/james/transport/mailets/LogMessage.html#init()">init</A></B>()</CODE>
+
+<BR>
+ Initialize the mailet, loading configuration information.</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/james/transport/mailets/LogMessage.html#service(org.apache.mailet.Mail)">service</A></B>(org.apache.mailet.Mail mail)</CODE>
+
+<BR>
+ Log a particular 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="LogMessage()"><!-- --></A><H3>
+LogMessage</H3>
+<PRE>
+public <B>LogMessage</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="init()"><!-- --></A><H3>
+init</H3>
+<PRE>
+public void <B>init</B>()</PRE>
+<DL>
+<DD>Initialize the mailet, loading configuration information.
+<P>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="service(org.apache.mailet.Mail)"><!-- --></A><H3>
+service</H3>
+<PRE>
+public void <B>service</B>(org.apache.mailet.Mail mail)</PRE>
+<DL>
+<DD>Log a particular message
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>genericmail</CODE> - the mail to process</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getMailetInfo()"><!-- --></A><H3>
+getMailetInfo</H3>
+<PRE>
+public java.lang.String <B>getMailetInfo</B>()</PRE>
+<DL>
+<DD>Return a string describing this mailet.
+<P>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>a string describing this mailet</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/LogMessage.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/james/transport/mailets/ClamAVScan.html" title="class in org.apache.james.transport.mailets"><B>PREV CLASS</B></A>
+ <A HREF="../../../../../org/apache/james/transport/mailets/MailAttributesToMimeHeaders.html" title="class in org.apache.james.transport.mailets"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../../../index.html?org/apache/james/transport/mailets/LogMessage.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="LogMessage.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/standard/apidocs/org/apache/james/transport/mailets/MailAttributesToMimeHeaders.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/mailet/standard/apidocs/org/apache/james/transport/mailets/MailAttributesToMimeHeaders.html?rev=688320&view=auto
==============================================================================
--- james/site/trunk/www/mailet/standard/apidocs/org/apache/james/transport/mailets/MailAttributesToMimeHeaders.html (added)
+++ james/site/trunk/www/mailet/standard/apidocs/org/apache/james/transport/mailets/MailAttributesToMimeHeaders.html Sat Aug 23 06:40:23 2008
@@ -0,0 +1,285 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!--NewPage-->
+<HTML>
+<HEAD>
+<!-- Generated by javadoc (build 1.5.0_16) on Sat Aug 23 14:34:52 BST 2008 -->
+<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<TITLE>
+MailAttributesToMimeHeaders (Apache JAMES Standard Mailets 1.0-SNAPSHOT API)
+</TITLE>
+
+<META NAME="keywords" CONTENT="org.apache.james.transport.mailets.MailAttributesToMimeHeaders class">
+
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
+
+<SCRIPT type="text/javascript">
+function windowTitle()
+{
+ parent.document.title="MailAttributesToMimeHeaders (Apache JAMES Standard Mailets 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/MailAttributesToMimeHeaders.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/james/transport/mailets/LogMessage.html" title="class in org.apache.james.transport.mailets"><B>PREV CLASS</B></A>
+ <A HREF="../../../../../org/apache/james/transport/mailets/Null.html" title="class in org.apache.james.transport.mailets"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../../../index.html?org/apache/james/transport/mailets/MailAttributesToMimeHeaders.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="MailAttributesToMimeHeaders.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.james.transport.mailets</FONT>
+<BR>
+Class MailAttributesToMimeHeaders</H2>
+<PRE>
+java.lang.Object
+ <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by ">GenericMailet
+ <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.james.transport.mailets.MailAttributesToMimeHeaders</B>
+</PRE>
+<HR>
+<DL>
+<DT><PRE>public class <B>MailAttributesToMimeHeaders</B><DT>extends GenericMailet</DL>
+</PRE>
+
+<P>
+Convert attributes to headers
+
+ Sample configuration:
+
+ <mailet match="All" class="MailAttributesToMimeHeaders">
+ <simplemapping>org.apache.james.attribute1;
+ headerName1</simplemapping>
+ <simplemapping>org.apache.james.attribute2;
+ headerName2</simplemapping> </mailet>
+<P>
+
+<P>
+<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/james/transport/mailets/MailAttributesToMimeHeaders.html#MailAttributesToMimeHeaders()">MailAttributesToMimeHeaders</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/james/transport/mailets/MailAttributesToMimeHeaders.html#init()">init</A></B>()</CODE>
+
+<BR>
+ </TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../org/apache/james/transport/mailets/MailAttributesToMimeHeaders.html#service(org.apache.mailet.Mail)">service</A></B>(org.apache.mailet.Mail mail)</CODE>
+
+<BR>
+ </TD>
+</TR>
+</TABLE>
+ <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
+<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE>clone, 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="MailAttributesToMimeHeaders()"><!-- --></A><H3>
+MailAttributesToMimeHeaders</H3>
+<PRE>
+public <B>MailAttributesToMimeHeaders</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="init()"><!-- --></A><H3>
+init</H3>
+<PRE>
+public void <B>init</B>()
+ throws javax.mail.MessagingException</PRE>
+<DL>
+<DD><DL>
+
+<DT><B>Throws:</B>
+<DD><CODE>javax.mail.MessagingException</CODE><DT><B>See Also:</B><DD><CODE>org.apache.mailet.GenericMailet#init()</CODE></DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="service(org.apache.mailet.Mail)"><!-- --></A><H3>
+service</H3>
+<PRE>
+public void <B>service</B>(org.apache.mailet.Mail mail)</PRE>
+<DL>
+<DD><DL>
+<DT><B>See Also:</B><DD><CODE>org.apache.mailet.GenericMailet#service(Mail)</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/MailAttributesToMimeHeaders.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/james/transport/mailets/LogMessage.html" title="class in org.apache.james.transport.mailets"><B>PREV CLASS</B></A>
+ <A HREF="../../../../../org/apache/james/transport/mailets/Null.html" title="class in org.apache.james.transport.mailets"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../../../index.html?org/apache/james/transport/mailets/MailAttributesToMimeHeaders.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="MailAttributesToMimeHeaders.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/standard/apidocs/org/apache/james/transport/mailets/Null.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/mailet/standard/apidocs/org/apache/james/transport/mailets/Null.html?rev=688320&view=auto
==============================================================================
--- james/site/trunk/www/mailet/standard/apidocs/org/apache/james/transport/mailets/Null.html (added)
+++ james/site/trunk/www/mailet/standard/apidocs/org/apache/james/transport/mailets/Null.html Sat Aug 23 06:40:23 2008
@@ -0,0 +1,281 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!--NewPage-->
+<HTML>
+<HEAD>
+<!-- Generated by javadoc (build 1.5.0_16) on Sat Aug 23 14:34:52 BST 2008 -->
+<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<TITLE>
+Null (Apache JAMES Standard Mailets 1.0-SNAPSHOT API)
+</TITLE>
+
+<META NAME="keywords" CONTENT="org.apache.james.transport.mailets.Null class">
+
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
+
+<SCRIPT type="text/javascript">
+function windowTitle()
+{
+ parent.document.title="Null (Apache JAMES Standard Mailets 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/Null.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/james/transport/mailets/MailAttributesToMimeHeaders.html" title="class in org.apache.james.transport.mailets"><B>PREV CLASS</B></A>
+ <A HREF="../../../../../org/apache/james/transport/mailets/OnlyText.html" title="class in org.apache.james.transport.mailets"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../../../index.html?org/apache/james/transport/mailets/Null.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="Null.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.james.transport.mailets</FONT>
+<BR>
+Class Null</H2>
+<PRE>
+java.lang.Object
+ <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by ">GenericMailet
+ <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.james.transport.mailets.Null</B>
+</PRE>
+<HR>
+<DL>
+<DT><PRE>public class <B>Null</B><DT>extends GenericMailet</DL>
+</PRE>
+
+<P>
+Simplest Mailet which destroys any incoming messages.
+<P>
+
+<P>
+<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/james/transport/mailets/Null.html#Null()">Null</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.lang.String</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../org/apache/james/transport/mailets/Null.html#getMailetInfo()">getMailetInfo</A></B>()</CODE>
+
+<BR>
+ Return a string describing this mailet.</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/james/transport/mailets/Null.html#service(org.apache.mailet.Mail)">service</A></B>(org.apache.mailet.Mail mail)</CODE>
+
+<BR>
+ Set this mail to GHOST state, indicating that no further processing
+ should take place.</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="Null()"><!-- --></A><H3>
+Null</H3>
+<PRE>
+public <B>Null</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="service(org.apache.mailet.Mail)"><!-- --></A><H3>
+service</H3>
+<PRE>
+public void <B>service</B>(org.apache.mailet.Mail mail)</PRE>
+<DL>
+<DD>Set this mail to GHOST state, indicating that no further processing
+ should take place.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>mail</CODE> - the mail to process</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getMailetInfo()"><!-- --></A><H3>
+getMailetInfo</H3>
+<PRE>
+public java.lang.String <B>getMailetInfo</B>()</PRE>
+<DL>
+<DD>Return a string describing this mailet.
+<P>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>a string describing this mailet</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/Null.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/james/transport/mailets/MailAttributesToMimeHeaders.html" title="class in org.apache.james.transport.mailets"><B>PREV CLASS</B></A>
+ <A HREF="../../../../../org/apache/james/transport/mailets/OnlyText.html" title="class in org.apache.james.transport.mailets"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../../../index.html?org/apache/james/transport/mailets/Null.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="Null.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>