A mailet providing configurable redirection services
-*This mailet can produce listserver, forward and notify behaviour, with the original
-*message intact, attached, appended or left out altogether.
-*This built in functionality is controlled by the configuration as laid out below.
The configuration parameters are:
-*| <recipients> | -*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. -*It can include constants "sender", "postmaster" and "returnPath" |
-*
| <to> | -*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. -*The recipients list will be used if this is not supplied. -*It can include constants "sender", "postmaster", "returnPath" and "unaltered" |
-*
| <sender> | -*A single email address to appear in the From: header -*It can include constants "sender" and "postmaster" |
-*
| <message> | -*A text message to be the body of the email. Can be omitted. | -*
| <inline> | -*
-* One of the following items: -*
|
-*
| <attachment> | -*
-* One of the following items: -*
|
-*
| <passThrough> | -*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. | -*
| <attachError> | -*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) | -*
| <replyto> | -*A single email address to appear in the Reply-To: header, can -*also be "sender" or "postmaster", this header is not -*set if this is omitted. | -*
| <returnPath> | -*A single email address to appear in the Return-Path: header, can -*also be "sender" or "postmaster" or "null"; this header is not -*set if this parameter is omitted. | -*
| <prefix> | -*An optional subject prefix prepended to the original message
-*subject, for example: -*Undeliverable mail: |
-*
| <isReply> | -*TRUE or FALSE, if true the IN_REPLY_TO header will be set to the -*id of the current message. | -*
| <static> | -*
-* TRUE or FALSE. If this is TRUE it tells the mailet that it can -*reuse all the initial parameters (to, from, etc) without re-calculating -*their values. This will boost performance where a redirect task -*doesn't contain any dynamic values. If this is FALSE, it tells the -*mailet to recalculate the values for each e-mail processed. -*This defaults to false. |
-*
Example:
-* <mailet match="RecipientIs=test@localhost" class="Redirect">
-*<recipients>x@localhost, y@localhost, z@localhost</recipients>
-*<to>list@localhost</to>
-*<sender>owner@localhost</sender>
-*<message>sent on from James</message>
-*<inline>unaltered</inline>
-*<passThrough>FALSE</passThrough>
-*<replyto>postmaster</replyto>
-*<prefix xml:space="preserve">[test mailing] </prefix>
-*<!-- note the xml:space="preserve" to preserve whitespace -->
-*<static>TRUE</static>
-*</mailet>
-*
and:
-* <mailet match="All" class="Redirect">
-*<recipients>x@localhost</recipients>
-*<sender>postmaster</sender>
-*<message xml:space="preserve">Message marked as spam:
-*</message>
-*<inline>heads</inline>
-*<attachment>message</attachment>
-*<passThrough>FALSE</passThrough>
-*<attachError>TRUE</attachError>
-*<replyto>postmaster</replyto>
-*<prefix>[spam notification]</prefix>
-*<static>TRUE</static>
-*</mailet>
A mailet providing configurable redirection services
+ * This mailet can produce listserver, forward and notify behaviour, with the original
+ * message intact, attached, appended or left out altogether.
+ * This built in functionality is controlled by the configuration as laid out below.
The configuration parameters are:
+ *| <recipients> | + *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. + * It can include constants "sender", "postmaster" and "returnPath" |
+ *
| <to> | + *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. + * The recipients list will be used if this is not supplied. + * It can include constants "sender", "postmaster", "returnPath" and "unaltered" |
+ *
| <sender> | + *A single email address to appear in the From: header + * It can include constants "sender" and "postmaster" |
+ *
| <message> | + *A text message to be the body of the email. Can be omitted. | + *
| <inline> | + *
+ * One of the following items: + *
|
+ *
| <attachment> | + *
+ * One of the following items: + *
|
+ *
| <passThrough> | + *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. The default is false. | + *
| <fakeDomainCheck> | + *TRUE or FALSE, if true will check if the sender domain is valid. + * The default is true. | + *
| <attachError> | + *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) | + *
| <replyto> | + *A single email address to appear in the Reply-To: header, can + * also be "sender" or "postmaster", this header is not + * set if this is omitted. | + *
| <returnPath> | + *A single email address to appear in the Return-Path: header, can + * also be "sender" or "postmaster" or "null"; this header is not + * set if this parameter is omitted. | + *
| <prefix> | + *An optional subject prefix prepended to the original message
+ * subject, for example: + * Undeliverable mail: |
+ *
| <isReply> | + *TRUE or FALSE, if true the IN_REPLY_TO header will be set to the + * id of the current message. | + *
| <static> | + *
+ * TRUE or FALSE. If this is TRUE it tells the mailet that it can + * reuse all the initial parameters (to, from, etc) without re-calculating + * their values. This will boost performance where a redirect task + * doesn't contain any dynamic values. If this is FALSE, it tells the + * mailet to recalculate the values for each e-mail processed. + *This defaults to false. |
+ *
Example:
+ * <mailet match="RecipientIs=test@localhost" class="Redirect">
+ * <recipients>x@localhost, y@localhost, z@localhost</recipients>
+ * <to>list@localhost</to>
+ * <sender>owner@localhost</sender>
+ * <message>sent on from James</message>
+ * <inline>unaltered</inline>
+ * <passThrough>FALSE</passThrough>
+ * <replyto>postmaster</replyto>
+ * <prefix xml:space="preserve">[test mailing] </prefix>
+ * <!-- note the xml:space="preserve" to preserve whitespace -->
+ * <static>TRUE</static>
+ * </mailet>
+ *
and:
+ * <mailet match="All" class="Redirect">
+ * <recipients>x@localhost</recipients>
+ * <sender>postmaster</sender>
+ * <message xml:space="preserve">Message marked as spam:
+ * </message>
+ * <inline>heads</inline>
+ * <attachment>message</attachment>
+ * <passThrough>FALSE</passThrough>
+ * <attachError>TRUE</attachError>
+ * <replyto>postmaster</replyto>
+ * <prefix>[spam notification]</prefix>
+ * <static>TRUE</static>
+ * </mailet>
CVS $Id$
+ * @version 2.2.0 */ public class Redirect extends AbstractRedirect { Index: src/java/org/apache/james/transport/mailets/AbstractNotify.java =================================================================== RCS file: /home/cvspublic/jakarta-james/src/java/org/apache/james/transport/mailets/AbstractNotify.java,v retrieving revision 1.1.2.3 diff -u -r1.1.2.3 AbstractNotify.java --- src/java/org/apache/james/transport/mailets/AbstractNotify.java 6 Jun 2003 23:55:04 -0000 1.1.2.3 +++ src/java/org/apache/james/transport/mailets/AbstractNotify.java 8 Jun 2003 18:26:41 -0000 @@ -96,7 +96,7 @@ * is set to true, such error message will be attached to the notification message. *passThrough init parameter (true if missing).Sample configuration common to all notification mailet subclasses:
@@ -105,9 +105,19 @@ * <sendingAddress>an address or postmaster</sendingAddress> * <attachStackTrace>true or false, default=false</attachStackTrace> * <notice>notice attached to the message (optional)</notice> + * <prefix>optional subject prefix prepended to the original message</prefix> + * <inline>see {@link Redirect}, default=none</inline> + * <attachment>see {@link Redirect}, default=message</attachment> + * <passThrough>true or false, default=true</passThrough> + * <fakeDomainCheck>true or false, default=true</fakeDomainCheck> * </mailet> * + * message and attachError can be used instead of + * notice and and attachStackTrace. * + *CVS $Id$
+ * @version 2.2.0 + * @since 2.2.0 */ public abstract class AbstractNotify extends AbstractRedirect { @@ -116,32 +126,49 @@ /* ******************************************************************** */ /** - * @return true, as all notifications should + * @return thepassThrough init parameter, or true if missing
*/
protected boolean getPassThrough() throws MessagingException {
- return true;
+ if(getInitParameter("passThrough") == null) {
+ return true;
+ } else {
+ return new Boolean(getInitParameter("passThrough")).booleanValue();
+ }
}
/**
- * @return NONE
+ * @return the inline init parameter, or NONE if missing
*/
- protected int getInLineType() {
- return NONE;
+ protected int getInLineType() throws MessagingException {
+ if(getInitParameter("inline") == null) {
+ return NONE;
+ } else {
+ return getTypeCode(getInitParameter("inline"));
+ }
}
/**
- * @return MESSAGE
+ * @return the attachment init parameter, or MESSAGE if missing
*/
- protected int getAttachmentType() {
- return MESSAGE;
+ protected int getAttachmentType() throws MessagingException {
+ if(getInitParameter("attachment") == null) {
+ return MESSAGE;
+ } else {
+ return getTypeCode(getInitParameter("attachment"));
+ }
}
/**
- * @return the notice init parameter
+ * @return the notice init parameter, or the message init parameter if missing,
+ * or a default string if both are missing
*/
protected String getMessage() {
if(getInitParameter("notice") == null) {
- return "We were unable to deliver the attached message because of an error in the mail server.";
+ if(getInitParameter("message") == null) {
+ return "We were unable to deliver the attached message because of an error in the mail server.";
+ } else {
+ return getInitParameter("message");
+ }
} else {
return getInitParameter("notice");
}
@@ -225,14 +252,32 @@
}
/**
- * @return the attachStackTrace init parameter
+ * @return the prefix init parameter or an empty string if missing
+ */
+ protected String getSubjectPrefix() throws MessagingException {
+ if(getInitParameter("prefix") == null) {
+ return "";
+ } else {
+ return getInitParameter("prefix");
+ }
+ }
+
+ /**
+ * @return the attachStackTrace init parameter,
+ * or the attachError init parameter if missing,
+ * or false if missing
*/
protected boolean attachError() {
boolean attachStackTrace = false;
try {
attachStackTrace = new Boolean(getInitParameter("attachStackTrace")).booleanValue();
} catch (Exception e) {
- // Ignore exception, default to false
+ // try with attachError
+ try {
+ attachStackTrace = new Boolean(getInitParameter("attachError")).booleanValue();
+ } catch (Exception e2) {
+ // Ignore exception, default to false
+ }
}
return attachStackTrace;
}
Index: src/java/org/apache/james/transport/mailets/AbstractRedirect.java
===================================================================
RCS file: /home/cvspublic/jakarta-james/src/java/org/apache/james/transport/mailets/AbstractRedirect.java,v
retrieving revision 1.1.2.6
diff -u -r1.1.2.6 AbstractRedirect.java
--- src/java/org/apache/james/transport/mailets/AbstractRedirect.java 6 Jun 2003 23:55:04 -0000 1.1.2.6
+++ src/java/org/apache/james/transport/mailets/AbstractRedirect.java 8 Jun 2003 18:26:42 -0000
@@ -107,6 +107,7 @@
* For each of the methods above (generically called "getX()" methods in this class @@ -161,6 +162,9 @@ *
Supports by default the passThrough init parameter (false if missing).
* Subclasses can override this behaviour overriding {@link #getPassThrough()}.
CVS $Id$
+ * @version 2.2.0 + * @since 2.2.0 */ public abstract class AbstractRedirect extends GenericMailet { @@ -229,6 +233,7 @@ protected static final int MESSAGE = 5; private boolean passThrough = false; + private boolean fakeDomainCheck = true; private int attachmentType = NONE; private int inLineType = BODY; private String messageText; @@ -294,6 +299,33 @@ } /** + * Gets thefakeDomainCheck property.
+ * Return true to check if the sender domain is valid.
+ * Is a "getX()" method.
+ *
+ * @return the fakeDomainCheck init parameter, or true if missing
+ */
+ protected boolean getFakeDomainCheck() throws MessagingException {
+ if(getInitParameter("fakeDomainCheck") == null) {
+ return true;
+ } else {
+ return new Boolean(getInitParameter("fakeDomainCheck")).booleanValue();
+ }
+ }
+
+ /**
+ * Gets the fakeDomainCheck property,
+ * built dynamically using the original Mail object.
+ * Is a "getX(Mail)" method.
+ *
+ * @return {@link #getFakeDomainCheck()}
+ */
+ protected boolean getFakeDomainCheck(Mail originalMail) throws MessagingException {
+ boolean fakeDomainCheck = (isStatic()) ? this.fakeDomainCheck : getFakeDomainCheck();
+ return fakeDomainCheck;
+ }
+
+ /**
* Gets the inline property.
* May return one of the following values to indicate how to append the original message
* to build the new message:
@@ -736,6 +768,7 @@
if(isStatic()) {
passThrough = getPassThrough();
+ fakeDomainCheck = getFakeDomainCheck();
attachmentType = getAttachmentType();
inLineType = getInLineType();
messageText = getMessage();
@@ -752,6 +785,7 @@
new StringBuffer(1024)
.append("static")
.append(", passThrough=").append(passThrough)
+ .append(", fakeDomainCheck=").append(fakeDomainCheck)
.append(", sender=").append(sender)
.append(", replyTo=").append(replyTo)
.append(", returnPath=").append(returnPath)
@@ -1254,8 +1288,11 @@
* 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 {@link #getFakeDomainCheck(Mail)} returns true.
*/ - protected final boolean senderDomainIsValid(Mail mail) { - return mail.getSender() == null || getMailetContext().getMailServers(mail.getSender().getHost()).size() != 0; + protected final boolean senderDomainIsValid(Mail mail) throws MessagingException { + if (getFakeDomainCheck(mail)) { + return mail.getSender() == null || getMailetContext().getMailServers(mail.getSender().getHost()).size() != 0; + } else return true; } } Index: src/java/org/apache/james/transport/mailets/Bounce.java =================================================================== RCS file: /home/cvspublic/jakarta-james/src/java/org/apache/james/transport/mailets/Bounce.java,v retrieving revision 1.1.2.3 diff -u -r1.1.2.3 Bounce.java --- src/java/org/apache/james/transport/mailets/Bounce.java 6 Jun 2003 23:55:04 -0000 1.1.2.3 +++ src/java/org/apache/james/transport/mailets/Bounce.java 8 Jun 2003 18:26:42 -0000 @@ -98,14 +98,19 @@ * If the notified message has an "error message" set, it will be inserted into the * notification inline text. If theattachStackTrace init parameter
* is set to true, such error message will be attached to the notification message.passThrough is true.
+ *Supports the passThrough init parameter (true if missing).
Sample configuration:
*
- * <mailet match="All" class="NotifyPostmaster">
+ * <mailet match="All" class="Bounce">
* <sendingAddress>an address or postmaster</sendingAddress>
* <attachStackTrace>true or false, default=false</attachStackTrace>
* <notice>notice attached to the message (optional)</notice>
+ * <prefix>optional subject prefix prepended to the original message</prefix>
+ * <inline>see {@link Redirect}, default=none</inline>
+ * <attachment>see {@link Redirect}, default=message</attachment>
+ * <passThrough>true or false, default=true</passThrough>
+ * <fakeDomainCheck>true or false, default=true</fakeDomainCheck>
* </mailet>
* CVS $Id$
+ * @version 2.2.0 + * @since 2.2.0 */ public class Bounce extends AbstractNotify { Index: src/java/org/apache/james/transport/mailets/Forward.java =================================================================== RCS file: /home/cvspublic/jakarta-james/src/java/org/apache/james/transport/mailets/Forward.java,v retrieving revision 1.6.4.4 diff -u -r1.6.4.4 Forward.java --- src/java/org/apache/james/transport/mailets/Forward.java 6 Jun 2003 23:55:04 -0000 1.6.4.4 +++ src/java/org/apache/james/transport/mailets/Forward.java 8 Jun 2003 18:26:42 -0000 @@ -83,11 +83,14 @@ *
* <mailet match="All" class="Redirect">
* <passThrough>true or false</passThrough>
+ * <fakeDomainCheck>true or false, default=true</fakeDomainCheck>
* <recipients>comma delimited list of email addresses</recipients>
* <inline>unaltered</inline>
* </mailet>
* CVS $Id$
+ * @version 2.2.0 */ public class Forward extends AbstractRedirect { Index: src/java/org/apache/james/transport/mailets/NotifyPostmaster.java =================================================================== RCS file: /home/cvspublic/jakarta-james/src/java/org/apache/james/transport/mailets/NotifyPostmaster.java,v retrieving revision 1.9.4.5 diff -u -r1.9.4.5 NotifyPostmaster.java --- src/java/org/apache/james/transport/mailets/NotifyPostmaster.java 6 Jun 2003 23:55:04 -0000 1.9.4.5 +++ src/java/org/apache/james/transport/mailets/NotifyPostmaster.java 8 Jun 2003 18:26:42 -0000 @@ -93,14 +93,19 @@ * is set to true, such error message will be attached to the notification message.passThrough is true.
+ *Supports the passThrough init parameter (true if missing).
Sample configuration:
*
* <mailet match="All" class="NotifyPostmaster">
- * <sendingAddress>an address or postmaster or sender, default=postmaster</sendingAddress>
+ * <sendingAddress>an address or postmaster</sendingAddress>
* <attachStackTrace>true or false, default=false</attachStackTrace>
* <notice>notice attached to the message (optional)</notice>
+ * <prefix>optional subject prefix prepended to the original message, default="Re:"</prefix>
+ * <inline>see {@link Redirect}, default=none</inline>
+ * <attachment>see {@link Redirect}, default=message</attachment>
+ * <passThrough>true or false, default=true</passThrough>
+ * <fakeDomainCheck>true or false, default=true</fakeDomainCheck>
* <to>unaltered (optional, defaults to postmaster)</to>
* </mailet>
* CVS $Id$
+ * @version 2.2.0 */ public class NotifyPostmaster extends AbstractNotify { @@ -166,10 +175,14 @@ } /** - * @return "Re:" + * @return theprefix init parameter or "Re:" if missing
*/
protected String getSubjectPrefix() {
- return "Re:";
+ if(getInitParameter("prefix") == null) {
+ return "Re:";
+ } else {
+ return getInitParameter("prefix");
+ }
}
/**
Index: src/java/org/apache/james/transport/mailets/NotifySender.java
===================================================================
RCS file: /home/cvspublic/jakarta-james/src/java/org/apache/james/transport/mailets/NotifySender.java,v
retrieving revision 1.10.4.6
diff -u -r1.10.4.6 NotifySender.java
--- src/java/org/apache/james/transport/mailets/NotifySender.java 6 Jun 2003 23:55:04 -0000 1.10.4.6
+++ src/java/org/apache/james/transport/mailets/NotifySender.java 8 Jun 2003 18:26:42 -0000
@@ -93,7 +93,7 @@
* is set to true, such error message will be attached to the notification message.passThrough is true.
+ *Supports the passThrough init parameter (true if missing).
Sample configuration:
*
@@ -101,6 +101,11 @@
* <sendingAddress>an address or postmaster</sendingAddress>
* <attachStackTrace>true or false, default=false</attachStackTrace>
* <notice>notice attached to the message (optional)</notice>
+ * <prefix>optional subject prefix prepended to the original message</prefix>
+ * <inline>see {@link Redirect}, default=none</inline>
+ * <attachment>see {@link Redirect}, default=message</attachment>
+ * <passThrough>true or false, default=true</passThrough>
+ * <fakeDomainCheck>true or false, default=true</fakeDomainCheck>
* <to>unaltered (optional, defaults to sender)</to>
* </mailet>
* CVS $Id$
+ * @version 2.2.0 */ public class NotifySender extends AbstractNotify {