Java org.apache.commons.mail HtmlEmail fields, constructors, methods, implement or subclass

Introduction

In this page you can find the methods, fields and constructors for org.apache.commons.mail HtmlEmail.

The text is from its open source code.

Subclass

org.apache.commons.mail.HtmlEmail has subclasses.
Click this link to see all its subclasses.

Field

int	CID_LENGTH Definition of the length of generated CID's.

Constructor

	HtmlEmail

Method

Email	addBcc(final String email) Add a blind BCC recipient to the email.
Email	addBcc(final String email, final String name) Add a blind BCC recipient to the email using the specified address and the specified personal name.
Email	addCc(final String email) Add a recipient CC to the email.
Email	addCc(final String email, final String name) Add a recipient CC to the email using the specified address and the specified personal name.
void	addHeader(final String name, final String value) Adds a header ( name, value ) to the headers Map.
Email	addReplyTo(final String email) Add a reply to address to the email.
Email	addReplyTo(final String email, final String name) Add a reply to address to the email using the specified address and the specified personal name.
Email	addTo(final String email) Add a recipient TO to the email.
Email	addTo(final String email, final String name) Add a recipient TO to the email using the specified address and the specified personal name.
MultiPartEmail	attach(final File file) Attach a file.
MultiPartEmail	attach(final URL url, final String name, final String description) Attach a file located by its URL.
void	buildMimeMessage() Does the work of actually building the MimeMessage.
String	embed(final File file) Embeds a file in the HTML.
String	embed(final String urlString, final String name) Attempts to parse the specified `String` as a URL that will then be embedded in the message.
String	embed(final URL url, final String name) Embeds an URL in the HTML.
String	embed(final File file, final String cid) Embeds a file in the HTML.
String	embed(final DataSource dataSource, final String name) Embeds the specified `DataSource` in the HTML using a randomly generated Content-ID.
String	embed(final DataSource dataSource, final String name, final String cid) Embeds the specified `DataSource` in the HTML using the specified Content-ID.
List	getBccAddresses() Get the list of "Bcc" addresses.
List	getCcAddresses() Get the list of "CC" addresses.
InternetAddress	getFromAddress() Gets the sender of the email.
String	getHostName() Gets the host name of the SMTP server,
Session	getMailSession() Determines the mail session used when sending this Email, creating the Session if necessary.
MimeMessage	getMimeMessage() Returns the internal MimeMessage.
List	getReplyToAddresses() Get the list of "Reply-To" addresses.
Date	getSentDate() Gets the sent date for the email.
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.
String	getSslSmtpPort() Returns the current SSL port used by the SMTP transport.
String	getSubject() Gets the subject of the email.
String	getSubType() Get the MIME subtype of the email.
List	getToAddresses() Get the list of "To" addresses.
boolean	isSSL() Returns whether SSL/TLS encryption for the transport is currently enabled (SMTPS/POPS).
boolean	isSSLCheckServerIdentity() Is the server identity checked as specified by RFC 2595
boolean	isSSLOnConnect() Returns whether SSL/TLS encryption for the transport is currently enabled (SMTPS/POPS).
boolean	isStartTLSEnabled() Gets whether the client is configured to try to enable STARTTLS.
boolean	isStartTLSRequired() Gets whether the client is configured to require STARTTLS.
boolean	isTLS() Gets whether the client is configured to try to enable STARTTLS.
String	send() Sends the email.
String	sendMimeMessage() Sends the previously created MimeMessage to the SMTP server.
void	setAuthentication(final String userName, final String password) Sets the userName and password if authentication is needed.
void	setAuthenticator(final Authenticator newAuthenticator) Sets the `Authenticator` to be used when authentication is requested from the mail server.
Email	setBcc(final Collection aCollection) Set a list of "BCC" addresses.
Email	setBounceAddress(final String email) Set the "bounce address" - the address to which undeliverable messages will be returned.
Email	setCc(final Collection aCollection) Set a list of "CC" addresses.
void	setCharset(final String newCharset) Set the charset of the message.
void	setContent(final Object aObject, final String aContentType) Set the content and contentType.
void	setDebug(final boolean d) Setting to true will enable the display of debug information.
Email	setFrom(final String email) Set the FROM field of the email to use the specified address.
Email	setFrom(final String email, final String name) Set the FROM field of the email to use the specified address and the specified personal name.
void	setHeaders(final Map map) Used to specify the mail headers.
void	setHostName(final String aHostName) Set the hostname of the outgoing mail server.
HtmlEmail	setHtmlMsg(final String aHtml) Set the HTML content.
void	setMailSession(final Session aSession) Supply a mail Session object to use.
Email	setMsg(final String msg) Set the message.
Email	setReplyTo(final Collection aCollection) Set a list of reply to addresses.
void	setSentDate(final Date date) Sets the sent date for the email.
void	setSmtpPort(final int aPortNumber) Set the port number of the outgoing mail server.
void	setSocketConnectionTimeout(final int socketConnectionTimeout) Set the socket connection timeout value in milliseconds.
void	setSocketTimeout(final int socketTimeout) Set the socket I/O timeout value in milliseconds.
void	setSSL(final boolean ssl) Sets whether SSL/TLS encryption should be enabled for the SMTP transport upon connection (SMTPS/POPS).
Email	setSSLCheckServerIdentity(final boolean sslCheckServerIdentity) Sets whether the server identity is checked as specified by RFC 2595
Email	setSSLOnConnect(final boolean ssl) Sets whether SSL/TLS encryption should be enabled for the SMTP transport upon connection (SMTPS/POPS).
void	setSslSmtpPort(final String sslSmtpPort) Sets the SSL port to use for the SMTP transport.
Email	setStartTLSEnabled(final boolean startTlsEnabled) Set or disable the STARTTLS encryption.
Email	setStartTLSRequired(final boolean startTlsRequired) Set or disable the required STARTTLS encryption.
Email	setSubject(final String aSubject) Set the email subject.
void	setSubType(final String aSubType) Set the MIME subtype of the email.
HtmlEmail	setTextMsg(final String aText) Set the text content.
void	setTLS(final boolean withTLS) Set or disable the STARTTLS encryption.
Email	setTo(final Collection aCollection) Set a list of "TO" addresses.