org.apache.turbine.util.mail
Class Email

java.lang.Object
  |
  +--org.apache.turbine.util.mail.Email

Direct Known Subclasses:

SimpleEmail

public abstract class Email

extends java.lang.Object

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.

Field Summary

static java.lang.String	ATTACHMENTS
static java.lang.String	EMAIL_BODY
static java.lang.String	EMAIL_SUBJECT
static java.lang.String	FILE_SERVER
static java.lang.String	MAIL_HOST
static java.lang.String	MAIL_SERVER
static java.lang.String	MAIL_TRANSPORT_PROTOCOL
static java.lang.String	RECEIVER_EMAIL
static java.lang.String	RECEIVER_NAME
static java.lang.String	SENDER_EMAIL Constants used to Email classes.
static java.lang.String	SENDER_NAME
static java.lang.String	SMTP
static java.lang.String	TEXT_HTML
static java.lang.String	TEXT_PLAIN

Constructor Summary

Email()

Method Summary

Email	addBcc(java.lang.String email, java.lang.String name) Add a blind CC repcipient to the email
Email	addCc(java.lang.String email, java.lang.String name) Add a recipient CC to the email
Email	addReplyTo(java.lang.String email, java.lang.String name) Add a reply to address to the email
Email	addTo(java.lang.String email, java.lang.String name) Add a recipient TO to the email
protected void	init() Initializes the mail.
void	send() Does the work of actually sending the email.
Email	setFrom(java.lang.String email, java.lang.String name) Set the FROM field of the email
abstract Email	setMsg(java.lang.String msg) Define the content of the mail
Email	setSentDate(java.util.Date date) Set the sent date field
Email	setSubject(java.lang.String subject) Set the email subject

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SENDER_EMAIL

public static final java.lang.String SENDER_EMAIL

Constants used to Email classes.

SENDER_NAME

public static final java.lang.String SENDER_NAME

RECEIVER_EMAIL

public static final java.lang.String RECEIVER_EMAIL

RECEIVER_NAME

public static final java.lang.String RECEIVER_NAME

EMAIL_SUBJECT

public static final java.lang.String EMAIL_SUBJECT

EMAIL_BODY

public static final java.lang.String EMAIL_BODY

MAIL_SERVER

public static final java.lang.String MAIL_SERVER

MAIL_HOST

public static final java.lang.String MAIL_HOST

MAIL_TRANSPORT_PROTOCOL

public static final java.lang.String MAIL_TRANSPORT_PROTOCOL

SMTP

public static final java.lang.String SMTP

TEXT_HTML

public static final java.lang.String TEXT_HTML

TEXT_PLAIN

public static final java.lang.String TEXT_PLAIN

ATTACHMENTS

public static final java.lang.String ATTACHMENTS

FILE_SERVER

public static final java.lang.String FILE_SERVER

Constructor Detail

Email

public Email()

Method Detail

init

protected void init()
             throws javax.mail.MessagingException

Initializes the mail.

This is the first method that should be called by a sublasse in its constructor;

setFrom

public Email setFrom(java.lang.String email,
                     java.lang.String name)
              throws javax.mail.MessagingException

Set the FROM field of the email

addTo

public Email addTo(java.lang.String email,
                   java.lang.String name)
            throws javax.mail.MessagingException

Add a recipient TO to the email

addCc

public Email addCc(java.lang.String email,
                   java.lang.String name)
            throws javax.mail.MessagingException

Add a recipient CC to the email

addBcc

public Email addBcc(java.lang.String email,
                    java.lang.String name)
             throws javax.mail.MessagingException

Add a blind CC repcipient to the email

addReplyTo

public Email addReplyTo(java.lang.String email,
                        java.lang.String name)
                 throws javax.mail.MessagingException

Add a reply to address to the email

setSubject

public Email setSubject(java.lang.String subject)
                 throws javax.mail.MessagingException

Set the email subject

setSentDate

public Email setSentDate(java.util.Date date)
                  throws javax.mail.MessagingException

Set the sent date field

setMsg

public abstract Email setMsg(java.lang.String msg)
                      throws javax.mail.MessagingException

Define the content of the mail

should be overidden by the sublcasses

send

public void send()
          throws javax.mail.MessagingException

Does the work of actually sending the email.

Throws:

javax.mail.MessagingException - if an error