|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.turbine.util.mail.Email
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
|
protected java.lang.String |
charset
The charset to use for this message |
static java.lang.String |
CONTENT_TYPE
|
static java.lang.String |
EMAIL_BODY
|
static java.lang.String |
EMAIL_SUBJECT
|
static java.lang.String |
FILE_SERVER
|
static java.lang.String |
ISO_8859_1
|
static java.lang.String |
KOI8_R
|
static java.lang.String |
MAIL_HOST
|
static java.lang.String |
MAIL_SERVER
|
static java.lang.String |
MAIL_SMTP_FROM
|
static java.lang.String |
MAIL_TRANSPORT_PROTOCOL
|
protected javax.mail.internet.MimeMessage |
message
The email message to send. |
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
|
static java.lang.String |
US_ASCII
|
Constructor Summary | |
Email()
|
Method Summary | |
Email |
addBcc(java.lang.String email,
java.lang.String name)
Add a blind BCC recipient 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. |
protected void |
initCriteria(org.apache.torque.util.Criteria criteria)
Initialize the mail according to the Criteria. |
protected void |
initialize(org.apache.torque.util.Criteria criteria)
Initializes the mail. |
void |
send()
Does the work of actually sending the email. |
void |
setCharset(java.lang.String charset)
Set the charset of the message. |
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 |
public static final java.lang.String SENDER_EMAIL
public static final java.lang.String SENDER_NAME
public static final java.lang.String RECEIVER_EMAIL
public static final java.lang.String RECEIVER_NAME
public static final java.lang.String EMAIL_SUBJECT
public static final java.lang.String EMAIL_BODY
public static final java.lang.String CONTENT_TYPE
public static final java.lang.String MAIL_SERVER
public static final java.lang.String MAIL_HOST
public static final java.lang.String MAIL_SMTP_FROM
public static final java.lang.String MAIL_TRANSPORT_PROTOCOL
public static final java.lang.String SMTP
public static final java.lang.String TEXT_HTML
public static final java.lang.String TEXT_PLAIN
public static final java.lang.String ATTACHMENTS
public static final java.lang.String FILE_SERVER
public static final java.lang.String KOI8_R
public static final java.lang.String ISO_8859_1
public static final java.lang.String US_ASCII
protected javax.mail.internet.MimeMessage message
protected java.lang.String charset
Constructor Detail |
public Email()
Method Detail |
public void setCharset(java.lang.String charset)
charset
- A String.protected void initialize(org.apache.torque.util.Criteria criteria) throws javax.mail.MessagingException
criteria
- A Criteria.MessagingException.
- init.
protected void init() throws javax.mail.MessagingException
This is the first method that should be called by a subclass in its constructor.
MessagingException.
- protected void initCriteria(org.apache.torque.util.Criteria criteria) throws javax.mail.MessagingException
This method uses the criteria parameter to set the from, to and subject fields of the email. Deprecated; one should use the setFrom, addTo, etc. methods.
criteria
- A Criteria.MessagingException.
- public Email setFrom(java.lang.String email, java.lang.String name) throws javax.mail.MessagingException
email
- A String.name
- A String.MessagingException.
- public Email addTo(java.lang.String email, java.lang.String name) throws javax.mail.MessagingException
email
- A String.name
- A String.MessagingException.
- public Email addCc(java.lang.String email, java.lang.String name) throws javax.mail.MessagingException
email
- A String.name
- A String.MessagingException.
- public Email addBcc(java.lang.String email, java.lang.String name) throws javax.mail.MessagingException
email
- A String.name
- A String.MessagingException.
- public Email addReplyTo(java.lang.String email, java.lang.String name) throws javax.mail.MessagingException
email
- A String.name
- A String.MessagingException.
- public Email setSubject(java.lang.String subject) throws javax.mail.MessagingException
subject
- A String.MessagingException.
- public Email setSentDate(java.util.Date date) throws javax.mail.MessagingException
date
- A Date.MessagingException.
- public abstract Email setMsg(java.lang.String msg) throws javax.mail.MessagingException
msg
- A String.MessagingException.
- public void send() throws javax.mail.MessagingException
MessagingException,
- if there was an error.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |