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

Abstract mailet providing configurable redirection services.
This mailet can be subclassed to make authoring redirection mailets simple.
By extending it and overriding one or more of these methods new behaviour can be quickly created without the author having to address any other issue than the relevant one:

• attachError() , should error messages be appended to the message
• getAttachmentType(), what should be attached to the message
• getInLineType(), what should be included in the message
• getMessage(), The text of the message itself
• getRecipients(), the recipients the mail is sent to
• getReplyTo(), where replies to this message will be sent
• getReversePath(), what to set the reverse-path to
• getSender(), who the mail is from
• getSubject(), a string to replace the message subject
• getSubjectPrefix(), a prefix to be added to the message subject, possibly already replaced by a new subject
• getTo(), a list of people to whom the mail is *apparently* sent
• isReply(), should this mailet set the IN_REPLY_TO header to the id of the current message
• getPassThrough(), should this mailet allow the original message to continue processing or GHOST it.
• getFakeDomainCheck(), should this mailet check if the sender domain address is valid.
• isStatic(), should this mailet run the get methods for every mail, or just once.

For each of the methods above (generically called "getX()" methods in this class and its subclasses), there is an associated "getX(Mail)" method and most times a "setX(Mail, Tx, Mail)" method.
The roles are the following:

• a "getX()" method returns the correspondent "X" value that can be evaluated "statically" once at init time and then stored in a variable and made available for later use by a "getX(Mail)" method;
• a "getX(Mail)" method is the one called to return the correspondent "X" value that can be evaluated "dynamically", tipically based on the currently serviced mail; the default behaviour is to return the value of getX();
• a "setX(Mail, Tx, Mail)" method is called to change the correspondent "X" value of the redirected Mail object, using the value returned by "gexX(Mail)"; if such value is null, it does nothing.

Here follows the typical pattern of those methods:

 ...
 Tx x;
 ...
 protected boolean getX(Mail originalMail) throws MessagingException {
 boolean x = (isStatic()) ? this.x : getX();
 ...
 return x;
 }
 ...
 public void init() throws MessagingException {
 ...
 isStatic = (getInitParameter("static") == null) ? false : new Boolean(getInitParameter("static")).booleanValue();
 if(isStatic()) {
 ...
 X  = getX();
 ...
 }
 ...
 public void service(Mail originalMail) throws MessagingException {
 ...
 setX(newMail, getX(originalMail), originalMail);
 ...
 }
 ...
 

The isStatic variable and method is used to allow for the situations (deprecated since version 2.2, but possibly used by previoulsy written extensions to Redirect ) in which the getX() methods are non static: in this case AbstractRedirect.isStatic() must return false.
Finally, a "getX()" method may return a "special address" (see SpecialAddress ), that later will be resolved ("late bound") by a "getX(Mail)" or "setX(Mail, Tx, Mail)": it is a dynamic value that does not require isStatic to be false.

Supports by default the passThrough init parameter (false if missing). Subclasses can override this behaviour overriding AbstractRedirect.getPassThrough() .

Gets the static property.

Return true to reduce calls to getTo, getSender, getRecipients, getReplyTo, getReversePath amd getMessage where these values don't change (eg hard coded, or got at startup from the mailet config); return false where any of these methods generate their results dynamically eg in response to the message being processed, or by reference to a repository of users.

It is now (from version 2.2) somehow obsolete, as should be always true because the "good practice" is to use "getX()" methods statically, and use instead "getX(Mail)" methods for dynamic situations.

Sets the "Reply-To:" header of newMail to replyTo.

• BODY : original message body is attached as plain text to the new message
• HEADS : original message headers are attached as plain text to the new message
• ALL : original is attached as plain text with all headers
• MESSAGE : original message is attached as type message/rfc822, a complete mail message.
• NONE : original is not attached

• UNALTERED : original message is the new message body
• BODY : original message body is appended to the new message
• HEADS : original message headers are appended to the new message
• ALL : original is appended with all headers
• NONE : original is not appended

Gets the static property.

Return true to reduce calls to getTo, getSender, getRecipients, getReplyTo, getReversePath amd getMessage where these values don't change (eg hard coded, or got at startup from the mailet config); return false where any of these methods generate their results dynamically eg in response to the message being processed, or by reference to a repository of users.

It is now (from version 2.2) somehow obsolete, as should be always true because the "good practice" is to use "getX()" methods statically, and use instead "getX(Mail)" methods for dynamic situations. A false value is now meaningful only for subclasses of Redirect older than version 2.2 that were relying on this.

Is a "getX()" method.

Checks if a sender domain of mail is valid.

If we do not do this check, and someone uses a redirection mailet in a processor initiated by SenderInFakeDomain, then a fake sender domain will cause an infinite loop (the forwarded e-mail still appears to come from a fake domain).
Although this can be viewed as a configuration error, the consequences of such a mis-configuration are severe enough to warrant protecting against the infinite loop.

This check can be skipped if AbstractRedirect.getFakeDomainCheck(Mail) returns true.

Sets the "Reply-To:" header of newMail to replyTo.