Author: norman
Date: Mon Aug 21 04:27:39 2006
New Revision: 433228
URL: http://svn.apache.org/viewvc?rev=433228&view=rev
Log:
Complete Mailet and Matcher overview. See JAMES-327
Added:
james/site/trunk/www/server/provided_mailets_2_3.html
james/site/trunk/www/server/provided_matchers_2_3.html
Added: james/site/trunk/www/server/provided_mailets_2_3.html
URL:
http://svn.apache.org/viewvc/james/site/trunk/www/server/provided_mailets_2_3.html?rev=433228&view=auto
==============================================================================
--- james/site/trunk/www/server/provided_mailets_2_3.html (added)
+++ james/site/trunk/www/server/provided_mailets_2_3.html Mon Aug 21 04:27:39
2006
@@ -0,0 +1,832 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";>
+
+
+
+
+
+
+
+
+
+
+<html>
+ <head>
+ <title>James Server -
+ James 2.3 - Provided Mailets</title>
+ <style type="text/css" media="all">
+ @import url("./css/maven-base.css");
+ @import url("./css/maven-theme.css");
+ @import url("./css/site.css");
+ </style>
+ <link rel="stylesheet" href="./css/print.css" type="text/css"
media="print" />
+ <meta http-equiv="Content-Type" content="text/html;
charset=ISO-8859-1" />
+ </head>
+ <body class="composite">
+ <div id="banner">
+ <a href="http://james.apache.org/index.html"; id="bannerLeft">
+
+ <img
src="images/james-server-logo.gif" alt="" />
+
+ </a>
+ <a href="http://www.apache.org/index.html";
id="bannerRight">
+
+ <img
src="images/asf-logo-reduced.gif" alt="" />
+
+ </a>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="breadcrumbs">
+
+
+
+
+
+
+
+ <div class="xleft">
+ Last Published: 08/21/2006
+ </div>
+ <div class="xright"> <a
href="http://james.apache.org/index.html";>JAMES Project</a>
+ |
+ <a href="">Server</a>
+ |
+ <a href="http://james.apache.org/jspf/index.html";>jSPF</a>
+ |
+ <a href="http://james.apache.org/mime4j/index.html";>Mime4J</a>
+ |
+ <a href="http://james.apache.org/jsieve/index.html";>JSieve</a>
+ |
+ <a href="http://james.apache.org/postage/index.html";>Postage</a>
+
+
+
+
+
+
+
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="leftColumn">
+ <div id="navcolumn">
+
+
+
+
+
+
+
+ <h5>James</h5>
+ <ul>
+
+ <li class="none">
+ <a href="index.html">Overview</a>
+ </li>
+
+ <li class="none">
+ <a href="FAQ.html">James FAQ</a>
+ </li>
+
+ <li class="none">
+ <a href="mail.html">Mailing Lists</a>
+ </li>
+
+ <li class="none">
+ <a href="http://wiki.apache.org/james";>Wiki</a>
+ </li>
+ </ul>
+ <h5>Documentation</h5>
+ <ul>
+
+ <li class="none">
+ <a href="documentation_2_1.html">James</a>
+ </li>
+
+ <li class="none">
+ <a href="design_objectives.html">Design</a>
+ </li>
+
+ <li class="none">
+ <a href="document_archive.html">Document Archive</a>
+ </li>
+ </ul>
+ <h5>Documentation 2.3</h5>
+ <ul>
+
+ <li class="none">
+ <a href="documentation_2_3.html">James</a>
+ </li>
+
+ <li class="none">
+ <a href="design_objectives_2_3.html">Design</a>
+ </li>
+
+ <li class="none">
+ <a href="apidocs/index.html">James Javadocs</a>
+ </li>
+
+ <li class="none">
+ <a href="rfclist.html">Useful RFCs</a>
+ </li>
+ </ul>
+ <h5>Project</h5>
+ <ul>
+
+ <li class="none">
+ <a href="http://issues.apache.org/jira/browse/JAMES";>Bug
Database</a>
+ </li>
+
+ <li class="none">
+ <a href="http://svn.apache.org/viewvc/james/server/";>Source
Code</a>
+ </li>
+
+ <li class="none">
+ <a href="changelog.html">Changelog</a>
+ </li>
+
+ <li class="none">
+ <a href="todo.html">TODO</a>
+ </li>
+ </ul>
+ <h5>Project Documentation</h5>
+ <ul>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="collapsed">
+ <a href="project-info.html">Project Information</a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+ <li class="collapsed">
+ <a href="project-reports.html">Project Reports</a>
+ </li>
+ </ul>
+ <a href="http://maven.apache.org/";
title="Built by Maven" id="poweredBy">
+ <img alt="Built by Maven"
src="./images/logos/maven-feather.png"></img>
+ </a>
+
+
+
+
+
+
+
+ </div>
+ </div>
+ <div id="bodyColumn">
+ <div id="contentBox">
+
+
+
+
+
+
+<a name="Mailets"></a><div class="section"><h2>Mailets</h2>
+
+<p>James provides a number of implemented Mailets for use by James
administrators in their
+configurations. These are primarily mailets that members of the James
developer or user
+communities have found useful in their own configurations. A description of
how to configure
+Mailets and use them in the James SpoolManager can be found <a
href="spoolmanager_configuration_2_3.html">here</a>.</p>
+
+<a name="AddFooter"></a><div class="section"><h3>AddFooter</h3>
+<p>Description: This mailet adds a text footer to the message.</p>
+
+<p>Parameters:
+<ul>
+<li><strong>text</strong> (required) - the text that will be added as a footer
to the message.</li>
+</ul>
+
+</div>
+
+<a name="AddHabeasWarrantMark"></a><div
class="section"><h3>AddHabeasWarrantMark</h3>
+<p>Description: This mailet adds a Habeas warrant mark (see <a
href="http://habeas.com";>http://habeas.com</a> for details) to the message.</p>
+
+<p>Parameters: None.</p>
+</div>
+
+<a name="AddHeader"></a><div class="section"><h3>AddHeader</h3>
+<p>Description: This mailet is <strong>deprecated</strong> .Please use
SetMimeHeader .</p>
+</div>
+
+<a name="AvalonListserv"></a><div class="section"><h3>AvalonListserv</h3>
+<p>Provides basic list server functionality. Implements basic filters for
emails sent to the list,
+including restriction of senders to members, diallowing attachments in list
messages, and subject line
+processing</p>
+
+<p>Parameters:
+<ul>
+<li><strong>repositoryName</strong> (required) - the name of the user
repository that contains the users
+for this list.</li>
+<li><strong>membersonly</strong> (optional) - whether only members of the list
can send messages to this
+list. Defaults to false.</li>
+<li><strong>attachmentsallowed</strong> (optional) - whether attachments are
allowed in messages sent to this
+list. Defaults to true.</li>
+<li><strong>replytolist</strong> (optional) - whether the reply-to address for
all messages sent to this
+list is set to the list address. Defaults to true.</li>
+<li><strong>subjectprefix</strong> (optional) - a String value. If set, this
value is prepended to the subject
+line of all messages sent to the list.</li>
+<li><strong>autobracket</strong> (optional) - a boolean value. If a
subjectprefix is set, this value determines
+whether the prefix is bracketed before being prepended to the subject line.
Defaults to true.</li>
+</ul>
+
+</div>
+
+<a name="AvalonListservManager"></a><div
class="section"><h3>AvalonListservManager</h3>
+Processes list management commands of the form
<list-name>-on@<host> and
+<list-name>-off@<host> where <list-name> and lt;host> are
arbitrary. Note
+that this should be used in tandem with a CommandForListserv matcher to ensure
that only commands
+intended for a specific list are processed.
+
+Parameters:
+<ul>
+<li><strong>repositoryName</strong> (required) - the name of the user
repository that contains the users
+for this list.</li>
+</ul>
+
+</div>
+
+<a name="BayesianAnalysis"></a><div class="section"><h3>BayesianAnalysis</h3>
+Description: Spam detection mailet using bayesian analysis techniques.
+
+Parameters:
+<ul>
+<li><strong>repositoryPath</strong> (required) - The repositoryPath which is
used.</li>
+<li><strong>headerName</strong> - The HeaderName which get adds to holds the
Probalitity. Default is <i>X-MessageIsSpamProbability</i>.</li>
+<li><strong>ignoreLocalSender</strong> - Set to true if you want to ignore
messages from local senders. By local sender we mean a return-path
+with a local server part (server listed in <servernames> in config.xml).
Default is <i>false</i>.</li>
+<li><strong>maxSize</strong> - Set this to the maximum message size (in bytes)
after analysis will be skipped. Default is <i>100000</i>.</li>
+</ul>
+
+</div>
+
+<a name="BayesianAnalysisFeeder"></a><div
class="section"><h3>BayesianAnalysisFeeder</h3>
+Description: Feeds ham OR spam messages to train the BayesianAnalysis mailet.
+
+Parameters:
+<ul>
+<li><strong>repositoryPath</strong> (required) - The repositoryPath which is
used.</li>
+<li><strong>feedType</strong> (required) - The type of the message which is
used to feed the mailet. Allowed values are <i>spam</i> and <i>ham</i>.</li>
+<li><strong>maxSize</strong> - Set this to the maximum message size (in bytes)
after analysis will be skipped. Default is <i>100000</i>.</li>
+</ul>
+
+</div>
+
+<a name="Bounce"></a><div class="section"><h3>Bounce</h3>
+Description: Generates a response to the reverse-path address.
+
+Parameters:
+<ul>
+<li><strong>sender</strong> - The senderAddress which will be used for sending
the bounce. Possible values: <i>address</i>, <i>postmaster</i> , <i>sender</i>,
+<i>unaltered</i>. Default <i>postmaster</i>.</li>
+<li><strong>attachError</strong> - Attach error. Default is false.</li>
+<li><strong>message</strong> - Set the message which get included in the
bounce.</li>
+<li><strong>prefix</strong> - Optional subject prefix prepended to the
original message.</li>
+<li><strong>inline</strong> - Specify which mailpart will be included in the
email body. Possible values: <i>unaltered</i>, <i>heads</i>, <i>body</i> ,
<i>all</i>,
+"none". Default "none".</li>
+<li><strong>attachment</strong> - Specify which mailpart will be attached to
the email. Possible values: <i>none</i>, <i>heads</i>, <i>body</i>, <i>all</i>,
+<i>message</i>. Default <i>message</i>.</li>
+<li><strong>passThrough</strong> - If set to false the email will not
processed after the bounce. Possible values: <i>true</i>, <i>false</i>.
+Default <i>true</i>.</li>
+<li><strong>fakeDomainCheck</strong> - If set to false true will check if the
sender domain is valid. Possible values: <i>true</i>, <i>false</i>.
+Default <i>true</i>.</li>
+<li><strong>debug</strong> - If set true you can enable debugging. Possible
values: <i>true</i>, <i>false</i>.
+Default <i>false</i>.</li>
+</ul>
+
+</div>
+
+<a name="ClamAVScan"></a><div class="section"><h3>ClamAVScan</h3>
+Description: Does an antivirus scan check using a ClamAV daemon (CLAMD).
+
+Parameters:
+<ul>
+<li><strong>host</strong> - The host name of the server where CLAMD runs. The
default is <i>localhost</i></li>
+<li><strong>port</strong> - The port on which CLAMD listens. The default is
<i>3310</i>.</li>
+<li><strong>maxPings</strong> - The maximum number of connection retries
during startup. If the value is <i>0</i> no startup
+test will be done.</li>
+<li><strong>pingIntervalMillis</strong> (required) - The interval (in
milliseconds) between each connection retry during startup.
+The default is <i>30000</i> (30 seconds)</li>
+<li><strong>streamBufferSize</strong> - the BufferedOutputStream buffer size
to use writing to the <I>stream connection</I>. The
+default is <i>8192</i>.</li>
+<li><strong>debug</strong> - If set true you can enable debugging. Possible
values: <i>true</i>, <i>false</i>.
+Default <i>false</i>.</li>
+</ul>
+
+</div>
+
+<a name="CommandListservFooter"></a><div
class="section"><h3>CommandListservFooter</h3>
+Description: CommandListservFooter is based on the AddFooter mailet. It is
used by the CommandListservProcessor to inject a footer into mailing list.
+
+Parameters: None.
+</div>
+
+<a name="CommandListservManager"></a><div
class="section"><h3>CommandListservManager</h3>
+ Description: CommandListservManager is the default implementation of
ICommandListservManager.
+It loads all the configured IListServCommands and delegates to them at runtime.
+<br></br>
+It isn't responsible for procesing messages sent to the main mailing list, but
is responsible for
+individual commands sent by users, such as: info, subscribe, etc...
+<br></br>
+Requests sent to the CommandListservManager take the form of:
+<pre>
+<listName>-<commandName>@domain
+</pre>
+
+If the command isn't recognized an error will be sent.
+<br></br>
+<br></br>
+The configuration for this mailet sould be in the 'root' processor block.
+
+Parameters:
+<ul>
+<li><strong>listName</strong> - The listname </li>
+<li><strong>displayName</strong> - The full listname</li>
+<li><strong>listOwner</strong> - An emailaddress which will be used as
owneraddress.</li>
+<li><strong>repositoryName</strong> - the repository name </li>
+<li><strong>listDomain</strong> - The domain</li>
+</ul>
+
+<br></br>
+ Example configuration:
+<div class="source"><pre>
+<mailet match="[EMAIL PROTECTED]"
class="CommandListservManager">
+ <listName>announce</listName>
+ <displayName>Announce mailing list</displayName>
+ <listOwner>[EMAIL PROTECTED]</listOwner>
+ <repositoryName>list-announce</repositoryName>
+ <listDomain>localhost</listDomain>
+
+ <commandpackages>
+
<commandpackage>org.apache.james.transport.mailets.listservcommands</commandpackage>
+ </commandpackages>
+
+ <commands>
+ <command name="subscribe" class="Subscribe"/>
+ <command name="subscribe-confirm"
class="SubscribeConfirm"/>
+ <command name="unsubscribe"
class="UnSubscribe"/>
+ <command name="unsubscribe-confirm"
class="UnSubscribeConfirm"/>
+ <command name="error" class="ErrorCommand"/>
+ <command name="owner" class="Owner"/>
+ <command name="info" class="Info"/>
+ </commands>
+ </mailet>
+</pre></div>
+
+</div>
+
+
+<a name="DSNBounce"></a><div class="section"><h3>DSNBounce</h3>
+Description: Generates a Delivery Status Notification (DSN). Note that this is
different than a mail-client's
+reply, which would use the Reply-To or From header.Bounced messages are
attached in their entirety (headers and
+content) and the resulting MIME part type is "message/rfc822".
+The reverse-path and the Return-Path header of the response is set to
<i>null</i> (<i><></i>),
+meaning that no reply should be sent.
+A sender of the notification message can optionally be specified.
+If one is not specified, the postmaster's address will be used.
+
+Parameters:
+<ul>
+<li><strong>sender</strong> - An address, postmaster,sender or unaltered.
Default is <i>postmaster</i></li>
+<li><strong>prefix</strong> - Optional subject prefix prepended to the
original message.</li>
+<li><strong>attachment</strong> - Values are message, heads or none. Default
is <i>message</i>.
+test will be done.</li>
+<li><strong>messageString</strong> - the message sent in the bounce, the first
occurrence of the pattern [machine] is replaced with the name of the executing
machine, default=Hi. This is the James mail server at [machine] .... </li>
+<li><strong>passThrough</strong> (optional) - a boolean value (true/false)
indicating whether
+processing should continue on the message is on. If false, the original
message is GHOSTed. Defaults to false.</li>
+<li><strong>debug</strong> - If set true you can enable debugging. Possible
values: <i>true</i>, <i>false</i>.
+Default <i>false</i>.</li>
+</ul>
+
+</div>
+
+<a name="Forward"></a><div class="section"><h3>Forward</h3>
+Description: This mailet forwards the message to a set of recipients.
+
+Parameters:
+<ul>
+<li><strong>forwardto</strong> (required) - a comma delimited list of email
addresses.</li>
+</ul>
+
+</div>
+
+<a name="FromRepository"></a><div class="section"><h3>FromRepository</h3>
+Description: This mailet ee-spools mail found in the specified Repository.
+
+Parameters:
+<ul>
+<li><strong>repositoryPath</strong> (required) - The repositoryPath which is
used.</li>
+<li><strong>processor</strong> (required) - The target processor to move the
mails to.</li>
+<li><strong>delete</strong> - If set to true the mails get deleted after
re-spooling. Default is <i>false</i>.</li>
+</ul>
+
+</div>
+
+<a name="ICommandListservManager"></a><div
class="section"><h3>ICommandListservManager</h3>
+Description: ICommandListservManager is the interface that describes the
functionality of any command based list serv managers.
+
+Parameters: None.
+</div>
+
+<a name="JDBCAlias"></a><div class="section"><h3>JDBCAlias</h3>
+Description: This mailet does alias translation for email addresses stored in
a database table.
+
+Parameters:
+<ul>
+<li><strong>mappings</strong> (required) - a URL of the form
db://<data-source>/<table>, where
+<table> is the table in the database containing the alias info and
<data-source> is the name
+of the data-source in config.xml that is to be used.</li>
+<li><strong>source_column</strong> (required) - the column containing the
aliases.</li>
+<li><strong>target_column</strong> (required) - the column containing the
alias targets.</li>
+</ul>
+
+</div>
+
+<a name="JDBCVirtualUserTable"></a><div
class="section"><h3>JDBCVirtualUserTable</h3>
+Description: This mailet does complex alias translation for email addresses
stored in a database table.
+
+Parameters:
+<ul>
+<li><strong>table</strong> (required) - the URL describing the database table.
This URL has the form
+db://<data-source>/<table> where <data-source> and
<table> are the names of
+the data-source as defined in config.xml and the table in the database.</li>
+<li><strong>sqlquery</strong> (optional) - the text of the SQL query used by
the mailet to do user
+lookup. The default is "select VirtualUserTable.target_address from
VirtualUserTable, VirtualUserTable as VUTDomains where (VirtualUserTable.user
like ? or VirtualUserTable.user like '\\%') and (VirtualUserTable.domain like ?
or (VirtualUserTable.domain like '\\%' and VUTDomains.domain like ?)) order by
concat(VirtualUserTable.user,'@',VirtualUserTable.domain) desc limit
1"</li>
+</ul>
+
+</div>
+
+<a name="LocalDelivery"></a><div class="section"><h3>LocalDelivery</h3>
+Description: This mailet delivers messages to local mailboxes.
+
+Parameters: None.
+</div>
+
+<a name="LogMessage"></a><div class="section"><h3>LogMessage</h3>
+Description: Logs Message Headers and/or Body.
+
+Parameters:
+<ul>
+<li><strong>passThrough</strong> (optional) - If the "passThrough"
in confs is true the mail will be left untouched in
+the pipe. If false will be destroyed. Default is true.</li>
+<li><strong>headers</strong> (optional) - If set to true the headers get
logged. Default is true"</li>
+<li><strong>body</strong> (optional) - If set to true the body get logged.
Default is true.</li>
+<li><strong>bodyMax</strong> (optional) - The max length wich should be
logged. Default is log all.</li>
+<li><strong>comment</strong> (optional) - The comment which should be logged
Default is none.</li>
+</ul>
+
+</div>
+
+<a name="NotifyPostmaster"></a><div class="section"><h3>NotifyPostmaster</h3>
+Description: This mailet forwards the message as an attachment to the James
postmaster.
+
+Parameters:
+<ul>
+<li><strong>sendingAddress</strong> (optional) - the address from which the
forwarded email will be
+sent. Defaults to the postmaster address.</li>
+<li><strong>notice</strong> (optional) - the text message that will accompany
the forwarded message. Defaults
+to "We were unable to deliver the attached message because of an error in
the mail server."</li>
+<li><strong>attachStackTrace</strong> (optional) - whether an error stack
trace is attached to the forwarded message.</li>
+</ul>
+
+</div>
+
+<a name="NotifySender"></a><div class="section"><h3>NotifySender</h3>
+Description: This mailet forwards the message as an attachment to the original
sender.
+
+Parameters:
+<ul>
+<li><strong>sendingAddress</strong> (optional) - the address from which the
forwarded email will be
+sent. Defaults to the postmaster address.</li>
+<li><strong>notice</strong> (optional) - the text message that will accompany
the forwarded message. Defaults
+to "We were unable to deliver the attached message because of an error in
the mail server."</li>
+<li><strong>attachStackTrace</strong> (optional) - whether an error stack
trace is attached to the forwarded message.</li>
+</ul>
+
+</div>
+
+<a name="Null"></a><div class="section"><h3>Null</h3>
+Description: This mailet ends processing for this mail.
+
+Parameters: None.
+</div>
+
+<a name="PostmasterAlias"></a><div class="section"><h3>PostmasterAlias</h3>
+Description: Intercepts all mails addressed to postmaster@<domain> where
<domain> is one
+of the domains managed by this James server and substitutes the configured
James postmaster address for
+the original recipient address. This mailet is inserted automatically by
James at the head of the root
+processor.
+
+Parameters: None.
+</div>
+
+<a name="Redirect"></a><div class="section"><h3>Redirect</h3>
+Description: A mailet providing powerful, configurable redirection
services.<br></br>
+ This mailet can produce listserver, forward and notify behaviour, with
the
+ original message intact, attached, appended or left out
altogether.<br></br>
+ This built in functionality is controlled by the configuration as
described
+ <a
href="javadocs/org/apache/james/transport/mailets/Redirect.html">here</a>.
+It is also intended to be easily subclassed to make providing bespoke
redirection
+ mailets simple. <br></br>
+ By extending it and overriding one or more of its methods new behaviour can
+ be quickly created without the author having to address any other issue
than
+ the relevant one. For more information see the javadocs
+ <a
href="apidocs/org/apache/james/transport/mailets/Redirect.html">here</a>.
+
+Parameters: <a
href="apidocs/org/apache/james/transport/mailets/Redirect.html">See
javadocs.</a>
+</div>
+
+<a name="RemoteDelivery"></a><div class="section"><h3>RemoteDelivery</h3>
+Manages delivery of messages to recipients on remote SMTP hosts.
+
+Parameters:
+<ul>
+<li><strong>outgoing</strong> (required) - The URL for the repository that
will hold messages being processed
+by the RemoteDelivery Mailet.</li>
+<li><strong>delayTime</strong> (optional) - a non-negative Long value that is
the time in
+milliseconds between redelivery attempts for a particular mail. Defaults to
six hours.</li>
+<li><strong>maxRetries</strong> (optional) - a non-negative Integer value that
is number of times
+the Mailet will attempt to deliver a particular mail. Defaults to five.</li>
+<li><strong>timeout</strong> (optional) - The SMTP connection timeout for SMTP
connections generated
+by this Mailet. Defaults to 60 seconds.</li>
+<li><strong>deliveryThreads</strong> (optional) - The number of threads this
Mailet will use to generate
+SMTP connections.</li>
+<li><strong>gateway</strong> (optional) - The host name of the SMTP server
+to be used as a gateway for this server. If this value is set, then all
+messages will be delivered to the gateway server, regardless of recipient
+address. To specify more than one gateway server, add multiple gateway tags,
+each containing one value. If more than one server is specified, they will be
+tried in order until one is successful. In addition the port may be specified
+for each gateway in the format <host>:<port>. If this
+value is unset, delivery will occur to SMTP servers resolved by MX lookup.</li>
+<li><strong>gatewayPort</strong> (optional) - The default port number of the
+SMTP server to be used as a gateway for this server. This value will be
+employed when a gateway is set <em>and</em> the gateway value does not specify
+a port as described above.</li>
+<li><strong>bind</strong> (optional) - If present, this value is a string
+describing the local IP address to which the mailet should be bound while
+delivering emails. If the tag is absent then the service will bind to the
+default local address of the machine. This tag is useful for multihomed
machines.<br></br>
+Note: Currently you must use the same IP address for all of those
RemoteDelivery
+instances where you explicitly supply a bind address.</li>
+<li><strong>debug</strong> (optional) - a boolean value (true/false)
indicating whether debugging is
+on. Defaults to false.</li>
+</ul>
+
+</div>
+
+<a name="RemoveAllMailAttributes"></a><div
class="section"><h3>RemoveAllMailAttributes</h3>
+Description: Removes all attributes on the Mail instance.
+
+Parameters: None.
+</div>
+
+<a name="RemoveMailAttributes"></a><div
class="section"><h3>RemoveMailAttributes</h3>
+Description: Remove attributes on the Mail instance.
+
+Parameters:
+<ul>
+<li><strong>name</strong> (required) - The name of the attribute to
remove.</li>
+</ul>
+
+</div>
+
+<a name="Resend"></a><div class="section"><h3>Resend</h3>
+Description:A mailet providing configurable redirection services. For more
information see
+the javadocs <a
href="apidocs/org/apache/james/transport/mailets/Resend.html">here</a>.
+
+Parameters: <a
href="apidocs/org/apache/james/transport/mailets/Resend.html">See javadocs.</a>
+</div>
+
+<a name="ServerTime"></a><div class="section"><h3>ServerTime</h3>
+Description: This mailet sends a message to the sender of the original mail
message with a server timestamp.
+
+Parameters: None.
+</div>
+
+<a name="SetMailAttributes"></a><div class="section"><h3>SetMailAttributes</h3>
+Description: Set attributes on the Mail instance.
+
+Parameters:
+<ul>
+<li><strong>name</strong> (required) - The name of the attribute to set.</li>
+</ul>
+
+</div>
+
+<a name="SetMimeHeader"></a><div class="section"><h3>SetMimeHeader</h3>
+Description: Set an MimeHeader on a MimeMessage.
+
+Parameters:
+<ul>
+<li><strong>name</strong> (required) - the name of the header to be added to
the message.</li>
+<li><strong>value</strong> (required) - the text that will be added as a
header to the message.</li>
+</ul>
+
+</div>
+
+<a name="SMIMECheckSignature"></a><div
class="section"><h3>SMIMECheckSignature</h3>
+Description: Verifies the s/mime signature of a message. The s/mime signing
ensure that
+the private key owner is the real sender of the message. To be checked by
+this mailet the s/mime signature must contain the actual signature, the
+signer's certificate and optionally a set of certificate that can be used to
+create a chain of trust that starts from the signer's certificate and leads
+to a known trusted certificate.
+
+
+This check is composed by two steps: firstly it's ensured that the signature
+is valid, then it's checked if a chain of trust starting from the signer
+certificate and that leads to a trusted certificate can be created. The first
+check verifies that the the message has not been modified after the signature
+was put and that the signer's certificate was valid at the time of the
+signing. The latter should ensure that the signer is who he declare to be.
+
+
+Parameters: <a
href="apidocs/org/apache/james/transport/mailets/smime/SMIMECheckSignature">See
javadocs.</a>
+</div>
+
+<a name="SMIMEDecrypt"></a><div class="section"><h3>SMIMEDecrypt</h3>
+Description: This mailet decrypts a s/mime encrypted message. It takes as
input an
+encrypted message and it tries to dechiper it using the key specified in its
+configuration. If the decryption is successful the mail will be changed and
+it will contain the decrypted message. The mail attribute
+<code>org.apache.james.SMIMEDecrypt</code> will contain the public
+certificate of the key used in the process.
+
+Parameters: <a
href="apidocs/org/apache/james/transport/mailets/smime/SMIMEDecrypt.html">See
javadocs.</a>
+</div>
+
+<a name="SMIMESign"></a><div class="section"><h3>SMIMESign</h3>
+Description: Puts a <i>server-side</i> SMIME signature on a message.
+It is a concrete subclass of SMIMEAbstractSign, with very few modifications to
it.
+A text file with an explanation text is attached to the original message,
+and the resulting message with all its attachments is signed.
+The resulting appearence of the message is almost unchanged: only an extra
attachment
+and the signature are added.
+
+Parameters: <a
href="apidocs/org/apache/james/transport/mailets/smime/SMIMESign.html">See
javadocs.</a>
+</div>
+
+<a name="ToProcessor"></a><div class="section"><h3>ToProcessor</h3>
+Description: Redirects processing of the mail message to the specified
processor.
+
+Parameters:
+<ul>
+<li><strong>processor</strong> (required) - the name of the processor to which
the message
+is to be redirected.</li>
+<li><strong>noticeText</strong> (optional) - a String value that, if present,
+is set as the error message of the redirected message. If this value is not
+present, no error message is set.</li>
+</ul>
+
+</div>
+
+<a name="ToMultiRepository"></a><div class="section"><h3>ToMultiRepository</h3>
+Description: Receives a Mail from JamesSpoolManager and takes care of delivery
of the
+message to local inboxes or a specific repository.
+
+Differently from LocalDelivery this does not lookup the UserRepository This
+simply store the message in a repository named like the local part of the
+recipient address.
+
+If no repository is specified then this fallback to MailServer.getUserInbox.
+Otherwise you can add your own configuration for the repository.
+Parameters:
+<ul>
+<li><strong>repositoryUrl</strong> (required) - the URL of the repository to
which the message
+is to be added.</li>
+<li><strong>addDeliveryHeader</strong> (optional) - a String value which can
be used specify a header which will add to the message.
+Default is to not add a header.</li>
+</ul>
+
+</div>
+
+<a name="ToRepository"></a><div class="section"><h3>ToRepository</h3>
+Places a copy of the message in the specified repository.
+
+Parameters:
+<ul>
+<li><strong>repositoryPath</strong> (required) - the URL of the repository to
which the message
+is to be added.</li>
+<li><strong>passThrough</strong> (optional) - a boolean value (true/false)
indicating whether
+processing should continue on the message is on. If false, the original
message is GHOSTed. Defaults to false.</li>
+</ul>
+
+</div>
+
+<a name="UseHeaderRecipients"></a><div
class="section"><h3>UseHeaderRecipients</h3>
+Description: Ignores the recipients associated with the Mail interface.
Instead, it regenerates the
+mail recipients from the MimeMessage headers (To, Cc, Bcc) and inserts a new
message at the queue root
+these new recipients. The original message is GHOSTed.
+
+Parameters:
+<ul>
+<li><strong>debug</strong> (optional) - a boolean value (true/false)
indicating whether debugging is
+on. Defaults to false.</li>
+</ul>
+
+</div>
+
+<a name="UsersRepositoryAliasingForwarding"></a><div
class="section"><h3>UsersRepositoryAliasingForwarding</h3>
+Receives a Mail from JamesSpoolManager and takes care of delivery of the
+message to local inboxes.
+
+Parameters:
+<ul>
+<li><strong>enableAliases</strong> (optional) - Specify wether the user
aliases should
+be looked up or not. Default is false.</li>
+<li><strong>enableForwarding</strong> (optional) -Enable the forwarding.
Default to
+false.</li>
+<li><strong>usersRepository</strong> (optional) - Specific users repository
+name. Default to empty. If empty does lookup the default userRepository.
+</li>
+</ul>
+
+</div>
+
+<a name="WhiteListManager"></a><div class="section"><h3>WhiteListManager</h3>
+Manages for each local user a "white list" of remote addresses whose
messages
+should never be blocked as spam.
+The normal behaviour is to check, for a local sender, if a remote recipient
+is already in the list: if not, it will be automatically inserted.
+This is under the interpretation that if a local sender <i>X</i> sends a
message to a
+remote recipient <i>Y</i>, then later on if a message is sent by <i>Y</i> to
<i>X</i> it should be
+considered always valid and never blocked; hence <i>Y</i> should be in the
white list
+of <i>X</i>.
+Another mode of operations is when a local sender sends a message to
<i>whitelistManagerAddress</i>
+with one of three specific values in the subject, to
+(i) send back a message displaying a list of the addresses in his own list;
+(ii) insert some new addresses in his own list;
+(iii) remove some addresses from his own list.
+In all this cases the message will be ghosted and the postmaster will reply
+to the sender.
+ The sender name is always converted to its primary name (handling aliases).
+
+Parameters:
+<ul>
+<li><strong>repositoryPath</strong> - The repository path.</li>
+<li><strong>automaticInsert</strong> (optional) - If true automatically
inserts the local sender to remote
+recipients entries in the whitelist. Default is false.</li>
+<li><strong>whitelistManagerAddress</strong> (optional) - Set this to an
email address of the "whitelist manager" to send
+commands to (default is null).</li>
+<li><strong>displayFlag</strong> (optional) - Set this to a unique text that
you can use (by sending a
+message to the "whitelist manager" above) to tell the mailet to send
back the contents of the white list. Default is null.</li>
+<li><strong>insertFlag</strong> (optional) - Set this to a unique text that
you can use (by sending a message to the "whitelist manager" above)
+to tell the mailet to insert some new remote recipients to the white list.
Default is null.</li>
+<li><strong>removeFlag</strong> (optional) - Set this to a unique text that
you can use (by sending a message to the "whitelist manager" above)
+to tell the mailet to remove some remote recipients from the white list.
Default is null.</li>
+</ul>
+
+</div>
+</div>
+
+
+ </div>
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ <div id="footer">
+ <div class="xright">©
+ 2002-2006
+
+ Apache Software Foundation
+
+
+
+
+
+
+
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ </body>
+</html>
Added: james/site/trunk/www/server/provided_matchers_2_3.html
URL:
http://svn.apache.org/viewvc/james/site/trunk/www/server/provided_matchers_2_3.html?rev=433228&view=auto
==============================================================================
--- james/site/trunk/www/server/provided_matchers_2_3.html (added)
+++ james/site/trunk/www/server/provided_matchers_2_3.html Mon Aug 21 04:27:39
2006
@@ -0,0 +1,584 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";>
+
+
+
+
+
+
+
+
+
+
+<html>
+ <head>
+ <title>James Server -
+ James 2.3 - Provided Matchers</title>
+ <style type="text/css" media="all">
+ @import url("./css/maven-base.css");
+ @import url("./css/maven-theme.css");
+ @import url("./css/site.css");
+ </style>
+ <link rel="stylesheet" href="./css/print.css" type="text/css"
media="print" />
+ <meta http-equiv="Content-Type" content="text/html;
charset=ISO-8859-1" />
+ </head>
+ <body class="composite">
+ <div id="banner">
+ <a href="http://james.apache.org/index.html"; id="bannerLeft">
+
+ <img
src="images/james-server-logo.gif" alt="" />
+
+ </a>
+ <a href="http://www.apache.org/index.html";
id="bannerRight">
+
+ <img
src="images/asf-logo-reduced.gif" alt="" />
+
+ </a>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="breadcrumbs">
+
+
+
+
+
+
+
+ <div class="xleft">
+ Last Published: 08/21/2006
+ </div>
+ <div class="xright"> <a
href="http://james.apache.org/index.html";>JAMES Project</a>
+ |
+ <a href="">Server</a>
+ |
+ <a href="http://james.apache.org/jspf/index.html";>jSPF</a>
+ |
+ <a href="http://james.apache.org/mime4j/index.html";>Mime4J</a>
+ |
+ <a href="http://james.apache.org/jsieve/index.html";>JSieve</a>
+ |
+ <a href="http://james.apache.org/postage/index.html";>Postage</a>
+
+
+
+
+
+
+
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="leftColumn">
+ <div id="navcolumn">
+
+
+
+
+
+
+
+ <h5>James</h5>
+ <ul>
+
+ <li class="none">
+ <a href="index.html">Overview</a>
+ </li>
+
+ <li class="none">
+ <a href="FAQ.html">James FAQ</a>
+ </li>
+
+ <li class="none">
+ <a href="mail.html">Mailing Lists</a>
+ </li>
+
+ <li class="none">
+ <a href="http://wiki.apache.org/james";>Wiki</a>
+ </li>
+ </ul>
+ <h5>Documentation</h5>
+ <ul>
+
+ <li class="none">
+ <a href="documentation_2_1.html">James</a>
+ </li>
+
+ <li class="none">
+ <a href="design_objectives.html">Design</a>
+ </li>
+
+ <li class="none">
+ <a href="document_archive.html">Document Archive</a>
+ </li>
+ </ul>
+ <h5>Documentation 2.3</h5>
+ <ul>
+
+ <li class="none">
+ <a href="documentation_2_3.html">James</a>
+ </li>
+
+ <li class="none">
+ <a href="design_objectives_2_3.html">Design</a>
+ </li>
+
+ <li class="none">
+ <a href="apidocs/index.html">James Javadocs</a>
+ </li>
+
+ <li class="none">
+ <a href="rfclist.html">Useful RFCs</a>
+ </li>
+ </ul>
+ <h5>Project</h5>
+ <ul>
+
+ <li class="none">
+ <a href="http://issues.apache.org/jira/browse/JAMES";>Bug
Database</a>
+ </li>
+
+ <li class="none">
+ <a href="http://svn.apache.org/viewvc/james/server/";>Source
Code</a>
+ </li>
+
+ <li class="none">
+ <a href="changelog.html">Changelog</a>
+ </li>
+
+ <li class="none">
+ <a href="todo.html">TODO</a>
+ </li>
+ </ul>
+ <h5>Project Documentation</h5>
+ <ul>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="collapsed">
+ <a href="project-info.html">Project Information</a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+ <li class="collapsed">
+ <a href="project-reports.html">Project Reports</a>
+ </li>
+ </ul>
+ <a href="http://maven.apache.org/";
title="Built by Maven" id="poweredBy">
+ <img alt="Built by Maven"
src="./images/logos/maven-feather.png"></img>
+ </a>
+
+
+
+
+
+
+
+ </div>
+ </div>
+ <div id="bodyColumn">
+ <div id="contentBox">
+
+
+
+
+
+
+<a name="Matchers"></a><div class="section"><h2>Matchers</h2>
+
+<p>James provides a number of implemented Matchers for use by James
administrators in their
+configurations. These are primarily matchers that members of the James
developer or user
+communities have found useful in their own configurations. A description of
how to configure
+Matchers and use them in the James SpoolManager can be found <a
href="spoolmanager_configuration_2_3.html">here</a>.</p>
+
+<a name="All"></a><div class="section"><h3>All</h3>
+<p>Description: This matcher is the trivial one - it matches all mails being
processed. All recipients are returned.</p>
+<p>Configuration string: None.</p>
+</div>
+
+<a name="AttachmentFileNameIs"></a><div
class="section"><h3>AttachmentFileNameIs</h3>
+<p>Description: It can be used to refuse emails with SCR, PIF, EXE etc.
attachments.
+It matches mails that has a file attachment with a file name meeting one of
the supplied filters.
+All recipients are returned.</p>
+<p>Configuration string: A comma or space delimited list of file names.
+File names may start with a wildcard '*'. Example:
*.scr,*.bat,*.pif,*.pi,*.com,*.exe
+<pre><code>
+<mailet match="AttachmentFileNameIs=value, value, .."
class="<any-class>">
+</code></pre>
+</p>
+</div>
+
+<a name="CommandForListserv"></a><div
class="section"><h3>CommandForListserv</h3>
+<p>Description: The CommandForListserv matcher is used as a simple filter to
recognize emails that are list server
+commands. It will match any email addressed to the list server host, as well
as any email that is addressed
+to a user named <prefix>-on or <prefix>-off on any host. Only
those matching recipients will be returned.</p>
+<p>Configuration string: An email address of the form
<prefix>@<host>, where host is the hostname used for the listserver
and prefix is the command prefix.
+<pre><code>
+<mailet match="[EMAIL PROTECTED]"
class="<any-class>">
+</code></pre>
+</p>
+</div>
+
+<a name="CommandForListservManager"></a><div
class="section"><h3>CommandForListservManager</h3>
+<p>Description: CommandListservMatcher is the matcher that pairs with the
CommandListservManager mailet. It checks to see if the request is
+intended for the ListservManager, but doesn't guarantee that it is a valid
command. Only those matching recipients will be returned.</p>
+<p>Configuration string: An email address.
+<pre><code>
+<mailet match="[EMAIL PROTECTED]"
class="<any-class>">
+</code></pre>
+</p>
+</div>
+
+<a name="CompareNumericHeaderValue"></a><div
class="section"><h3>CompareNumericHeaderValue</h3>
+<p>Description: Matches mails containing a header with a numeric value whose
comparison with the specified value is true.
+If the header is missing in the message, there will be <i>no match</i>. All
recipients are returned.</p>
+<p>Configuration string: The headerName, a comparison operator and the numeric
headerValue
+to compare with, <i>space or tab delimited</i>.
+<pre><code>
+<mailet match="CompareNumericHeaderValue= X-MessageIsSpamProbability
> 0.9" class="<any-class>">
+</code></pre>
+</p>
+</div>
+
+<a name="FetchedFrom"></a><div class="section"><h3>FetchedFrom</h3>
+<p>Description: A matcher intended for use with the FetchMail server. It
matches a custom header (X-fetched-from) that is
+set by the FetchMail server. FetchMail sets this header to the name of the
FetchPOP task which originally fetched
+the message. All recipients are returned.</p>
+<p>Configuration string: The name of the FetchMail task which originally
fetched the message.
+<pre><code>
+<mailet match="FetchedFrom=value"
class="<any-class>">
+</code></pre>
+</p>
+</div>
+
+<a name="FileRegexMatcher"></a><div class="section"><h3>FileRegexMatcher</h3>
+<p>Description: A matcher which can be used to match on a attachment when the
given regex match. All recipients are returned.</p>
+<p>Configuration string: A regex for match attachmentname.
+<pre><code>
+<mailet match="FileRegexMatcher=value"
class="<any-class>">
+</code></pre>
+</p>
+</div>
+
+<a name="HasAttachment"></a><div class="section"><h3>HasAttachment</h3>
+<p>Description: Matches those messages with a MIME type of
"multipart/mixed". All recipients are returned.</p>
+<p>Configuration string: None.</p>
+</div>
+
+<a name="HasHabeasWarrantMark"></a><div
class="section"><h3>HasHabeasWarrantMark</h3>
+<p>Description: Matches mails that have the Habeas Warrant (see
http://www.habeas.com for details). All recipients are returned.</p>
+<p>Configuration string: None.</p>
+</div>
+
+<a name="HasHeader"></a><div class="section"><h3>HasHeader</h3>
+<p>Description: Matches mails that have the specified header. All recipients
are returned.</p>
+<p>Configuration string: The name of the header whose presence determines the
match.
+<pre><code>
+<mailet match="HasHeader=value"
class="<any-class>">
+</code></pre>
+</p>
+</div>
+
+<a name="HasMailAttribute"></a><div class="section"><h3>HasMailAttribute</h3>
+<p>Description: Matches mails that have the specified Mail Attribute. All
+recipients are returned.</p>
+<p>Configuration string: The name of the Mail Attribute to match. For
example:<br></br>
+<pre><code>
+<mailet match="HasMailAttribute=name"
class="<any-class>">
+</code></pre>
+</p>
+</div>
+
+<a name="HasMailAttributeWithValue"></a><div
class="section"><h3>HasMailAttributeWithValue</h3>
+<p>Description: Matches mails that have the specified Mail Attribute and the
+specified MailAttribute value. All recipients are returned.</p>
+<p>MailAttributes are types of Object whereas the value specified in the
Matcher
+condition is of type String. The toString() method is used to obtain a String
+representation of the Mail Attribute value for matching. The
+String.equals(String) method tests for a match.</p>
+<p>Configuration string: The name of the Mail Attribute to be matched, a comma
+and then the String value to be matched. For example:<br></br>
+<pre><code>
+<mailet match="HasMailAttributeWithValue=name, value"
class="<any-class>">
+</code></pre>
+</p>
+</div>
+
+<a name="HasMailAttributeWithValueRegex"></a><div
class="section"><h3>HasMailAttributeWithValueRegex</h3>
+<p>Description: Matches mails that have the specified Mail Attribute and
+a MailAttribute value that matches the specified regular expression.
+All recipients are returned.</p>
+<p>MailAttributes are types of Object whereas the value specified in the
Matcher
+condition is of type String. The toString() method is used to obtain a String
+representation of the Mail Attribute value for matching. The regular
+expression must follow Perl5 syntax.</p>
+<p>Configuration string: The name of the Mail Attribute to be matched, a comma
+and then the regular expression used to match the value against. For
example:<br></br>
+<pre><code>
+<mailet match="HasMailAttributeWithValueRegex=name, regex"
class="<any-class>">
+</code></pre>
+</p>
+</div>
+
+<a name="HostIs"></a><div class="section"><h3>HostIs</h3>
+<p>Description: Matches mails that are sent to email addresses on hosts that
are in the configuration list. Only
+recipients that are on one of the hosts are returned.</p>
+<p>Configuration string: A list of host names, comma or space delimited.
+<pre><code>
+<mailet match="HostIs=value, value, .."
class="<any-class>">
+</code></pre>
+</p>
+</div>
+
+<a name="HostIsLocal"></a><div class="section"><h3>HostIsLocal</h3>
+<p>Description: Matches mails that are sent to email addresses on local hosts.
Only
+recipients that are on one of the local hosts are returned.</p>
+<p>Configuration string: None.</p>
+</div>
+
+<a name="InSpammerBlacklist"></a><div
class="section"><h3>InSpammerBlacklist</h3>
+<p>Description: Checks the mail against one of a number of mail-abuse.org IP
lists. All recipients are returned</p>
+<p>Configuration string: One of three strings -
"blackholes.mail-abuse.org", "relays.mail-abuse.org", or
"dialups.mail-abuse.org".</p>
+</div>
+
+<a name="IsInWhiteList"></a><div class="section"><h3>IsInWhiteList</h3>
+<p>Description: Matches recipients having the mail sender in the recipient's
private whitelist.
+The recipient name is always converted to its primary name (handling
aliases).</p>
+<p>Configuration string: The database name containing the white list table.</p>
+<pre><code>
+<mailet match="IsInWhiteList=db://maildb"
class="ToProcessor">
+ <processor> transport </processor>
+</mailet>
+</code></pre>
+</div>
+
+<a name="IsSingleRecipient"></a><div class="section"><h3>IsSingleRecipient</h3>
+<p>Description: Matches those messages sent to only a single recipient. The
single recipient is returned.</p>
+<p>Configuration string: None.</p>
+</div>
+
+<a name="NESSpamCheck"></a><div class="section"><h3>NESSpamCheck</h3>
+<p>Description: A matcher derived from a Netscape Mail Server spam filter. If
the matcher detects headers that
+indicate spam, the message is matched. All recipients are returned.</p>
+<p>Configuration string: None.</p>
+</div>
+
+<a name="RecipientIs"></a><div class="section"><h3>RecipientIs</h3>
+<p>Description: Matches mails that are sent to one of the recipients on a
specified list. Only
+matching recipients are returned.</p>
+<p>Configuration string: A list of recipient addresses, comma, tab, or space
delimited.
+<pre><code>
+<mailet match="RecipientIs=value, value, .."
class="<any-class>">
+</code></pre>
+</p>
+</div>
+
+<a name="RecipientIsLocal"></a><div class="section"><h3>RecipientIsLocal</h3>
+<p>Description: Matches mails that are sent to email addresses on local hosts
with users that have local acccunts. Only
+matching recipients are returned.</p>
+<p>Configuration string: None.</p>
+</div>
+
+<a name="RecipientIsOverFixedQuota"></a><div
class="section"><h3>RecipientIsOverFixedQuota</h3>
+<p>Description: Matches mails that are send to email addresses which are over
the given quota. Only
+matching recipients are returned.</p>
+<p>Configuration string: The quota
+<pre><code>
+<mailet match="RecipientIsOverFixedQuota=10m"
class="<any-class>">
+</code></pre>
+</p>
+</div>
+
+<a name="RecipientIsRegex"></a><div class="section"><h3>RecipientIsRegex</h3>
+<p>Description: Matches mails that are send to email addresses which are
matched given regex. Only
+matching recipients are returned.</p>
+<p>Configuration string: The quota
+<pre><code>
+<mailet match="RecipientIsRegex=value"
class="<any-class>">
+</code></pre>
+</p>
+</div>
+
+
+<a name="RelayLimit"></a><div class="section"><h3>RelayLimit</h3>
+<p>Description: Counts the number of Received headers in the mail (each of
which represents a server
+in the relay chain). If the number equals or exceeds the specified limit, the
mail is
+matched. All recipients are returned.</p>
+<p>Configuration string: a positive integer that is the limit on the number of
relays.
+<pre><code>
+<mailet match="RelayLimit=value"
class="<any-class>">
+</code></pre>
+</p>
+</div>
+
+<a name="RemoteAddrInNetwork"></a><div
class="section"><h3>RemoteAddrInNetwork</h3>
+<p>Description: Checks the remote address from which the mail was received
against the configured list. If the address matches one on the list, the
matcher considers it a match.
+All recipients are returned.</p>
+<p>Configuration string: A list of domain names, IP addresses, or wildcarded
IP subnets of any class. The
+list may be comma or space delimited.
+<pre><code>
+<mailet match="RemoteAddrInNetwork=value, value, .."
class="<any-class>">
+</code></pre>
+</p>
+</div>
+
+<a name="RemoteAddrNotInNetwork"></a><div
class="section"><h3>RemoteAddrNotInNetwork</h3>
+<p>Description: Checks the remote address from which the mail was received
against the configured list. If the address doesn't match one on the list, the
matcher considers it a match.
+All recipients are returned.</p>
+<p>Configuration string: A list of domain names, IP addresses, or wildcarded
IP subnets of any class. The
+list may be comma or space delimited.
+<pre><code>
+<mailet match="RemoteAddrNotInNetwork=value, value, .."
class="<any-class>">
+</code></pre>
+</p>
+</div>
+
+<a name="SenderHostIs"></a><div class="section"><h3>SenderHostIs</h3>
+<p>Description: Matches mails where the host name in the address of the sender
cannot be resolved. All
+recipients are returned.</p>
+<p>Configuration string: None.</p>
+</div>
+
+<a name="SenderInFakeDomain"></a><div
class="section"><h3>SenderInFakeDomain</h3>
+<p>Description: Matches mails where the host name in the address of the sender
cannot be resolved. All
+recipients are returned.</p>
+<p>Configuration string: None.</p>
+</div>
+
+<a name="SenderIs"></a><div class="section"><h3>SenderIs</h3>
+<p>Description: Matches mails that are sent by one of the senders on a
specified list. All
+recipients are returned.</p>
+<p>Configuration string: A list of sender addresses, comma, tab, or space
delimited.
+<pre><code>
+<mailet match="SenderIs=value, value, .."
class="<any-class>">
+</code></pre>
+</p>
+</div>
+
+<a name="SenderIsNull"></a><div class="section"><h3>SenderIsNull</h3>
+<p>Description: Matches mails that are sent by a null sender.</p>
+<p>Configuration string: none.
+<pre><code>
+<mailet match="SenderIsNull"
class="<any-class>">
+</code></pre>
+</p>
+</div>
+
+<a name="SenderIsRegex"></a><div class="section"><h3>SenderIsRegex</h3>
+<p>Description: Matches mails that are sent by one of the senders matched the
given regex.
+All recipients are returned.</p>
+<p>Configuration string: A regex.
+<pre><code>
+<mailet match="SenderIsRegex=value"
class="<any-class>">
+</code></pre>
+</p>
+</div>
+
+<a name="SizeGreaterThan"></a><div class="section"><h3>SizeGreaterThan</h3>
+<p>Description: Matches emails with a total message size (headers and body)
greater than the specified limit.
+All recipients are returned.</p>
+<p>Configuration string: a positive integer followed by an 'm' or a 'k'. This
is the maximum message size permitted
+specified in megabytes or kilobytes respectively.
+<pre><code>
+<mailet match="SizeGreaterThan=1m"
class="<any-class>">
+</code></pre>
+</p>
+</div>
+
+<a name="SMTPAuthSuccessful"></a><div
class="section"><h3>SMTPAuthSuccessful</h3>
+<p>Description: Matches mails that are send from an authorized sender. All
recipients are returned.</p>
+<p>Configuration string: none.
+<pre><code>
+<mailet match="SMTPAuthSuccessful"
class="<any-class>">
+</code></pre>
+</p>
+</div>
+
+<a name="SMTPAuthUserIs"></a><div class="section"><h3>SMTPAuthUserIs</h3>
+<p>Description: Matches mails that are send from one of the given authorized
senders. All recipients are returned.</p>
+<p>Configuration string: none.
+<pre><code>
+<mailet match="SMTPAuthUserIs=value, value, .."
class="<any-class>">
+</code></pre>
+</p>
+</div>
+
+
+<a name="SubjectIs"></a><div class="section"><h3>SubjectIs</h3>
+<p>Description: Matches emails with the specified subject. All recipients are
returned.</p>
+<p>Configuration string: The string against which mail subject headers are
matched.
+<pre><code>
+<mailet match="SubjectIs=value"
class="<any-class>">
+</code></pre>
+</p>
+</div>
+
+<a name="SubjectStartsWith"></a><div class="section"><h3>SubjectStartsWith</h3>
+<p>Description: Matches emails whose subject header starts with the specified
string. All recipients are returned.</p>
+<p>Configuration string: The string against which mail subject headers are
matched.
+<pre><code>
+<mailet match="SubjectStartsWith=value"
class="<any-class>">
+</code></pre>
+</p>
+</div>
+
+<a name="UserIs"></a><div class="section"><h3>UserIs</h3>
+<p>Description: Matches mails that are sent to email addresses that have
userids that are in the configuration list. Only
+matching recipients are returned.</p>
+<p>Configuration string: A list of user names, comma or space delimited.
+<pre><code>
+<mailet match="UserIs=value, value, .."
class="<any-class>">
+</code></pre>
+</p>
+</div>
+
+</div>
+
+
+ </div>
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ <div id="footer">
+ <div class="xright">©
+ 2002-2006
+
+ Apache Software Foundation
+
+
+
+
+
+
+
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ </body>
+</html>
