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 da...@apache.org on 2002/01/10 17:16:44 UTC
cvs commit: jakarta-james/src/xdocs configuration_v2_0.xml
danny 02/01/10 08:16:44
Modified: src/xdocs configuration_v2_0.xml
Log:
added redirect mailet docs
Revision Changes Path
1.2 +161 -14 jakarta-james/src/xdocs/configuration_v2_0.xml
Index: configuration_v2_0.xml
===================================================================
RCS file: /home/cvs/jakarta-james/src/xdocs/configuration_v2_0.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- configuration_v2_0.xml 30 Oct 2001 13:12:08 -0000 1.1
+++ configuration_v2_0.xml 10 Jan 2002 16:16:44 -0000 1.2
@@ -457,13 +457,9 @@
<br>
<mailet match="RecipientIs=root@localhost"
class="Forward"></br>
- <strong>Note!</strong> - There is a new mailet named Redirect that will replace
- this and other mailets. No documentation is available yet.
<blockquote>
<br>
<forwardto> green@blue.org </forwardto>
- </br>
- <br>
<forwardto> red@yellow.com </forwardto>
</br>
</blockquote>
@@ -525,13 +521,10 @@
</blockquote>
<b>RemoteDelivery</b>
- <blockquote>
- Realy mails to remote hosts. "delayTime" is the time in mills the
- mailet will wait
- before retrying sending a mail which fail at first time.
- "maxRetries" is the number of
- retries before sending back to sender the mail.
- <br>
+
+ Relay mails to remote hosts. "delayTime" is the time in mills the
+ mailet will wait before retrying sending a mail which fail at first time. "maxRetries"
+ is the number of retries before sending back to sender the mail. <br>
<mailet match="!RecipientIsLocal" class="RemoteDelivery">
</br>
<blockquote>
@@ -542,9 +535,163 @@
<maxRetries> 5 </maxRetries>
</br>
</blockquote>
- </mailet>
- </blockquote>
-
+
+ <p></mailet> </p>
+
+ <b>Redirect</b>
+ <dl> <dt>A mailet providing 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 laid out
+ below.</dt>
+ </dl>
+ <p>However it is also designed to be easily subclassed to make authoring 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</p>
+ <p>The configuration parameters are:</p>
+ <table border="1" >
+ <tr>
+ <th>param</th>
+ <th>desc</th>
+
+ </tr>
+ <tr>
+ <td><recipients></td>
+ <td>A comma delimited list of email addresses for recipients of this message,
+ it will use the "to" list if not specified. These addresses
+ will only appear in the To: header if no "to" list is supplied.</td>
+ </tr>
+ <tr>
+ <td><to></td>
+ <td>A comma delimited list of addresses to appear in the To: header, the
+ email will only be delivered to these addresses if they are in the recipients
+ list.<br>
+ </br>
+ The recipients list will be used if this is not supplied</td>
+ </tr>
+ <tr>
+ <td><sender></td>
+ <td>A single email address to appear in the From: header <br>
+ </br>
+ It can include constants "sender" and "postmaster"</td>
+ </tr>
+ <tr>
+ <td><message></td>
+ <td>A text message to be the body of the email. Can be omitted.</td>
+ </tr>
+ <tr>
+ <td><inline></td>
+ <td>
+ <p>One of the following items:</p>
+ <ul>
+ <li>unaltered The original message is the new
+ message, for forwarding/aliasing</li>
+ <li>heads The
+ headers of the original message are appended to the message</li>
+ <li>body The
+ body of the original is appended to the new message</li>
+ <li>all Both
+ headers and body are appended</li>
+ <li>none Neither
+ body nor headers are appended</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td><attachment></td>
+ <td>
+ <p>One of the following items:</p>
+ <ul>
+ <li>heads The headers of the original
+ are attached as text</li>
+ <li>body The body of the original
+ is attached as text</li>
+ <li>all Both
+ headers and body are attached as a single text file</li>
+ <li>none Nothing is attached</li>
+ <li>message The original message is attached as type message/rfc822,
+ this means that it can, in many cases, be opened, resent, fw'd, replied
+ to etc by email client software.</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td><passThrough></td>
+ <td>TRUE or FALSE, if true the original message continues in the mailet
+ processor after this mailet is finished. False causes the original to
+ be stopped.</td>
+ </tr>
+ <tr>
+ <td><attachError></td>
+ <td>TRUE or FALSE, if true any error message available to the mailet is
+ appended to the message body (except in the case of inline == unaltered)</td>
+ </tr>
+ <tr>
+ <td><replyto></td>
+ <td>A single email address to appear in the Rely-To: header, can also be
+ "sender" or "postmaster", this header is not set if
+ this is omited.</td>
+ </tr>
+ <tr>
+ <td><prefix></td>
+ <td>An optional subject prefix prepended to the original message subject,
+ for example..<br>
+ </br>
+ Undeliverable mail:</td>
+ </tr>
+ <tr>
+ <td><static></td>
+ <td>
+ <p>TRUE or FALSE, if this is true it hints to the mailet that none of
+ the parameters are set dynamically, and therefore they can be set once
+ in the init method.<br></br>
+ False tells the mailet to call all the "getters" for every
+ mail processed.</p>
+ <p>This defaults to false.<br></br>
+ It should be TRUE in all cases, except where one of the getter methods
+ has been overriden to provide dynamic values, such as a listserve which
+ might override getRecipients() to get a list from a users repository.</p>
+ </td>
+ </tr>
+ </table>
+<table border="1">
+ <tr><th>
+ <p>Example, creates a distribution list:</p></th></tr><tr><td>
+ <p> <mailet match="RecipientIs=test@localhost" class="Redirect"><br></br>
+ <recipients>x@localhost, y@localhost, z@localhost</recipients><br></br>
+ <to>list@localhost</to><br></br>
+ <sender>owner@localhost</sender><br></br>
+ <message>sent on from James</message><br></br>
+ <inline>unaltered</inline><br></br>
+ <passThrough>FALSE</passThrough><br></br>
+ <replyto>postmaster</replyto><br></br>
+ <prefix>[test mailing]</prefix><br></br>
+ <static>TRUE</static><br></br>
+ <passThrough>FALSE</passThrough><br></br>
+ </mailet><br></br>
+ </p></td></tr></table>
+<table border="1">
+ <tr><th>
+
+ <p>and this sends a spam notification to the postmaster <br></br>with the original message
+ attached as a message, and a subject prefix:</p></th></tr><tr><td>
+ <p> <mailet match="All" class="Redirect"><br></br>
+ <recipients>x@localhost</recipients><br></br>
+ <sender>postmaster</sender><br></br>
+ <message>Message marked as spam:<br></br>
+ </message><br></br>
+ <inline>heads</inline><br></br>
+ <attachment>message</attachment><br></br>
+ <passThrough>FALSE</passThrough><br></br>
+ <attachError>TRUE</attachError><br></br>
+ <replyto>postmaster</replyto><br></br>
+ <prefix>[spam notification]</prefix><br></br>
+ <static>TRUE</static><br></br>
+ <passThrough>FALSE</passThrough><br></br>
+ </mailet></p>
+</td></tr></table>
</subsection>
</section>
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>