|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.commons.mail.Email
org.apache.commons.mail.MultiPartEmail
org.apache.commons.mail.HtmlEmail
public class HtmlEmail
An HTML multipart email.
This class is used to send HTML formatted email. A text message can also be set for HTML unaware email clients, such as text-based email clients.
This class also inherits from MultiPartEmail, so it is easy to add attachments to the email.
To send an email in HTML, one should create a HtmlEmail, then use the setFrom, addTo, etc. methods. The HTML content can be set with the setHtmlMsg method. The alternative text content can be set with setTextMsg.
Either the text or HTML can be omitted, in which case the "main" part of the multipart becomes whichever is supplied rather than a multipart/alternative.
Field Summary | |
---|---|
static int |
CID_LENGTH
Definition of the length of generated CID's |
protected java.lang.String |
html
Html part of the message |
protected java.util.List |
inlineImages
Embedded images |
protected java.lang.String |
text
Text part of the message. |
Fields inherited from class org.apache.commons.mail.Email |
---|
ATTACHMENTS, authenticator, bccList, bounceAddress, ccList, charset, content, CONTENT_TYPE, contentType, debug, EMAIL_BODY, EMAIL_SUBJECT, emailBody, FILE_SERVER, fromAddress, headers, hostName, ISO_8859_1, KOI8_R, MAIL_DEBUG, MAIL_HOST, MAIL_PORT, MAIL_SMTP_AUTH, MAIL_SMTP_FROM, MAIL_TRANSPORT_PROTOCOL, message, popBeforeSmtp, popHost, popPassword, popUsername, RECEIVER_EMAIL, RECEIVER_NAME, replyList, SENDER_EMAIL, SENDER_NAME, sentDate, SMTP, smtpPort, subject, TEXT_HTML, TEXT_PLAIN, toList, US_ASCII |
Constructor Summary | |
---|---|
HtmlEmail()
|
Method Summary | |
---|---|
void |
buildMimeMessage()
Does the work of actually building the email. |
java.lang.String |
embed(java.net.URL url,
java.lang.String name)
Embeds an URL in the HTML. |
HtmlEmail |
setHtmlMsg(java.lang.String aHtml)
Set the HTML content. |
Email |
setMsg(java.lang.String msg)
Set the message. |
HtmlEmail |
setTextMsg(java.lang.String aText)
Set the text content. |
Methods inherited from class org.apache.commons.mail.MultiPartEmail |
---|
addPart, addPart, addPart, attach, attach, attach, attach, attach, createBodyPart, createMimeMultipart, getContainer, getPrimaryBodyPart, getSubType, init, isBoolHasAttachments, isInitialized, setBoolHasAttachments, setInitialized, setSubType |
Methods inherited from class org.apache.commons.mail.Email |
---|
addBcc, addBcc, addCc, addCc, addHeader, addReplyTo, addReplyTo, addTo, addTo, getFromAddress, getHostName, getMailSession, getMimeMessage, getSentDate, getSmtpPort, getSubject, send, sendMimeMessage, setAuthentication, setAuthenticator, setBcc, setBounceAddress, setCc, setCharset, setContent, setContent, setDebug, setFrom, setFrom, setHeaders, setHostName, setMailSession, setPopBeforeSmtp, setSentDate, setSmtpPort, setSubject, setTo, toInternetAddressArray |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int CID_LENGTH
protected java.lang.String text
protected java.lang.String html
protected java.util.List inlineImages
Constructor Detail |
---|
public HtmlEmail()
Method Detail |
---|
public HtmlEmail setTextMsg(java.lang.String aText) throws EmailException
aText
- A String.
EmailException
- see javax.mail.internet.MimeBodyPart
for definitionspublic HtmlEmail setHtmlMsg(java.lang.String aHtml) throws EmailException
aHtml
- A String.
EmailException
- see javax.mail.internet.MimeBodyPart
for definitionspublic Email setMsg(java.lang.String msg) throws EmailException
This method overrides the MultiPartEmail setMsg() method in order to send an HTML message instead of a full text message in the mail body. The message is formatted in HTML for the HTML part of the message, it is let as is in the alternate text part.
setMsg
in class MultiPartEmail
msg
- A String.
EmailException
- see javax.mail.internet.MimeBodyPart
for definitionspublic java.lang.String embed(java.net.URL url, java.lang.String name) throws EmailException
This method allows to embed a file located by an URL into
the mail body. It allows, for instance, to add inline images
to the email. Inline files may be referenced with a
cid:xxxxxx
URL, where xxxxxx is the Content-ID
returned by the embed function.
Example of use:
HtmlEmail he = new HtmlEmail();
he.setHtmlMsg("<html><img src=cid:" +
embed("file:/my/image.gif","image.gif") +
"></html>");
// code to set the others email fields (not shown)
url
- The URL of the file.name
- The name that will be set in the filename header
field.
EmailException
- when URL supplied is invalid
also see javax.mail.internet.MimeBodyPart for definitionspublic void buildMimeMessage() throws EmailException
buildMimeMessage
in class MultiPartEmail
EmailException
- if there was an error.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |