/****************************************************************
* Licensed to the Apache Software Foundation (ASF) under one *
* or more contributor license agreements. See the NOTICE file *
* distributed with this work for additional information *
* regarding copyright ownership. The ASF licenses this file *
* to you under the Apache License, Version 2.0 (the *
* "License"); you may not use this file except in compliance *
* with the License. You may obtain a copy of the License at *
* *
* http://www.apache.org/licenses/LICENSE-2.0 *
* *
* Unless required by applicable law or agreed to in writing, *
* software distributed under the License is distributed on an *
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY *
* KIND, either express or implied. See the License for the *
* specific language governing permissions and limitations *
* under the License. *
****************************************************************/
package org.apache.james.transport.mailets;
import org.apache.mailet.MailAddress;
import javax.mail.MessagingException;
import javax.mail.internet.InternetAddress;
import java.util.Collection;
import java.util.HashSet;
/**
* <P>Replaces incoming recipients with those specified, and resends the message unaltered.</P>
* <P>Can be totally replaced by an equivalent usage of {@link Resend} (see below),
* simply replacing <I><forwardto></I> with <I><recipients></I>.
*
* <P>Sample configuration:</P>
* <PRE><CODE>
* <mailet match="All" class="Forward">
* <forwardTo><I>comma delimited list of email addresses</I></forwardTo>
* <passThrough><I>true or false, default=false</I></passThrough>
* <fakeDomainCheck><I>true or false, default=true</I></fakeDomainCheck>
* <debug><I>true or false, default=false</I></debug>
* </mailet>
* </CODE></PRE>
*
* <P>The behaviour of this mailet is equivalent to using Resend with the following
* configuration:</P>
* <PRE><CODE>
* <mailet match="All" class="Resend">
* <recipients>comma delimited list of email addresses</recipients>
* <passThrough>true or false</passThrough>
* <fakeDomainCheck><I>true or false</I></fakeDomainCheck>
* <debug><I>true or false</I></debug>
* </mailet>
* </CODE></PRE>
* <P><I>forwardto</I> can be used instead of
* <I>forwardTo</I>; such name is kept for backward compatibility.</P>
*
* @version CVS $Revision: 494012 $ $Date: 2007-01-08 11:23:58 +0100 (Mo, 08 Jan 2007) $
*/
public class Forward extends AbstractRedirect {
/**
* Return a string describing this mailet.
*
* @return a string describing this mailet
*/
public String getMailetInfo() {
return "Forward Mailet";
}
/** Gets the expected init parameters. */
protected String[] getAllowedInitParameters() {
String[] allowedArray = {
// "static",
"debug",
"passThrough",
"fakeDomainCheck",
"forwardto",
"forwardTo"
};
return allowedArray;
}
/* ******************************************************************** */
/* ****************** Begin of getX and setX methods ****************** */
/* ******************************************************************** */
/**
* @return UNALTERED
*/
protected int getInLineType() throws MessagingException {
return UNALTERED;
}
/**
* @return NONE
*/
protected int getAttachmentType() throws MessagingException {
return NONE;
}
/**
* @return ""
*/
protected String getMessage() throws MessagingException {
return "";
}
/**
* @return the <CODE>recipients</CODE> init parameter or null if missing
*/
protected Collection getRecipients() throws MessagingException {
Collection newRecipients = new HashSet();
String addressList = getInitParameter("forwardto",getInitParameter("forwardTo"));
// if nothing was specified, throw an exception
if (addressList == null) {
throw new MessagingException("Failed to initialize \"recipients\" list: no <forwardTo> or <forwardto> init parameter found");
}
try {
InternetAddress[] iaarray = InternetAddress.parse(addressList, false);
for (int i = 0; i < iaarray.length; i++) {
String addressString = iaarray[i].getAddress();
MailAddress specialAddress = getSpecialAddress(addressString,
new String[] {"postmaster", "sender", "from", "replyTo", "reversePath", "unaltered", "recipients", "to", "null"});
if (specialAddress != null) {
newRecipients.add(specialAddress);
} else {
newRecipients.add(new MailAddress(iaarray[i]));
}
}
} catch (Exception e) {
throw new MessagingException("Exception thrown in getRecipients() parsing: " + addressList, e);
}
if (newRecipients.size() == 0) {
throw new MessagingException("Failed to initialize \"recipients\" list; empty <recipients> init parameter found.");
}
return newRecipients;
}
/**
* @return null
*/
protected InternetAddress[] getTo() throws MessagingException {
return null;
}
/**
* @return null
*/
protected MailAddress getReplyTo() throws MessagingException {
return null;
}
/**
* @return null
*/
protected MailAddress getReversePath() throws MessagingException {
return null;
}
/**
* @return null
*/
protected MailAddress getSender() throws MessagingException {
return null;
}
/**
* @return null
*/
protected String getSubject() throws MessagingException {
return null;
}
/**
* @return ""
*/
protected String getSubjectPrefix() throws MessagingException {
return null;
}
/**
* @return false
*/
protected boolean attachError() {
return false;
}
/**
* @return false
*/
protected boolean isReply() throws MessagingException {
return false;
}
/* ******************************************************************** */
/* ******************* End of getX and setX methods ******************* */
/* ******************************************************************** */
}
|
