|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.commons.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 javax.mail.Authenticator |
authenticator
Instance of an Authenticator object that will be used
when authentication is requested from the mail server. |
protected java.util.List |
bccList
List of "bcc" email adresses |
protected java.lang.String |
bounceAddress
Address to which undeliverable mail should be sent. |
protected java.util.List |
ccList
List of "cc" email adresses |
protected java.lang.String |
charset
The charset to use for this message |
protected java.lang.Object |
content
The content |
static java.lang.String |
CONTENT_TYPE
|
protected java.lang.String |
contentType
The content type |
protected boolean |
debug
Set session debugging on or off |
static java.lang.String |
EMAIL_BODY
|
static java.lang.String |
EMAIL_SUBJECT
|
protected javax.mail.internet.MimeMultipart |
emailBody
An attachment |
static java.lang.String |
FILE_SERVER
|
protected javax.mail.internet.InternetAddress |
fromAddress
The Address of the sending party, mandatory |
protected java.util.Map |
headers
Used to specify the mail headers. |
protected java.lang.String |
hostName
The hostname of the mail server with which to connect. |
static java.lang.String |
ISO_8859_1
|
static java.lang.String |
KOI8_R
|
static java.lang.String |
MAIL_DEBUG
|
static java.lang.String |
MAIL_HOST
|
static java.lang.String |
MAIL_PORT
|
static java.lang.String |
MAIL_SMTP_AUTH
|
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. |
protected boolean |
popBeforeSmtp
Used to determine whether to use pop3 before smtp, and if so the settings. |
protected java.lang.String |
popHost
the host name of the pop3 server |
protected java.lang.String |
popPassword
the password to log into the pop3 server |
protected java.lang.String |
popUsername
the user name to log into the pop3 server |
static java.lang.String |
RECEIVER_EMAIL
|
static java.lang.String |
RECEIVER_NAME
|
protected java.util.List |
replyList
List of "replyTo" email adresses |
static java.lang.String |
SENDER_EMAIL
|
static java.lang.String |
SENDER_NAME
|
protected java.util.Date |
sentDate
Sent date |
static java.lang.String |
SMTP
|
protected java.lang.String |
smtpPort
The port number of the mail server to connect to. |
protected java.lang.String |
subject
The Subject |
static java.lang.String |
TEXT_HTML
|
static java.lang.String |
TEXT_PLAIN
|
protected java.util.List |
toList
List of "to" email adresses |
static java.lang.String |
US_ASCII
|
Constructor Summary | |
Email()
|
Method Summary | |
Email |
addBcc(java.lang.String email)
Add a blind BCC recipient to the email. |
Email |
addBcc(java.lang.String email,
java.lang.String name)
Add a blind BCC recipient to the email. |
Email |
addCc(java.lang.String email)
Add a recipient CC to the email. |
Email |
addCc(java.lang.String email,
java.lang.String name)
Add a recipient CC to the email. |
void |
addHeader(java.lang.String name,
java.lang.String value)
Adds a header ( name, value ) to the headers Map. |
Email |
addReplyTo(java.lang.String email)
Add a reply to address 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)
Add a recipient TO to the email. |
Email |
addTo(java.lang.String email,
java.lang.String name)
Add a recipient TO to the email. |
void |
buildMimeMessage()
Build the internal MimeMessage to be sent. |
javax.mail.internet.InternetAddress |
getFromAddress()
Gets the sender of the email. |
java.lang.String |
getHostName()
Gets the host name of the SMTP server, |
javax.mail.Session |
getMailSession()
Initialise a mailsession object |
javax.mail.internet.MimeMessage |
getMimeMessage()
Returns the internal MimeMessage. |
java.util.Date |
getSentDate()
Gets the sent date for the email. |
java.lang.String |
getSmtpPort()
Gets the listening port of the SMTP server. |
java.lang.String |
getSubject()
Gets the subject of the email. |
java.lang.String |
send()
Sends the email. |
java.lang.String |
sendMimeMessage()
Sends the previously created MimeMessage to the SMTP server. |
void |
setAuthentication(java.lang.String userName,
java.lang.String password)
Sets the userName and password if authentication is needed. |
void |
setAuthenticator(javax.mail.Authenticator newAuthenticator)
Sets the Authenticator to be used when authentication
is requested from the mail server. |
Email |
setBcc(java.util.Collection aCollection)
Set a list of "BCC" addresses |
Email |
setBounceAddress(java.lang.String email)
Set the "bounce address" - the address to which undeliverable messages will be returned. |
Email |
setCc(java.util.Collection aCollection)
Set a list of "CC" addresses. |
void |
setCharset(java.lang.String newCharset)
Set the charset of the message. |
void |
setContent(javax.mail.internet.MimeMultipart aMimeMultipart)
Set the emailBody to a MimeMultiPart |
void |
setContent(java.lang.Object aObject,
java.lang.String aContentType)
Set the content & contentType |
void |
setDebug(boolean d)
Setting to true will enable the display of debug information. |
Email |
setFrom(java.lang.String email)
Set the FROM field of the email. |
Email |
setFrom(java.lang.String email,
java.lang.String name)
Set the FROM field of the email. |
void |
setHeaders(java.util.Map map)
Used to specify the mail headers. |
void |
setHostName(java.lang.String aHostName)
Set the hostname of the outgoing mail server |
void |
setMailSession(javax.mail.Session aSession)
Supply a mail Session object to use |
abstract Email |
setMsg(java.lang.String msg)
Define the content of the mail. |
void |
setPopBeforeSmtp(boolean newPopBeforeSmtp,
java.lang.String newPopHost,
java.lang.String newPopUsername,
java.lang.String newPopPassword)
Set details regarding "pop3 before smtp" authentication. |
void |
setSentDate(java.util.Date date)
Sets the sent date for the email. |
void |
setSmtpPort(int aPortNumber)
Set the port number of the outgoing mail server. |
Email |
setSubject(java.lang.String aSubject)
Set the email subject. |
Email |
setTo(java.util.Collection aCollection)
Set a list of "TO" addresses. |
protected javax.mail.internet.InternetAddress[] |
toInternetAddressArray(java.util.List list)
Utility to copy List of known InternetAddress objects into an array. |
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_HOST
public static final java.lang.String MAIL_PORT
public static final java.lang.String MAIL_SMTP_FROM
public static final java.lang.String MAIL_SMTP_AUTH
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 MAIL_DEBUG
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
protected javax.mail.internet.InternetAddress fromAddress
protected java.lang.String subject
protected javax.mail.internet.MimeMultipart emailBody
protected java.lang.Object content
protected java.lang.String contentType
protected boolean debug
protected java.util.Date sentDate
protected javax.mail.Authenticator authenticator
Authenticator
object that will be used
when authentication is requested from the mail server.
protected java.lang.String hostName
protected java.lang.String smtpPort
protected java.util.List toList
protected java.util.List ccList
protected java.util.List bccList
protected java.util.List replyList
protected java.lang.String bounceAddress
String
rather than InternetAddress
.
protected java.util.Map headers
protected boolean popBeforeSmtp
protected java.lang.String popHost
protected java.lang.String popUsername
protected java.lang.String popPassword
Constructor Detail |
public Email()
Method Detail |
public void setDebug(boolean d)
d
- A boolean.public void setAuthentication(java.lang.String userName, java.lang.String password)
This method will create a new instance of
DefaultAuthenticator
using the supplied parameters.
userName
- User name for the SMTP serverpassword
- password for the SMTP serverDefaultAuthenticator
,
setAuthenticator(javax.mail.Authenticator)
public void setAuthenticator(javax.mail.Authenticator newAuthenticator)
Authenticator
to be used when authentication
is requested from the mail server.
This method should be used when your outgoing mail server requires authentication. Your mail server must also support RFC2554.
newAuthenticator
- the Authenticator
object.Authenticator
public void setCharset(java.lang.String newCharset)
newCharset
- A String.public void setContent(javax.mail.internet.MimeMultipart aMimeMultipart)
aMimeMultipart
- aMimeMultipartpublic void setContent(java.lang.Object aObject, java.lang.String aContentType)
aObject
- aObjectaContentType
- aContentTypepublic void setHostName(java.lang.String aHostName)
aHostName
- aHostNamepublic void setSmtpPort(int aPortNumber)
aPortNumber
- aPortNumberpublic void setMailSession(javax.mail.Session aSession)
aSession
- mail session to be usedpublic javax.mail.Session getMailSession() throws EmailException
EmailException
- thrown when host name was not set.public Email setFrom(java.lang.String email) throws EmailException
email
- A String.
EmailException
- Indicates an invalid email address.public Email setFrom(java.lang.String email, java.lang.String name) throws EmailException
email
- A String.name
- A String.
EmailException
- Indicates an invalid email address.public Email addTo(java.lang.String email) throws EmailException
email
- A String.
EmailException
- Indicates an invalid email address.public Email addTo(java.lang.String email, java.lang.String name) throws EmailException
email
- A String.name
- A String.
EmailException
- Indicates an invalid email address.public Email setTo(java.util.Collection aCollection) throws EmailException
aCollection
- collection of InternetAddress objects.
EmailException
- Indicates an invalid email address.public Email addCc(java.lang.String email) throws EmailException
email
- A String.
EmailException
- Indicates an invalid email address.public Email addCc(java.lang.String email, java.lang.String name) throws EmailException
email
- A String.name
- A String.
EmailException
- Indicates an invalid email address.public Email setCc(java.util.Collection aCollection) throws EmailException
aCollection
- collection of InternetAddress objects.
EmailException
- Indicates an invalid email addresspublic Email addBcc(java.lang.String email) throws EmailException
email
- A String.
EmailException
- Indicates an invalid email addresspublic Email addBcc(java.lang.String email, java.lang.String name) throws EmailException
email
- A String.name
- A String.
EmailException
- Indicates an invalid email addresspublic Email setBcc(java.util.Collection aCollection) throws EmailException
aCollection
- collection of InternetAddress objects
EmailException
- Indicates an invalid email addresspublic Email addReplyTo(java.lang.String email) throws EmailException
email
- A String.
EmailException
- Indicates an invalid email addresspublic Email addReplyTo(java.lang.String email, java.lang.String name) throws EmailException
email
- A String.name
- A String.
EmailException
- Indicates an invalid email addresspublic void setHeaders(java.util.Map map)
map
- A Map.public void addHeader(java.lang.String name, java.lang.String value)
name
- A String with the name.value
- A String with the value.public Email setSubject(java.lang.String aSubject)
aSubject
- A String.
public Email setBounceAddress(java.lang.String email)
email
- A String.
public abstract Email setMsg(java.lang.String msg) throws EmailException
msg
- A String.
EmailException
- generic exception.public void buildMimeMessage() throws EmailException
EmailException
- if there was an error.public java.lang.String sendMimeMessage() throws EmailException
EmailException
- the sending failedpublic javax.mail.internet.MimeMessage getMimeMessage()
public java.lang.String send() throws EmailException
EmailException
- the sending failedpublic void setSentDate(java.util.Date date)
date
- Date to use as the sent date on the emailpublic java.util.Date getSentDate()
public java.lang.String getSubject()
public javax.mail.internet.InternetAddress getFromAddress()
public java.lang.String getHostName()
public java.lang.String getSmtpPort()
protected javax.mail.internet.InternetAddress[] toInternetAddressArray(java.util.List list)
list
- A List.
public void setPopBeforeSmtp(boolean newPopBeforeSmtp, java.lang.String newPopHost, java.lang.String newPopUsername, java.lang.String newPopPassword)
newPopBeforeSmtp
- Wether or not to log into pop3
server before sending mail.newPopHost
- The pop3 host to use.newPopUsername
- The pop3 username.newPopPassword
- The pop3 password.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |