You are viewing a plain text version of this content. The canonical link for it is here.
Posted to server-dev@james.apache.org by bt...@apache.org on 2016/08/18 10:19:30 UTC
[07/10] james-project git commit: JAMES-1773 Re-indent matcher
documentation
JAMES-1773 Re-indent matcher documentation
Project: http://git-wip-us.apache.org/repos/asf/james-project/repo
Commit: http://git-wip-us.apache.org/repos/asf/james-project/commit/d0114b57
Tree: http://git-wip-us.apache.org/repos/asf/james-project/tree/d0114b57
Diff: http://git-wip-us.apache.org/repos/asf/james-project/diff/d0114b57
Branch: refs/heads/master
Commit: d0114b57dc05a365f16f8dcf57213024e6117401
Parents: be1be8b
Author: Benoit Tellier <bt...@linagora.com>
Authored: Tue Aug 9 11:51:42 2016 +0700
Committer: Benoit Tellier <bt...@linagora.com>
Committed: Thu Aug 18 17:18:15 2016 +0700
----------------------------------------------------------------------
server/src/site/xdoc/dev-provided-matchers.xml | 714 ++++++++++----------
1 file changed, 358 insertions(+), 356 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/james-project/blob/d0114b57/server/src/site/xdoc/dev-provided-matchers.xml
----------------------------------------------------------------------
diff --git a/server/src/site/xdoc/dev-provided-matchers.xml b/server/src/site/xdoc/dev-provided-matchers.xml
index 9095abf..7b0d749 100644
--- a/server/src/site/xdoc/dev-provided-matchers.xml
+++ b/server/src/site/xdoc/dev-provided-matchers.xml
@@ -19,360 +19,362 @@
-->
<document>
- <properties>
- <title>Apache James Server 3 - Provided Matchers</title>
- </properties>
-
-<body>
-
-<section name="Matchers">
-
-<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="config-mailetcontainer.html">here</a>.</p>
-
-<subsection name="All">
-<p>Description: This matcher is the trivial one - it matches all mails being processed. All recipients are returned.</p>
-<p>Configuration string: None.</p>
-</subsection>
-
-<subsection name="AttachmentFileNameIs">
-<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>
-</subsection>
-
-<subsection name="CommandForListserv">
-<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="CommandForListserv=james-on@list.working-dogs.com" class="<any-class>">
-</code></pre>
-</p>
-</subsection>
-
-<subsection name="CommandForListservManager">
-<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="CommandForListservManager=announce@localhost" class="<any-class>">
-</code></pre>
-</p>
-</subsection>
-
-<subsection name="CompareNumericHeaderValue">
-<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>
-</subsection>
-
-<subsection name="FetchedFrom">
-<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>
-</subsection>
-
-<subsection name="FileRegexMatcher">
-<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>
-</subsection>
-
-<subsection name="HasAttachment">
-<p>Description: Matches those messages with a MIME type of "multipart/mixed". All recipients are returned.</p>
-<p>Configuration string: None.</p>
-</subsection>
-
-<subsection name="HasHabeasWarrantMark">
-<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>
-</subsection>
-
-<subsection name="HasHeader">
-<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>
-</subsection>
-
-<subsection name="HasMailAttribute">
-<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/>
-<pre><code>
-<mailet match="HasMailAttribute=name" class="<any-class>">
-</code></pre>
-</p>
-</subsection>
-
-<subsection name="HasMailAttributeWithValue">
-<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/>
-<pre><code>
-<mailet match="HasMailAttributeWithValue=name, value" class="<any-class>">
-</code></pre>
-</p>
-</subsection>
-
-<subsection name="HasMailAttributeWithValueRegex">
-<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/>
-<pre><code>
-<mailet match="HasMailAttributeWithValueRegex=name, regex" class="<any-class>">
-</code></pre>
-</p>
-</subsection>
-
-<subsection name="HostIs">
-<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>
-</subsection>
-
-<subsection name="HostIsLocal">
-<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>
-</subsection>
-
-<subsection name="InSpammerBlacklist">
-<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>
-</subsection>
-
-<subsection name="IsInWhiteList">
-<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>
-</subsection>
-
-<subsection name="IsSingleRecipient">
-<p>Description: Matches those messages sent to only a single recipient. The single recipient is returned.</p>
-<p>Configuration string: None.</p>
-</subsection>
-
-<subsection name="NESSpamCheck">
-<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>
-</subsection>
-
-<subsection name="RecipientIs">
-<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>
-</subsection>
-
-<subsection name="RecipientIsLocal">
-<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>
-</subsection>
-
-<subsection name="RecipientIsOverFixedQuota">
-<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>
-</subsection>
-
-<subsection name="RecipientIsRegex">
-<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>
-</subsection>
-
-
-<subsection name="RelayLimit">
-<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>
-</subsection>
-
-<subsection name="RemoteAddrInNetwork">
-<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>
-</subsection>
-
-<subsection name="RemoteAddrNotInNetwork">
-<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>
-</subsection>
-
-<subsection name="SenderHostIs">
-<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>
-</subsection>
-
-<subsection name="SenderInFakeDomain">
-<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>
-</subsection>
-
-<subsection name="SenderIs">
-<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>
-</subsection>
-
-<subsection name="SenderIsNull">
-<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>
-</subsection>
-
-<subsection name="SenderIsRegex">
-<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>
-</subsection>
-
-<subsection name="SizeGreaterThan">
-<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>
-</subsection>
-
-<subsection name="SMTPAuthSuccessful">
-<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>
-</subsection>
-
-<subsection name="SMTPAuthUserIs">
-<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>
-</subsection>
-
-
-<subsection name="SubjectIs">
-<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>
-</subsection>
-
-<subsection name="SubjectStartsWith">
-<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>
-</subsection>
-
-<subsection name="UserIs">
-<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>
-</subsection>
-
-</section>
-</body>
+ <properties>
+ <title>Apache James Server 3 - Provided Matchers</title>
+ </properties>
+
+ <body>
+
+ <section name="Matchers">
+
+ <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="config-mailetcontainer.html">here</a>.</p>
+
+ <subsection name="All">
+ <p>Description: This matcher is the trivial one - it matches all mails being processed. All recipients are returned.</p>
+ <p>Configuration string: None.</p>
+ </subsection>
+
+ <subsection name="AttachmentFileNameIs">
+ <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>
+ </subsection>
+
+ <subsection name="CommandForListserv">
+ <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="CommandForListserv=james-on@list.working-dogs.com" class="<any-class>">
+ </code></pre>
+ </p>
+ </subsection>
+
+ <subsection name="CommandForListservManager">
+ <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="CommandForListservManager=announce@localhost" class="<any-class>">
+ </code></pre>
+ </p>
+ </subsection>
+
+ <subsection name="CompareNumericHeaderValue">
+ <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>
+ </subsection>
+
+ <subsection name="FetchedFrom">
+ <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>
+ </subsection>
+
+ <subsection name="FileRegexMatcher">
+ <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>
+ </subsection>
+
+ <subsection name="HasAttachment">
+ <p>Description: Matches those messages with a MIME type of "multipart/mixed". All recipients are returned.</p>
+ <p>Configuration string: None.</p>
+ </subsection>
+
+ <subsection name="HasHabeasWarrantMark">
+ <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>
+ </subsection>
+
+ <subsection name="HasHeader">
+ <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=headerName" class="<any-class>">
+ </code></pre>
+ </p>
+
+ </subsection>
+
+ <subsection name="HasMailAttribute">
+ <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/>
+ <pre><code>
+ <mailet match="HasMailAttribute=name" class="<any-class>">
+ </code></pre>
+ </p>
+ </subsection>
+
+ <subsection name="HasMailAttributeWithValue">
+ <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/>
+ <pre><code>
+ <mailet match="HasMailAttributeWithValue=name, value" class="<any-class>">
+ </code></pre>
+ </p>
+ </subsection>
+
+ <subsection name="HasMailAttributeWithValueRegex">
+ <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/>
+ <pre><code>
+ <mailet match="HasMailAttributeWithValueRegex=name, regex" class="<any-class>">
+ </code></pre>
+ </p>
+ </subsection>
+
+ <subsection name="HostIs">
+ <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>
+ </subsection>
+
+ <subsection name="HostIsLocal">
+ <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>
+ </subsection>
+
+ <subsection name="InSpammerBlacklist">
+ <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>
+ </subsection>
+
+ <subsection name="IsInWhiteList">
+ <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>
+ </subsection>
+
+ <subsection name="IsSingleRecipient">
+ <p>Description: Matches those messages sent to only a single recipient. The single recipient is returned.</p>
+ <p>Configuration string: None.</p>
+ </subsection>
+
+ <subsection name="NESSpamCheck">
+ <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>
+ </subsection>
+
+ <subsection name="RecipientIs">
+ <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>
+ </subsection>
+
+ <subsection name="RecipientIsLocal">
+ <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>
+ </subsection>
+
+ <subsection name="RecipientIsOverFixedQuota">
+ <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>
+ </subsection>
+
+ <subsection name="RecipientIsRegex">
+ <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>
+ </subsection>
+
+
+ <subsection name="RelayLimit">
+ <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>
+ </subsection>
+
+ <subsection name="RemoteAddrInNetwork">
+ <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>
+ </subsection>
+
+ <subsection name="RemoteAddrNotInNetwork">
+ <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>
+ </subsection>
+
+ <subsection name="SenderHostIs">
+ <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>
+ </subsection>
+
+ <subsection name="SenderInFakeDomain">
+ <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>
+ </subsection>
+
+ <subsection name="SenderIs">
+ <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>
+ </subsection>
+
+ <subsection name="SenderIsNull">
+ <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>
+ </subsection>
+
+ <subsection name="SenderIsRegex">
+ <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>
+ </subsection>
+
+ <subsection name="SizeGreaterThan">
+ <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>
+ </subsection>
+
+ <subsection name="SMTPAuthSuccessful">
+ <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>
+ </subsection>
+
+ <subsection name="SMTPAuthUserIs">
+ <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>
+ </subsection>
+
+
+ <subsection name="SubjectIs">
+ <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>
+ </subsection>
+
+ <subsection name="SubjectStartsWith">
+ <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>
+ </subsection>
+
+ <subsection name="UserIs">
+ <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>
+ </subsection>
+
+ </section>
+ </body>
</document>
---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org