com.sh.mail.core

类 Email

java.lang.Object

com.sh.mail.core.Email

直接已知子类:

MultiPartEmail, SimpleEmail

public abstract class Email
extends java.lang.Object

Description: 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.

Title:首亨软件 - TSS/CRM等

从以下版本开始:

Aug 13, 2012

版本:

3.0

作者:

江兴春

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	ATTACHMENTS
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_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_CONNECTIONTIMEOUT Socket connection timeout value in milliseconds.
static java.lang.String	MAIL_SMTP_FROM
static java.lang.String	MAIL_SMTP_PASSWORD
static java.lang.String	MAIL_SMTP_SOCKET_FACTORY_CLASS
static java.lang.String	MAIL_SMTP_SOCKET_FACTORY_FALLBACK
static java.lang.String	MAIL_SMTP_SOCKET_FACTORY_PORT
static java.lang.String	MAIL_SMTP_TIMEOUT Socket I/O timeout value in milliseconds.
static java.lang.String	MAIL_SMTP_USER
static java.lang.String	MAIL_TRANSPORT_PROTOCOL
static java.lang.String	MAIL_TRANSPORT_TLS
static java.lang.String	RECEIVER_EMAIL
static java.lang.String	RECEIVER_NAME
static java.lang.String	SENDER_EMAIL
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

构造器概要

构造器

构造器和说明
Email()

方法概要

限定符和类型	方法和说明
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 using the specified address and the specified personal name.
Email	addBcc(java.lang.String email, java.lang.String name, java.lang.String charset) Add a blind BCC recipient to the email using the specified address, personal name, and charset encoding for the name.
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 using the specified address and the specified personal name.
Email	addCc(java.lang.String email, java.lang.String name, java.lang.String charset) Add a recipient CC to the email using the specified address, personal name, and charset encoding for the name.
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 using the specified address and the specified personal name.
Email	addReplyTo(java.lang.String email, java.lang.String name, java.lang.String charset) Add a reply to address to the email using the specified address, personal name, and charset encoding for the name.
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 using the specified address and the specified personal name.
Email	addTo(java.lang.String email, java.lang.String name, java.lang.String charset) Add a recipient TO to the email using the specified address, personal name, and charset encoding for the name.
void	buildMimeMessage() Build the internal MimeMessage to be sent.
java.util.List	getBccAddresses() Get the list of "Bcc" addresses.
java.util.List	getCcAddresses() Get the list of "CC" addresses.
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.List	getReplyToAddresses() Get the list of "Reply-To" addresses.
java.util.Date	getSentDate() Gets the sent date for the email.
java.lang.String	getSmtpPort() Gets the listening port of the SMTP server.
int	getSocketConnectionTimeout() Get the socket connection timeout value in milliseconds.
int	getSocketTimeout() Get the socket I/O timeout value in milliseconds.
java.lang.String	getSslSmtpPort() Returns the current SSL port used by the SMTP transport.
java.lang.String	getSubject() Gets the subject of the email.
java.util.List	getToAddresses() Get the list of "To" addresses.
boolean	isSSL() Returns whether SSL encryption for the transport is currently enabled.
boolean	isTLS() Gets encryption mode for authentication
void	resetToAddress() 重置收件人列表
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 to use the specified address.
Email	setFrom(java.lang.String email, java.lang.String name) Set the FROM field of the email to use the specified address and the specified personal name.
Email	setFrom(java.lang.String email, java.lang.String name, java.lang.String charset) Set the FROM field of the email to use the specified address, personal name, and charset encoding for the name.
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.
void	setMailSessionFromJNDI(java.lang.String jndiName) Supply a mail Session object from a JNDI directory
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.
Email	setReplyTo(java.util.Collection aCollection) Set a list of reply to addresses.
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.
void	setSocketConnectionTimeout(int socketConnectionTimeout) Set the socket connection timeout value in milliseconds.
void	setSocketTimeout(int socketTimeout) Set the socket I/O timeout value in milliseconds.
void	setSSL(boolean ssl) Sets whether SSL encryption should be enabled for the SMTP transport.
void	setSslSmtpPort(java.lang.String sslSmtpPort) Sets the SSL port to use for the SMTP transport.
Email	setSubject(java.lang.String aSubject) Set the email subject.
void	setTLS(boolean withTLS) Set or disable the TLS encryption
Email	setTo(java.util.Collection aCollection) Set a list of "TO" addresses.
void	updateContentType(java.lang.String aContentType) Update the contentType.

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

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

字段详细资料

SENDER_EMAIL

public static final java.lang.String SENDER_EMAIL

另请参阅:

常量字段值

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

另请参阅:

常量字段值

CONTENT_TYPE

public static final java.lang.String CONTENT_TYPE

另请参阅:

常量字段值

MAIL_HOST

public static final java.lang.String MAIL_HOST

另请参阅:

常量字段值

MAIL_PORT

public static final java.lang.String MAIL_PORT

另请参阅:

常量字段值

MAIL_SMTP_FROM

public static final java.lang.String MAIL_SMTP_FROM

另请参阅:

常量字段值

MAIL_SMTP_AUTH

public static final java.lang.String MAIL_SMTP_AUTH

另请参阅:

常量字段值

MAIL_SMTP_USER

public static final java.lang.String MAIL_SMTP_USER

另请参阅:

常量字段值

MAIL_SMTP_PASSWORD

public static final java.lang.String MAIL_SMTP_PASSWORD

另请参阅:

常量字段值

MAIL_TRANSPORT_PROTOCOL

public static final java.lang.String MAIL_TRANSPORT_PROTOCOL

另请参阅:

常量字段值

MAIL_TRANSPORT_TLS

public static final java.lang.String MAIL_TRANSPORT_TLS

从以下版本开始:

1.1

另请参阅:

常量字段值

MAIL_SMTP_SOCKET_FACTORY_FALLBACK

public static final java.lang.String MAIL_SMTP_SOCKET_FACTORY_FALLBACK

另请参阅:

常量字段值

MAIL_SMTP_SOCKET_FACTORY_CLASS

public static final java.lang.String MAIL_SMTP_SOCKET_FACTORY_CLASS

另请参阅:

常量字段值

MAIL_SMTP_SOCKET_FACTORY_PORT

public static final java.lang.String MAIL_SMTP_SOCKET_FACTORY_PORT

另请参阅:

常量字段值

MAIL_SMTP_CONNECTIONTIMEOUT

public static final java.lang.String MAIL_SMTP_CONNECTIONTIMEOUT

Socket connection timeout value in milliseconds. Default is infinite timeout.

从以下版本开始:

1.2

另请参阅:

常量字段值

MAIL_SMTP_TIMEOUT

public static final java.lang.String MAIL_SMTP_TIMEOUT

Socket I/O timeout value in milliseconds. Default is infinite timeout.

从以下版本开始:

1.2

另请参阅:

常量字段值

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

另请参阅:

常量字段值

MAIL_DEBUG

public static final java.lang.String MAIL_DEBUG

另请参阅:

常量字段值

KOI8_R

public static final java.lang.String KOI8_R

另请参阅:

常量字段值

ISO_8859_1

public static final java.lang.String ISO_8859_1

另请参阅:

常量字段值

US_ASCII

public static final java.lang.String US_ASCII

另请参阅:

常量字段值

构造器详细资料

Email

public Email()

方法详细资料

setDebug

public void setDebug(boolean d)

Setting to true will enable the display of debug information.

参数:

d - A boolean.

从以下版本开始:

1.0

setAuthentication

public void setAuthentication(java.lang.String userName,
                              java.lang.String password)

Sets the userName and password if authentication is needed. If this method is not used, no authentication will be performed.

This method will create a new instance of DefaultAuthenticator using the supplied parameters.

参数:

userName - User name for the SMTP server

password - password for the SMTP server

从以下版本开始:

1.0

另请参阅:

DefaultAuthenticator, setAuthenticator(javax.mail.Authenticator)

setAuthenticator

public void setAuthenticator(javax.mail.Authenticator newAuthenticator)

Sets the 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.

从以下版本开始:

1.0

另请参阅:

Authenticator

setCharset

public void setCharset(java.lang.String newCharset)

Set the charset of the message.

参数:

newCharset - A String.

抛出:

java.nio.charset.IllegalCharsetNameException - if the charset name is invalid

java.nio.charset.UnsupportedCharsetException - if no support for the named charset exists in the current JVM

从以下版本开始:

1.0

setContent

public void setContent(javax.mail.internet.MimeMultipart aMimeMultipart)

Set the emailBody to a MimeMultiPart

参数:

aMimeMultipart - aMimeMultipart

从以下版本开始:

1.0

setContent

public void setContent(java.lang.Object aObject,
                       java.lang.String aContentType)

Set the content contentType

参数:

aObject - aObject

aContentType - aContentType

从以下版本开始:

1.0

updateContentType

public void updateContentType(java.lang.String aContentType)

Update the contentType.

参数:

aContentType - aContentType

从以下版本开始:

1.2

setHostName

public void setHostName(java.lang.String aHostName)

Set the hostname of the outgoing mail server

参数:

aHostName - aHostName

从以下版本开始:

1.0

setTLS

public void setTLS(boolean withTLS)

Set or disable the TLS encryption

参数:

withTLS - true if TLS needed, false otherwise

从以下版本开始:

1.1

setSmtpPort

public void setSmtpPort(int aPortNumber)

Set the port number of the outgoing mail server.

参数:

aPortNumber - aPortNumber

从以下版本开始:

1.0

setMailSession

public void setMailSession(javax.mail.Session aSession)

Supply a mail Session object to use. Please note that passing a username and password (in the case of mail authentication) will create a new mail session with a DefaultAuthenticator. This is a convience but might come unexpected. If mail authentication is used but NO username and password is supplied the implementation assumes that you have set a authenticator and will use the existing mail session (as expected).

参数:

aSession - mail session to be used

从以下版本开始:

1.0

setMailSessionFromJNDI

public void setMailSessionFromJNDI(java.lang.String jndiName)
                            throws javax.naming.NamingException

Supply a mail Session object from a JNDI directory

参数:

jndiName - name of JNDI ressource (javax.mail.Session type), ressource if searched in java:comp/env if name dont start with "java:"

抛出:

java.lang.IllegalArgumentException - JNDI name null or empty

javax.naming.NamingException - ressource can be retrieved from JNDI directory

从以下版本开始:

1.1

getMailSession

public javax.mail.Session getMailSession()
                                  throws EmailException

Initialise a mailsession object

返回:

A Session.

抛出:

EmailException - thrown when host name was not set.

从以下版本开始:

1.0

setFrom

public Email setFrom(java.lang.String email)
              throws EmailException

Set the FROM field of the email to use the specified address. The email address will also be used as the personal name. The name will be encoded by the charset of setCharset(). If it is not set, it will be encoded using the Java platform's default charset (UTF-16) if it contains non-ASCII characters; otherwise, it is used as is.

参数:

email - A String.

返回:

An Email.

抛出:

EmailException - Indicates an invalid email address.

从以下版本开始:

1.0

setFrom

public Email setFrom(java.lang.String email,
                     java.lang.String name)
              throws EmailException

Set the FROM field of the email to use the specified address and the specified personal name. The name will be encoded by the charset of setCharset(). If it is not set, it will be encoded using the Java platform's default charset (UTF-16) if it contains non-ASCII characters; otherwise, it is used as is.

参数:

email - A String.

name - A String.

返回:

An Email.

抛出:

EmailException - Indicates an invalid email address.

从以下版本开始:

1.0

setFrom

public Email setFrom(java.lang.String email,
                     java.lang.String name,
                     java.lang.String charset)
              throws EmailException

Set the FROM field of the email to use the specified address, personal name, and charset encoding for the name.

参数:

email - A String.

name - A String.

charset - The charset to encode the name with.

返回:

An Email.

抛出:

EmailException - Indicates an invalid email address or charset.

从以下版本开始:

1.1

addTo

public Email addTo(java.lang.String email)
            throws EmailException

Add a recipient TO to the email. The email address will also be used as the personal name. The name will be encoded by the charset of setCharset(). If it is not set, it will be encoded using the Java platform's default charset (UTF-16) if it contains non-ASCII characters; otherwise, it is used as is.

参数:

email - A String.

返回:

An Email.

抛出:

EmailException - Indicates an invalid email address.

从以下版本开始:

1.0

addTo

public Email addTo(java.lang.String email,
                   java.lang.String name)
            throws EmailException

Add a recipient TO to the email using the specified address and the specified personal name. The name will be encoded by the charset of setCharset(). If it is not set, it will be encoded using the Java platform's default charset (UTF-16) if it contains non-ASCII characters; otherwise, it is used as is.

参数:

email - A String.

name - A String.

返回:

An Email.

抛出:

EmailException - Indicates an invalid email address.

从以下版本开始:

1.0

addTo

public Email addTo(java.lang.String email,
                   java.lang.String name,
                   java.lang.String charset)
            throws EmailException

Add a recipient TO to the email using the specified address, personal name, and charset encoding for the name.

参数:

email - A String.

name - A String.

charset - The charset to encode the name with.

返回:

An Email.

抛出:

EmailException - Indicates an invalid email address or charset.

从以下版本开始:

1.1

setTo

public Email setTo(java.util.Collection aCollection)
            throws EmailException

Set a list of "TO" addresses. All elements in the specified Collection are expected to be of type java.mail.internet.InternetAddress.

参数:

aCollection - collection of InternetAddress objects.

返回:

An Email.

抛出:

EmailException - Indicates an invalid email address.

从以下版本开始:

1.0

另请参阅:

InternetAddress

addCc

public Email addCc(java.lang.String email)
            throws EmailException

Add a recipient CC to the email. The email address will also be used as the personal name. The name will be encoded by the charset of setCharset(). If it is not set, it will be encoded using the Java platform's default charset (UTF-16) if it contains non-ASCII characters; otherwise, it is used as is.

参数:

email - A String.

返回:

An Email.

抛出:

EmailException - Indicates an invalid email address.

从以下版本开始:

1.0

addCc

public Email addCc(java.lang.String email,
                   java.lang.String name)
            throws EmailException

Add a recipient CC to the email using the specified address and the specified personal name. The name will be encoded by the charset of setCharset(). If it is not set, it will be encoded using the Java platform's default charset (UTF-16) if it contains non-ASCII characters; otherwise, it is used as is.

参数:

email - A String.

name - A String.

返回:

An Email.

抛出:

EmailException - Indicates an invalid email address.

从以下版本开始:

1.0

addCc

public Email addCc(java.lang.String email,
                   java.lang.String name,
                   java.lang.String charset)
            throws EmailException

Add a recipient CC to the email using the specified address, personal name, and charset encoding for the name.

参数:

email - A String.

name - A String.

charset - The charset to encode the name with.

返回:

An Email.

抛出:

EmailException - Indicates an invalid email address or charset.

从以下版本开始:

1.1

setCc

public Email setCc(java.util.Collection aCollection)
            throws EmailException

Set a list of "CC" addresses. All elements in the specified Collection are expected to be of type java.mail.internet.InternetAddress.

参数:

aCollection - collection of InternetAddress objects.

返回:

An Email.

抛出:

EmailException - Indicates an invalid email address.

从以下版本开始:

1.0

另请参阅:

InternetAddress

addBcc

public Email addBcc(java.lang.String email)
             throws EmailException

Add a blind BCC recipient to the email. The email address will also be used as the personal name. The name will be encoded by the charset of setCharset(). If it is not set, it will be encoded using the Java platform's default charset (UTF-16) if it contains non-ASCII characters; otherwise, it is used as is.

参数:

email - A String.

返回:

An Email.

抛出:

EmailException - Indicates an invalid email address

从以下版本开始:

1.0

addBcc

public Email addBcc(java.lang.String email,
                    java.lang.String name)
             throws EmailException

Add a blind BCC recipient to the email using the specified address and the specified personal name. The name will be encoded by the charset of setCharset(). If it is not set, it will be encoded using the Java platform's default charset (UTF-16) if it contains non-ASCII characters; otherwise, it is used as is.

参数:

email - A String.

name - A String.

返回:

An Email.

抛出:

EmailException - Indicates an invalid email address

从以下版本开始:

1.0

addBcc

public Email addBcc(java.lang.String email,
                    java.lang.String name,
                    java.lang.String charset)
             throws EmailException

Add a blind BCC recipient to the email using the specified address, personal name, and charset encoding for the name.

参数:

email - A String.

name - A String.

charset - The charset to encode the name with.

返回:

An Email.

抛出:

EmailException - Indicates an invalid email address

从以下版本开始:

1.1

setBcc

public Email setBcc(java.util.Collection aCollection)
             throws EmailException

Set a list of "BCC" addresses. All elements in the specified Collection are expected to be of type java.mail.internet.InternetAddress.

参数:

aCollection - collection of InternetAddress objects

返回:

An Email.

抛出:

EmailException - Indicates an invalid email address

从以下版本开始:

1.0

另请参阅:

InternetAddress

addReplyTo

public Email addReplyTo(java.lang.String email)
                 throws EmailException

Add a reply to address to the email. The email address will also be used as the personal name. The name will be encoded by the charset of setCharset(). If it is not set, it will be encoded using the Java platform's default charset (UTF-16) if it contains non-ASCII characters; otherwise, it is used as is.

参数:

email - A String.

返回:

An Email.

抛出:

EmailException - Indicates an invalid email address

从以下版本开始:

1.0

addReplyTo

public Email addReplyTo(java.lang.String email,
                        java.lang.String name)
                 throws EmailException

Add a reply to address to the email using the specified address and the specified personal name. The name will be encoded by the charset of setCharset(). If it is not set, it will be encoded using the Java platform's default charset (UTF-16) if it contains non-ASCII characters; otherwise, it is used as is.

参数:

email - A String.

name - A String.

返回:

An Email.

抛出:

EmailException - Indicates an invalid email address

从以下版本开始:

1.0

addReplyTo

public Email addReplyTo(java.lang.String email,
                        java.lang.String name,
                        java.lang.String charset)
                 throws EmailException

Add a reply to address to the email using the specified address, personal name, and charset encoding for the name.

参数:

email - A String.

name - A String.

charset - The charset to encode the name with.

返回:

An Email.

抛出:

EmailException - Indicates an invalid email address or charset.

从以下版本开始:

1.1

setReplyTo

public Email setReplyTo(java.util.Collection aCollection)
                 throws EmailException

Set a list of reply to addresses. All elements in the specified Collection are expected to be of type java.mail.internet.InternetAddress.

参数:

aCollection - collection of InternetAddress objects

返回:

An Email.

抛出:

EmailException - Indicates an invalid email address

从以下版本开始:

1.1

另请参阅:

InternetAddress

setHeaders

public void setHeaders(java.util.Map map)

Used to specify the mail headers. Example: X-Mailer: Sendmail, X-Priority: 1( highest ) or 2( high ) 3( normal ) 4( low ) and 5( lowest ) Disposition-Notification-To: user@domain.net

参数:

map - A Map.

从以下版本开始:

1.0

addHeader

public void addHeader(java.lang.String name,
                      java.lang.String value)

Adds a header ( name, value ) to the headers Map.

参数:

name - A String with the name.

value - A String with the value.

从以下版本开始:

1.0

setSubject

public Email setSubject(java.lang.String aSubject)

Set the email subject.

参数:

aSubject - A String.

返回:

An Email.

从以下版本开始:

1.0

setBounceAddress

public Email setBounceAddress(java.lang.String email)

Set the "bounce address" - the address to which undeliverable messages will be returned. If this value is never set, then the message will be sent to the address specified with the System property "mail.smtp.from", or if that value is not set, then to the "from" address.

参数:

email - A String.

返回:

An Email.

从以下版本开始:

1.0

setMsg

public abstract Email setMsg(java.lang.String msg)
                      throws EmailException

Define the content of the mail. It should be overidden by the subclasses.

参数:

msg - A String.

返回:

An Email.

抛出:

EmailException - generic exception.

从以下版本开始:

1.0

buildMimeMessage

public void buildMimeMessage()
                      throws EmailException

Build the internal MimeMessage to be sent.

抛出:

EmailException - if there was an error.

从以下版本开始:

1.0

sendMimeMessage

public java.lang.String sendMimeMessage()
                                 throws EmailException

Sends the previously created MimeMessage to the SMTP server.

返回:

the message id of the underlying MimeMessage

抛出:

EmailException - the sending failed

getMimeMessage

public javax.mail.internet.MimeMessage getMimeMessage()

Returns the internal MimeMessage. Please not that the MimeMessage is build by the buildMimeMessage() method.

返回:

the MimeMessage

send

public java.lang.String send()
                      throws EmailException

Sends the email. Internally we build a MimeMessage which is afterwards sent to the SMTP server.

返回:

the message id of the underlying MimeMessage

抛出:

EmailException - the sending failed

setSentDate

public void setSentDate(java.util.Date date)

Sets the sent date for the email. The sent date will default to the current date if not explictly set.

参数:

date - Date to use as the sent date on the email

从以下版本开始:

1.0

getSentDate

public java.util.Date getSentDate()

Gets the sent date for the email.

返回:

date to be used as the sent date for the email

从以下版本开始:

1.0

getSubject

public java.lang.String getSubject()

Gets the subject of the email.

返回:

email subject

getFromAddress

public javax.mail.internet.InternetAddress getFromAddress()

Gets the sender of the email.

返回:

from address

getHostName

public java.lang.String getHostName()

Gets the host name of the SMTP server,

返回:

host name

getSmtpPort

public java.lang.String getSmtpPort()

Gets the listening port of the SMTP server.

返回:

smtp port

isTLS

public boolean isTLS()

Gets encryption mode for authentication

返回:

true if using TLS for authentication, false otherwise

从以下版本开始:

1.1

setPopBeforeSmtp

public void setPopBeforeSmtp(boolean newPopBeforeSmtp,
                             java.lang.String newPopHost,
                             java.lang.String newPopUsername,
                             java.lang.String newPopPassword)

Set details regarding "pop3 before smtp" authentication.

参数:

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.

从以下版本开始:

1.0

isSSL

public boolean isSSL()

Returns whether SSL encryption for the transport is currently enabled.

返回:

true if SSL enabled for the transport

setSSL

public void setSSL(boolean ssl)

Sets whether SSL encryption should be enabled for the SMTP transport.

参数:

ssl - whether to enable the SSL transport

getSslSmtpPort

public java.lang.String getSslSmtpPort()

Returns the current SSL port used by the SMTP transport.

返回:

the current SSL port used by the SMTP transport

setSslSmtpPort

public void setSslSmtpPort(java.lang.String sslSmtpPort)

Sets the SSL port to use for the SMTP transport. Defaults to the standard port, 465.

参数:

sslSmtpPort - the SSL port to use for the SMTP transport

getToAddresses

public java.util.List getToAddresses()

Get the list of "To" addresses.

返回:

List addresses

resetToAddress

public void resetToAddress()

重置收件人列表

getCcAddresses

public java.util.List getCcAddresses()

Get the list of "CC" addresses.

返回:

List addresses

getBccAddresses

public java.util.List getBccAddresses()

Get the list of "Bcc" addresses.

返回:

List addresses

getReplyToAddresses

public java.util.List getReplyToAddresses()

Get the list of "Reply-To" addresses.

返回:

List addresses

getSocketConnectionTimeout

public int getSocketConnectionTimeout()

Get the socket connection timeout value in milliseconds.

返回:

the timeout in milliseconds.

从以下版本开始:

1.2

setSocketConnectionTimeout

public void setSocketConnectionTimeout(int socketConnectionTimeout)

Set the socket connection timeout value in milliseconds. Default is infinite timeout.

参数:

socketConnectionTimeout - the connection timeout

从以下版本开始:

1.2

getSocketTimeout

public int getSocketTimeout()

Get the socket I/O timeout value in milliseconds.

返回:

the socket I/O timeout

从以下版本开始:

1.2

setSocketTimeout

public void setSocketTimeout(int socketTimeout)

Set the socket I/O timeout value in milliseconds. Default is infinite timeout.

参数:

socketTimeout - the socket I/O timeout

从以下版本开始:

1.2