Java Doc for AbstractNotify.java in  » Net » james-2.3.1 » org » apache » james » transport » mailets » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Abstract mailet providing configurable notification services.
This mailet can be subclassed to make authoring notification mailets simple.

Provides the following functionalities to all notification subclasses:

• A common notification message layout.
• A sender of the notification message can optionally be specified. If one is not specified, the postmaster's address will be used.
• A notice text can be specified, and in such case will be inserted into the notification inline text.
• If the notified message has an "error message" set, it will be inserted into the notification inline text. If the attachStackTrace init parameter is set to true, such error message will be attached to the notification message.
• The notified messages are attached in their entirety (headers and content) and the resulting MIME part type is "message/rfc822".
• Supports by default the passThrough init parameter (true if missing).

Sample configuration common to all notification mailet subclasses:

 <mailet match="All" class="a notification mailet">
 <sender>an address or postmaster or sender or unaltered, default=postmaster</sender>
 <attachError>true or false, default=false</attachError>
 <message>notice attached to the original message text (optional)</message>
 <prefix>optional subject prefix prepended to the original message</prefix>
 <inline>see 
Redirect , default=none</inline>
 <attachment>see 
Redirect , default=message</attachment>
 <passThrough>true or false, default=true</passThrough>
 <fakeDomainCheck>true or false, default=true</fakeDomainCheck>
 <debug>true or false, default=false</debug>
 </mailet>
 

notice and senderAddress can be used instead of message and sender; such names are kept for backward compatibility.