Index: provided_mailets_2_1.xml
===================================================================
--- provided_mailets_2_1.xml (revision 124213)
+++ provided_mailets_2_1.xml (working copy)
@@ -69,6 +69,29 @@
+
+Sends Delivery Status Notification messages as described in
+RFC-3464.
+Usually used in concert with a bounceProcessor parameter on Remotedelivery, as
+RemoteDelivery sets the needed information (delivery-error attribute)
+on the failed mail prior to letting the mail be processed by the configured
+bounceProcessor. DSNBounce would then be configured into this
+bounceProcessor so it can process the original mail and send the
+notification. NOTE: at this time only error-bounces can be done.
+Parameters:
+
+- sender (optional) - an address or postmaster or
+sender or unaltered, default=postmaster.
+- prefix (optional) - subject prefix prepended to
+the original message
+- attachment (optional) - message or none, default=message
+- messageString (optional) - 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] ...
+- passThrough (optional) - true or false, default=true
+- debug (optional) - a boolean value (true/false)
+indicating whether debugging is on. Defaults to false.
+
+
+
Description: This mailet forwards the message to a set of recipients.
Parameters:
@@ -162,10 +185,23 @@
- outgoing (required) - The URL for the repository that will hold messages being processed
by the RemoteDelivery Mailet.
-- delayTime (optional) - a non-negative Long value that is the time in
-milliseconds between redelivery attempts for a particular mail. Defaults to six hours.
+- delayTime (optional) - takes the form
+<attempts*delay quantifier> where attempts and quantifier are both
+optional an defaults to 1 and miliseconds respectively.
+The delay is a non-negative value that is the time between redelivery
+attempts for a particular mail. Defaults to six hours. Allowed
+quantifiers are msec(s),sec(s),minute(s),hour(s),day(s). The attempts
+is the number of times the specified delay is used. It is possible to
+have multiple entries of this parameter, and if so the the delayTimes
+are used in the order specified, this allows you to try a few times
+in rapid succession and then move on to longer delays
- maxRetries (optional) - a non-negative Integer value that is number of times
-the Mailet will attempt to deliver a particular mail. Defaults to five.
+the Mailet will attempt to deliver a particular mail. If inconsistent
+with number of attempts in delayTime
+specifications. maxRetries will be increased if it is
+less than the total number of attempts in delayTime,
+if it is more the last specified delayTime is used
+for the missing delays. Defaults to five.
- timeout (optional) - The SMTP connection timeout for SMTP connections generated
by this Mailet. Defaults to 60 seconds.
- deliveryThreads (optional) - The number of threads this Mailet will use to generate
@@ -188,6 +224,12 @@
default local address of the machine. This tag is useful for multihomed machines.
Note: Currently you must use the same IP address for all of those RemoteDelivery
instances where you explicitly supply a bind address.
+- bounceProcessor - If present, this value is the
+name of a spool processor, on which mails that, are to bounce due to
+undeliverability, are sent. An exception carrying information about the
+cause of undeliverability, is added as a MailAttribute with name: delivery-error.
+If not present the mail is simply bounced to the sender, with a
+standard (hardcoded) undeliverability message.
- debug (optional) - a boolean value (true/false) indicating whether debugging is
on. Defaults to false.