程序包 com.sh.mail.core

类 HtmlEmail

java.lang.Object

com.sh.mail.core.Email

com.sh.mail.core.MultiPartEmail

com.sh.mail.core.HtmlEmail

public class HtmlEmail
extends MultiPartEmail

Description: An HTML multipart email.

Title:首亨软件 - TSS/CRM等

从以下版本开始:

Aug 13, 2012

字段概要

字段

修饰符和类型	字段	说明
static final int	CID_LENGTH	Definition of the length of generated CID's
protected String	html	Html part of the message
protected Map	inlineEmbeds	Embedded images Map<String, InlineImage> where the key is the user-defined image name.
protected List	inlineImages	As of commons-email 1.1, no longer used.
protected String	text	Text part of the message.

从类继承的字段 com.sh.mail.core.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_CONNECTIONTIMEOUT, MAIL_SMTP_FROM, MAIL_SMTP_PASSWORD, MAIL_SMTP_SOCKET_FACTORY_CLASS, MAIL_SMTP_SOCKET_FACTORY_FALLBACK, MAIL_SMTP_SOCKET_FACTORY_PORT, MAIL_SMTP_TIMEOUT, MAIL_SMTP_USER, MAIL_TRANSPORT_PROTOCOL, MAIL_TRANSPORT_TLS, message, popBeforeSmtp, popHost, popPassword, popUsername, RECEIVER_EMAIL, RECEIVER_NAME, replyList, SENDER_EMAIL, SENDER_NAME, sentDate, SMTP, smtpPort, socketConnectionTimeout, socketTimeout, ssl, sslSmtpPort, subject, TEXT_HTML, TEXT_PLAIN, tls, toList, US_ASCII

构造器概要

构造器

构造器	说明
HtmlEmail()

方法概要

修饰符和类型	方法	说明
void	buildMimeMessage()	Does the work of actually building the email.
String	embed(jakarta.activation.DataSource dataSource, String name)	Embeds the specified DataSource in the HTML using a randomly generated Content-ID.
String	embed(jakarta.activation.DataSource dataSource, String name, String cid)	Embeds the specified DataSource in the HTML using the specified Content-ID.
String	embed(File file)	Embeds a file in the HTML.
String	embed(File file, String cid)	Embeds a file in the HTML.
String	embed(String urlString, String name)	Attempts to parse the specified String as a URL that will then be embedded in the message.
String	embed(URL url, String name)	Embeds an URL in the HTML.
HtmlEmail	setHtmlMsg(String aHtml)	Set the HTML content.
Email	setMsg(String msg)	Set the message.
HtmlEmail	setTextMsg(String aText)	Set the text content.

从类继承的方法 com.sh.mail.core.MultiPartEmail

addPart, addPart, addPart, attach, attach, attach, attach, attach, createBodyPart, createMimeMultipart, getContainer, getPrimaryBodyPart, getSubType, init, isBoolHasAttachments, isInitialized, setBoolHasAttachments, setInitialized, setSubType

从类继承的方法 com.sh.mail.core.Email

addBcc, addBcc, addBcc, addCc, addCc, addCc, addHeader, addReplyTo, addReplyTo, addReplyTo, addTo, addTo, addTo, createMimeMessage, getBccAddresses, getCcAddresses, getFromAddress, getHostName, getMailSession, getMimeMessage, getReplyToAddresses, getSentDate, getSmtpPort, getSocketConnectionTimeout, getSocketTimeout, getSslSmtpPort, getSubject, getToAddresses, isSSL, isTLS, resetToAddress, send, sendMimeMessage, setAuthentication, setAuthenticator, setBcc, setBounceAddress, setCc, setCharset, setContent, setContent, setDebug, setFrom, setFrom, setFrom, setHeaders, setHostName, setMailSession, setMailSessionFromJNDI, setPopBeforeSmtp, setReplyTo, setSentDate, setSmtpPort, setSocketConnectionTimeout, setSocketTimeout, setSSL, setSslSmtpPort, setSubject, setTLS, setTo, toInternetAddressArray, updateContentType

从类继承的方法 java.lang.Object

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

字段详细资料

CID_LENGTH

public static final int CID_LENGTH

Definition of the length of generated CID's

另请参阅:

• 常量字段值

text

protected String text

Text part of the message. This will be used as alternative text if the email client does not support HTML messages.

html

protected String html

Html part of the message

inlineImages

protected List inlineImages

As of commons-email 1.1, no longer used. Inline embedded objects are now stored in inlineEmbeds.

inlineEmbeds

protected Map inlineEmbeds

Embedded images Map<String, InlineImage> where the key is the user-defined image name.

构造器详细资料

HtmlEmail

public HtmlEmail()

方法详细资料

setTextMsg

public HtmlEmail setTextMsg(String aText)
                     throws EmailException

Set the text content.

参数:

aText - A String.

返回:

An HtmlEmail.

抛出:

EmailException - see javax.mail.internet.MimeBodyPart for definitions

从以下版本开始:

1.0

setHtmlMsg

public HtmlEmail setHtmlMsg(String aHtml)
                     throws EmailException

Set the HTML content.

参数:

aHtml - A String.

返回:

An HtmlEmail.

抛出:

EmailException - see javax.mail.internet.MimeBodyPart for definitions

从以下版本开始:

1.0

setMsg

public Email setMsg(String msg)
             throws EmailException

Set the message.

This method overrides MultiPartEmail.setMsg(String) in order to send an HTML message instead of a plain text message in the mail body. The message is formatted in HTML for the HTML part of the message; it is left as is in the alternate text part.

覆盖:

setMsg 在类中 MultiPartEmail

参数:

msg - the message text to use

返回:

this HtmlEmail

抛出:

EmailException - if msg is null or empty; see javax.mail.internet.MimeBodyPart for definitions

从以下版本开始:

1.0

embed

public String embed(String urlString,
 String name)
             throws EmailException

Attempts to parse the specified String as a URL that will then be embedded in the message.

参数:

urlString - String representation of the URL.

name - The name that will be set in the filename header field.

返回:

A String with the Content-ID of the URL.

抛出:

EmailException - when URL supplied is invalid or if is null or empty; also see javax.mail.internet.MimeBodyPart for definitions

从以下版本开始:

1.1

另请参阅:

• embed(URL, String)

embed

public String embed(URL url,
 String name)
             throws EmailException

Embeds an URL in the HTML.

This method embeds 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. It is an error to bind the same name to more than one URL; if the same URL is embedded multiple times, the same Content-ID is guaranteed to be returned.

While functionally the same as passing URLDataSource to embed(DataSource, String, String), this method attempts to validate the URL before embedding it in the message and will throw EmailException if the validation fails. In this case, the HtmlEmail object will not be changed.

NOTE: Clients should take care to ensure that different URLs are bound to different names. This implementation tries to detect this and throw EmailException. However, it is not guaranteed to catch all cases, especially when the URL refers to a remote HTTP host that may be part of a virtual host cluster.

参数:

url - The URL of the file.

name - The name that will be set in the filename header field.

返回:

A String with the Content-ID of the file.

抛出:

EmailException - when URL supplied is invalid or if is null or empty; also see javax.mail.internet.MimeBodyPart for definitions

从以下版本开始:

1.0

embed

public String embed(File file)
             throws EmailException

Embeds a file in the HTML. This implementation delegates to embed(File, String).

参数:

file - The File object to embed

返回:

A String with the Content-ID of the file.

抛出:

EmailException - when the supplied File cannot be used; also see javax.mail.internet.MimeBodyPart for definitions

从以下版本开始:

1.1

另请参阅:

• embed(File, String)

embed

public String embed(File file,
 String cid)
             throws EmailException

Embeds a file in the HTML.

This method embeds 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. Files are bound to their names, which is the value returned by File.getName(). If the same file is embedded multiple times, the same CID is guaranteed to be returned.

While functionally the same as passing FileDataSource to embed(DataSource, String, String), this method attempts to validate the file before embedding it in the message and will throw EmailException if the validation fails. In this case, the HtmlEmail object will not be changed.

参数:

file - The File to embed

cid - the Content-ID to use for the embedded File

返回:

A String with the Content-ID of the file.

抛出:

EmailException - when the supplied File cannot be used or if the file has already been embedded; also see javax.mail.internet.MimeBodyPart for definitions

从以下版本开始:

1.1

embed

public String embed(jakarta.activation.DataSource dataSource,
 String name)
             throws EmailException

Embeds the specified DataSource in the HTML using a randomly generated Content-ID. Returns the generated Content-ID string.

参数:

dataSource - the DataSource to embed

name - the name that will be set in the filename header field

返回:

the generated Content-ID for this DataSource

抛出:

EmailException - if the embedding fails or if name is null or empty

从以下版本开始:

1.1

另请参阅:

• embed(DataSource, String, String)

embed

public String embed(jakarta.activation.DataSource dataSource,
 String name,
 String cid)
             throws EmailException

Embeds the specified DataSource in the HTML using the specified Content-ID. Returns the specified Content-ID string.

参数:

dataSource - the DataSource to embed

name - the name that will be set in the filename header field

cid - the Content-ID to use for this DataSource

返回:

the supplied Content-ID for this DataSource

抛出:

EmailException - if the embedding fails or if name is null or empty

从以下版本开始:

1.1

buildMimeMessage

public void buildMimeMessage()
                      throws EmailException

Does the work of actually building the email.

覆盖:

buildMimeMessage 在类中 MultiPartEmail

抛出:

EmailException - if there was an error.

从以下版本开始:

1.0