james-server-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From nor...@apache.org
Subject svn commit: r418928 - in /james/server/trunk/src/xdocs: provided_mailets_2_3.xml provided_matchers_2_3.xml
Date Tue, 04 Jul 2006 06:39:46 GMT
Author: norman
Date: Mon Jul  3 23:39:45 2006
New Revision: 418928

URL: http://svn.apache.org/viewvc?rev=418928&view=rev
Log:
Complete Matcher overview

Modified:
    james/server/trunk/src/xdocs/provided_mailets_2_3.xml
    james/server/trunk/src/xdocs/provided_matchers_2_3.xml

Modified: james/server/trunk/src/xdocs/provided_mailets_2_3.xml
URL: http://svn.apache.org/viewvc/james/server/trunk/src/xdocs/provided_mailets_2_3.xml?rev=418928&r1=418927&r2=418928&view=diff
==============================================================================
--- james/server/trunk/src/xdocs/provided_mailets_2_3.xml (original)
+++ james/server/trunk/src/xdocs/provided_mailets_2_3.xml Mon Jul  3 23:39:45 2006
@@ -3,7 +3,7 @@
 <document>
 
  <properties>
-  <title>James 2.1 - Provided Mailets</title>
+  <title>James 2.3 - Provided Mailets</title>
  </properties>
 
 <body>
@@ -135,6 +135,29 @@
 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>
+</p>
+</subsection>
+
+<subsection name="DSNBounce">
+<p>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>&lt;&gt;</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.</p>
+<p>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>
 </p>
 </subsection>

Modified: james/server/trunk/src/xdocs/provided_matchers_2_3.xml
URL: http://svn.apache.org/viewvc/james/server/trunk/src/xdocs/provided_matchers_2_3.xml?rev=418928&r1=418927&r2=418928&view=diff
==============================================================================
--- james/server/trunk/src/xdocs/provided_matchers_2_3.xml (original)
+++ james/server/trunk/src/xdocs/provided_matchers_2_3.xml Mon Jul  3 23:39:45 2006
@@ -13,35 +13,75 @@
 <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_1.html">here</a>.</p>
+Matchers and use them in the James SpoolManager can be found <a href="spoolmanager_configuration_2_3.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>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</p>
+File names may start with a wildcard '*'. Example: *.scr,*.bat,*.pif,*.pi,*.com,*.exe
+<pre><code>
+&lt;mailet match="AttachmentFileNameIs=value, value, .." class=&quot;&lt;any-class&gt;&quot;&gt;
+</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 &lt;prefix&gt;-on or &lt;prefix&gt;-off on any host.  Only
those matching recipients will be returned.</p>
-<p>Configuration string: An email address of the form &lt;prefix&gt;@&lt;host&gt;,
where host is the hostname used for the listserver and prefix is the command prefix.</p>
+<p>Configuration string: An email address of the form &lt;prefix&gt;@&lt;host&gt;,
where host is the hostname used for the listserver and prefix is the command prefix.
+<pre><code>
+&lt;mailet match="CommandForListserv=james-on@list.working-dogs.com" class=&quot;&lt;any-class&gt;&quot;&gt;
+</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>
+&lt;mailet match="CommandForListservManager=announce@localhost" class=&quot;&lt;any-class&gt;&quot;&gt;
+</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>
+&lt;mailet match="CompareNumericHeaderValue= X-MessageIsSpamProbability &gt; 0.9"
class=&quot;&lt;any-class&gt;&quot;&gt;
+</code></pre>
+</p>
+</subsection>
+
 <subsection name="FetchedFrom">
-<p>Description: A matcher intended for use with the FetchPOP server.  It matches a
custom header (X-fetched-from) that is 
-set by the FetchPOP server.  FetchPOP sets this header to the name of the FetchPOP task which
originally fetched
+<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 FetchPOP task which originally fetched the
message.</p>
+<p>Configuration string: The name of the FetchMail task which originally fetched the
message.
+<pre><code>
+&lt;mailet match="FetchedFrom=value" class=&quot;&lt;any-class&gt;&quot;&gt;
+</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.</p>
-<p>Configuration string: A regex for match attachmentname.</p>
+<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>
+&lt;mailet match="FileRegexMatcher=value" class=&quot;&lt;any-class&gt;&quot;&gt;
+</code></pre>
+</p>
 </subsection>
 
 <subsection name="HasAttachment">
@@ -56,7 +96,11 @@
 
 <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.</p>
+<p>Configuration string: The name of the header whose presence determines the match.
+<pre><code>
+&lt;mailet match="HasHeader=value" class=&quot;&lt;any-class&gt;&quot;&gt;
+</code></pre>
+</p>
 </subsection>
 
 <subsection name="HasMailAttribute">
@@ -117,7 +161,7 @@
 </subsection>
 
 <subsection name="InSpammerBlacklist">
-<p>Description: Checks the mail against one of a number of mail-abuse.org IP lists.</p>
+<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>
 
@@ -148,6 +192,27 @@
 <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>
+&lt;mailet match="RecipientIsOverFixedQuota=10m" class=&quot;&lt;any-class&gt;&quot;&gt;
+</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>
+&lt;mailet match="RecipientIsRegex=value" class=&quot;&lt;any-class&gt;&quot;&gt;
+</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 
@@ -160,7 +225,8 @@
 </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>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>
@@ -170,7 +236,8 @@
 </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>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>
@@ -211,7 +278,8 @@
 </subsection>
 
 <subsection name="SenderIsRegex">
-<p>Description: Matches mails that are sent by one of the senders matched the given
regex.</p>
+<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>
 &lt;mailet match="SenderIsRegex=value" class=&quot;&lt;any-class&gt;&quot;&gt;
@@ -220,8 +288,10 @@
 </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.
+<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>
 &lt;mailet match="SizeGreaterThan=1m" class=&quot;&lt;any-class&gt;&quot;&gt;
 </code></pre>
@@ -229,7 +299,7 @@
 </subsection>
 
 <subsection name="SMTPAuthSuccessful">
-<p>Description: Matches mails that are send from an authorized sender.</p>
+<p>Description: Matches mails that are send from an authorized sender. All recipients
are returned.</p>
 <p>Configuration string: none.
 <pre><code>
 &lt;mailet match="SMTPAuthSuccessful" class=&quot;&lt;any-class&gt;&quot;&gt;
@@ -238,7 +308,7 @@
 </subsection>
 
 <subsection name="SMTPAuthUserIs">
-<p>Description: Matches mails that are send from one of the given authorized senders.</p>
+<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>
 &lt;mailet match="SMTPAuthUserIs=value, value, .." class=&quot;&lt;any-class&gt;&quot;&gt;



---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org


Mime
View raw message