package org.apache.turbine.util.mail; /* ==================================================================== * The Apache Software License, Version 1.1 * * Copyright (c) 2001 The Apache Software Foundation. All rights * reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in * the documentation and/or other materials provided with the * distribution. * * 3. The end-user documentation included with the redistribution, * if any, must include the following acknowledgment: * "This product includes software developed by the * Apache Software Foundation (http://www.apache.org/)." * Alternately, this acknowledgment may appear in the software itself, * if and wherever such third-party acknowledgments normally appear. * * 4. The names "Apache" and "Apache Software Foundation" and * "Apache Turbine" must not be used to endorse or promote products * derived from this software without prior written permission. For * written permission, please contact apache@apache.org. * * 5. Products derived from this software may not be called "Apache", * "Apache Turbine", nor may "Apache" appear in their name, without * prior written permission of the Apache Software Foundation. * * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * SUCH DAMAGE. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . */ import java.util.Date; import java.util.Hashtable; import java.util.Properties; import java.util.ArrayList; import java.util.Enumeration; import java.util.Collection; import javax.mail.Address; import javax.mail.Authenticator; import javax.mail.Message; import javax.mail.MessagingException; import javax.mail.Session; import javax.mail.Transport; import javax.mail.internet.InternetAddress; import javax.mail.internet.MimeMessage; import javax.mail.internet.MimeMultipart; /** * The base class for all email messages. This class sets the * sender's email & name, receiver's email & name, subject, and the * sent date. Subclasses are responsible for setting the message * body. * * @author Colin Chalmers * @author Jon S. Stevens * @author Frank Y. Kim * @author Brett McLaughlin * @author Greg Ritter * @author Regis Koenig * @version $Id: Email.java,v 1.3 2001/07/14 21:29:32 jvanzyl Exp $ */ public abstract class Email { /** Constants used to Email classes. */ public static final String SENDER_EMAIL = "sender.email"; public static final String SENDER_NAME = "sender.name"; public static final String RECEIVER_EMAIL = "receiver.email"; public static final String RECEIVER_NAME = "receiver.name"; public static final String EMAIL_SUBJECT = "email.subject"; public static final String EMAIL_BODY = "email.body"; public static final String CONTENT_TYPE = "content.type"; public static final String MAIL_SERVER = "mail.server"; public static final String MAIL_HOST = "mail.host"; public static final String MAIL_SMTP_FROM = "mail.smtp.from"; public static final String MAIL_TRANSPORT_PROTOCOL = "mail.transport.protocol"; public static final String SMTP = "SMTP"; public static final String TEXT_HTML = "text/html"; public static final String TEXT_PLAIN = "text/plain"; public static final String ATTACHMENTS = "attachments"; public static final String FILE_SERVER = "file.server"; public static final String KOI8_R = "koi8-r"; public static final String ISO_8859_1 = "iso-8859-1"; public static final String US_ASCII = "us-ascii"; /** The email message to send. */ protected MimeMessage message = null; /** The Session class represents a mail session */ private Session session = null; /** The charset to use for this message */ protected String charset = null; /** The Address of the sending party, mandatory */ private InternetAddress fromAddress = null; /** The Subject */ private String subject = null; /** An attachment */ private MimeMultipart emailBody = null; /** The content */ private Object content = null; /** The content type */ private String contentType = null; /** * The hostname of the mail server with which to connect. If null will try to get * property from system.properties. If still null, quit */ private String hostName = null; /** Lists of related email adresses */ private ArrayList toList = null; private ArrayList ccList = null; private ArrayList bccList = null; private ArrayList replyList = null; /** * Used to specify the mail headers. Example: * * X-Mailer: Sendmail, X-Priority: 1(highest) * or 2(high) 3(normal) 4(low) and 5(lowest) * Disposition-Notification-To: returnR user@domain.net */ private Hashtable headers = null; /** * Setting to true will enable the display of debug information. * * @param d A boolean. */ public void setDebug(boolean d) { session.setDebug(d); } /** * Set the charset of the message. * * @param charset A String. */ public void setCharset(String charset) { this.charset = charset; } /** * Set the emailBody to a MimeMultiPart * * @param aMimeMultipart */ public void setContent(MimeMultipart aMimeMultipart) { this.emailBody = aMimeMultipart; } /** * Set the content & contentType * * @param aObject * @param aContentType */ public void setContent(Object aObject, String aContentType) { this.content = aObject; this.contentType = aContentType; } /** * Set the hostname * * @param aHostName */ public void setHostName(String aHostName) { this.hostName = aHostName; } /** * Initialise a mailsession object * * @return A Session. */ private Session getMailSession() throws MessagingException { Properties properties = System.getProperties(); properties.put ( MAIL_TRANSPORT_PROTOCOL, SMTP ); if (hostName == null) { hostName = properties.getProperty(MAIL_HOST); } if (hostName == null) { throw new MessagingException("Cannot find valid hostname to mail session"); } properties.put ( MAIL_HOST, hostName ); return Session.getDefaultInstance(properties, null); } /** * Set the FROM field of the email. * * @param email A String. * @param name A String. * @return An Email. * @exception MessagingException. */ public Email setFrom(String email, String name ) throws MessagingException { try { if (( name == null) || (name.trim().equals("")) ) { name = email; } if (fromAddress == null) { fromAddress = new InternetAddress( email, name ); } else { fromAddress.setAddress(email); fromAddress.setPersonal(name); } } catch( Exception e ) { throw new MessagingException("cannot set from", e); } return this; } /** * Add a recipient TO to the email. * * @param email A String. * @param name A String. * @return An Email. * @exception MessagingException. */ public Email addTo(String email, String name ) throws MessagingException { try { if (( name == null) || (name.trim().equals("")) ) { name = email; } if (toList == null) { toList = new ArrayList(); } toList.add( new InternetAddress( email, name ) ); } catch( Exception e ) { throw new MessagingException("cannot add to", e); } return this; } /** * Set a list of "TO" addresses * * @param aCollection * @return */ public Email setTo(Collection aCollection) { toList = new ArrayList(aCollection); return this; } /** * Add a recipient CC to the email. * * @param email A String. * @param name A String. * @return An Email. * @exception MessagingException. */ public Email addCc(String email, String name ) throws MessagingException { try { if (( name == null) || (name.trim().equals("")) ) { name = email; } if (ccList == null) { ccList = new ArrayList(); } ccList.add( new InternetAddress( email, name ) ); } catch( Exception e ) { throw new MessagingException("cannot add cc", e); } return this; } /** * Set a list of "CC" addresses * * @param aCollection * @return An Email. */ public Email setCc(Collection aCollection) { ccList = new ArrayList(aCollection); return this; } /** * Add a blind BCC recipient to the email. * * @param email A String. * @param name A String. * @return An Email. * @exception MessagingException. */ public Email addBcc(String email, String name ) throws MessagingException { try { if (( name == null) || (name.trim().equals("")) ) { name = email; } if (bccList == null) { bccList = new ArrayList(); } bccList.add( new InternetAddress( email, name ) ); } catch( Exception e ) { throw new MessagingException("cannot add bcc", e); } return this; } /** * Set a list of "BCC" addresses * * @param aCollection * @return */ public Email setBcc(Collection aCollection) { bccList = new ArrayList(aCollection); return this; } /** * Add a reply to address to the email. * * @param email A String. * @param name A String. * @return An Email. * @exception MessagingException. */ public Email addReplyTo(String email, String name ) throws MessagingException { try { if (( name == null) || (name.trim().equals("")) ) { name = email; } if (replyList == null) { replyList = new ArrayList(); } replyList.add( new InternetAddress( email, name ) ); } catch( Exception e ) { throw new MessagingException("cannot add replyTo", e); } return this; } /** * Used to specify the mail headers. Example: * * X-Mailer: Sendmail, X-Priority: 1(highest) * or 2(high) 3(normal) 4(low) and 5(lowest) * Disposition-Notification-To: returnR user@domain.net * * @param h A Hashtable. */ public void setHeaders(Hashtable h) { headers = h; } /** * Adds a header (name, value) to the headers Hashtable. * * @param name A String with the name. * @param value A String with the value. */ public void addHeader(String name, String value) { if (headers == null) { headers = new Hashtable(); } headers.put(name,value); } /** * Set the email subject. * * @param subject A String. * @return An Email. * @exception MessagingException. */ public Email setSubject( String aSubject ) throws MessagingException { subject = aSubject; return this; } /** * Define the content of the mail. It should be overidden by the * subclasses. * * @param msg A String. * @return An Email. * @exception MessagingException. */ public abstract Email setMsg(String msg) throws MessagingException; /** * Does the work of actually sending the email. * * @exception MessagingException, if there was an error. */ public void send() throws MessagingException { MimeMessage message = new MimeMessage( getMailSession() ); // Set the sent date. message.setSentDate( new Date() ); if (subject != null) { message.setSubject(subject); } if (content != null) { message.setContent(content, contentType); } else if (emailBody != null) { message.setContent(emailBody); } if (fromAddress != null) { message.setFrom(fromAddress); } else { throw new MessagingException("Sender address required"); } if (toList != null) { message.setRecipients(Message.RecipientType.TO, toInternetAddressArray(toList)); } else { throw new MessagingException("At least one receiver address required"); } if (ccList != null) { message.setRecipients(Message.RecipientType.CC, toInternetAddressArray(ccList)); } if (bccList != null) { message.setRecipients(Message.RecipientType.BCC, toInternetAddressArray(bccList)); } if (replyList != null) { message.setReplyTo(toInternetAddressArray(replyList)); } if (headers != null) { Enumeration e = headers.keys(); while (e.hasMoreElements()) { String name = (String)e.nextElement(); String value = (String)headers.get(name); message.addHeader(name, value); } } Transport.send( message ); } /** * Utility to copy ArrayList of known InternetAddress objects into an * array. * * @param v A ArrayList. * @return An InternetAddress[]. */ private InternetAddress[] toInternetAddressArray(ArrayList aList) { InternetAddress[] ia = (InternetAddress[])aList.toArray(new InternetAddress[0]); return ia; } }