Index (Apache Commons Email 1.5 API)

A B C D E F G H I K M O P R S T U W

A

addBcc(String) - Method in class org.apache.commons.mail.Email: Add a blind BCC recipient to the email.
addBcc(String...) - Method in class org.apache.commons.mail.Email: Add an array of blind BCC recipients to the email.
addBcc(String, String) - Method in class org.apache.commons.mail.Email: Add a blind BCC recipient to the email using the specified address and the specified personal name.
addBcc(String, String, String) - Method in class org.apache.commons.mail.Email: Add a blind BCC recipient to the email using the specified address, personal name, and charset encoding for the name.
addCc(String) - Method in class org.apache.commons.mail.Email: Add a recipient CC to the email.
addCc(String...) - Method in class org.apache.commons.mail.Email: Add an array of CC recipients to the email.
addCc(String, String) - Method in class org.apache.commons.mail.Email: Add a recipient CC to the email using the specified address and the specified personal name.
addCc(String, String, String) - Method in class org.apache.commons.mail.Email: Add a recipient CC to the email using the specified address, personal name, and charset encoding for the name.
addHeader(String, String) - Method in class org.apache.commons.mail.Email: Adds a header ( name, value ) to the headers Map.
addPart(String, String) - Method in class org.apache.commons.mail.MultiPartEmail: Add a new part to the email.
addPart(MimeMultipart) - Method in class org.apache.commons.mail.MultiPartEmail: Add a new part to the email.
addPart(MimeMultipart, int) - Method in class org.apache.commons.mail.MultiPartEmail: Add a new part to the email.
addReplyTo(String) - Method in class org.apache.commons.mail.Email: Add a reply to address to the email.
addReplyTo(String, String) - Method in class org.apache.commons.mail.Email: Add a reply to address to the email using the specified address and the specified personal name.
addReplyTo(String, String, String) - Method in class org.apache.commons.mail.Email: Add a reply to address to the email using the specified address, personal name, and charset encoding for the name.
addTo(String) - Method in class org.apache.commons.mail.Email: Add a recipient TO to the email.
addTo(String...) - Method in class org.apache.commons.mail.Email: Add a list of TO recipients to the email.
addTo(String, String) - Method in class org.apache.commons.mail.Email: Add a recipient TO to the email using the specified address and the specified personal name.
addTo(String, String, String) - Method in class org.apache.commons.mail.Email: Add a recipient TO to the email using the specified address, personal name, and charset encoding for the name.
attach(File) - Method in class org.apache.commons.mail.MultiPartEmail: Attach a file.
attach(EmailAttachment) - Method in class org.apache.commons.mail.MultiPartEmail: Attach an EmailAttachment.
attach(URL, String, String) - Method in class org.apache.commons.mail.MultiPartEmail: Attach a file located by its URL.
attach(URL, String, String, String) - Method in class org.apache.commons.mail.MultiPartEmail: Attach a file located by its URL.
attach(DataSource, String, String) - Method in class org.apache.commons.mail.MultiPartEmail: Attach a file specified as a DataSource interface.
attach(DataSource, String, String, String) - Method in class org.apache.commons.mail.MultiPartEmail: Attach a file specified as a DataSource interface.
ATTACHMENT - Static variable in class org.apache.commons.mail.EmailAttachment: Definition of the part being an attachment.
ATTACHMENTS - Static variable in class org.apache.commons.mail.Email: Deprecated.
since 1.3, use EmailConstants.ATTACHMENTS instead
ATTACHMENTS - Static variable in class org.apache.commons.mail.EmailConstants: Deprecated.
since 1.3, not in use since 1.0
authenticator - Variable in class org.apache.commons.mail.Email: Instance of an Authenticator object that will be used when authentication is requested from the mail server.

B

bccList - Variable in class org.apache.commons.mail.Email: List of "bcc" email addresses.
bounceAddress - Variable in class org.apache.commons.mail.Email: Address to which undeliverable mail should be sent.
BUFFER_SIZE - Static variable in class org.apache.commons.mail.ByteArrayDataSource: Deprecated.

Define the buffer size.
buildMimeMessage() - Method in class org.apache.commons.mail.Email: Does the work of actually building the MimeMessage.
buildMimeMessage() - Method in class org.apache.commons.mail.HtmlEmail: Does the work of actually building the MimeMessage.
buildMimeMessage() - Method in class org.apache.commons.mail.ImageHtmlEmail: Does the work of actually building the MimeMessage.
buildMimeMessage() - Method in class org.apache.commons.mail.MultiPartEmail: Does the work of actually building the MimeMessage.
ByteArrayDataSource - Class in org.apache.commons.mail: Deprecated.
since 1.4, use ByteArrayDataSource instead
ByteArrayDataSource(byte[], String) - Constructor for class org.apache.commons.mail.ByteArrayDataSource: Deprecated.

Create a datasource from a byte array.
ByteArrayDataSource(InputStream, String) - Constructor for class org.apache.commons.mail.ByteArrayDataSource: Deprecated.

Create a datasource from an input stream.
ByteArrayDataSource(String, String) - Constructor for class org.apache.commons.mail.ByteArrayDataSource: Deprecated.

Create a datasource from a String.

C

ccList - Variable in class org.apache.commons.mail.Email: List of "cc" email addresses.
charset - Variable in class org.apache.commons.mail.Email: The charset to use for this message.
CID_LENGTH - Static variable in class org.apache.commons.mail.HtmlEmail: Definition of the length of generated CID's.
content - Variable in class org.apache.commons.mail.Email: The content.
CONTENT_TYPE - Static variable in class org.apache.commons.mail.Email: Deprecated.
since 1.3, use EmailConstants.CONTENT_TYPE instead
CONTENT_TYPE - Static variable in class org.apache.commons.mail.EmailConstants: Deprecated.
since 1.3, not in use since 1.0
contentType - Variable in class org.apache.commons.mail.Email: The content type.
createBodyPart() - Method in class org.apache.commons.mail.MultiPartEmail: Creates a body part object.
createDataSource(Multipart, MimePart) - Method in class org.apache.commons.mail.util.MimeMessageParser: Parses the MimePart to create a DataSource.
createMimeMessage(Session) - Method in class org.apache.commons.mail.Email: Factory method to create a customized MimeMessage which can be implemented by a derived class, e.g. to set the message id.
createMimeMessage(Session, byte[]) - Static method in class org.apache.commons.mail.util.MimeMessageUtils: Create a MimeMessage.
createMimeMessage(Session, File) - Static method in class org.apache.commons.mail.util.MimeMessageUtils: Create a MimeMessage.
createMimeMessage(Session, InputStream) - Static method in class org.apache.commons.mail.util.MimeMessageUtils: Create a MimeMessage.
createMimeMessage(Session, String) - Static method in class org.apache.commons.mail.util.MimeMessageUtils: Create a MimeMessage using the platform's default character encoding.
createMimeMultipart() - Method in class org.apache.commons.mail.MultiPartEmail: Creates a mime multipart object.
createUrl(String) - Method in class org.apache.commons.mail.resolver.DataSourceUrlResolver: Create an URL based on a base URL and a resource location suitable for loading the resource.

D

DataSourceBaseResolver - Class in org.apache.commons.mail.resolver: Base class for various resolvers.
DataSourceBaseResolver() - Constructor for class org.apache.commons.mail.resolver.DataSourceBaseResolver: Constructor.
DataSourceBaseResolver(boolean) - Constructor for class org.apache.commons.mail.resolver.DataSourceBaseResolver: Constructor.
DataSourceClassPathResolver - Class in org.apache.commons.mail.resolver: Creates a DataSource based on an class path.
DataSourceClassPathResolver() - Constructor for class org.apache.commons.mail.resolver.DataSourceClassPathResolver: Constructor
DataSourceClassPathResolver(String) - Constructor for class org.apache.commons.mail.resolver.DataSourceClassPathResolver: Constructor.
DataSourceClassPathResolver(String, boolean) - Constructor for class org.apache.commons.mail.resolver.DataSourceClassPathResolver: Constructor.
DataSourceCompositeResolver - Class in org.apache.commons.mail.resolver: A composite data source resolver.
DataSourceCompositeResolver(DataSourceResolver[]) - Constructor for class org.apache.commons.mail.resolver.DataSourceCompositeResolver: Constructor.
DataSourceCompositeResolver(DataSourceResolver[], boolean) - Constructor for class org.apache.commons.mail.resolver.DataSourceCompositeResolver: Constructor.
DataSourceFileResolver - Class in org.apache.commons.mail.resolver: Creates a DataSource based on an URL.
DataSourceFileResolver() - Constructor for class org.apache.commons.mail.resolver.DataSourceFileResolver: Constructor.
DataSourceFileResolver(File) - Constructor for class org.apache.commons.mail.resolver.DataSourceFileResolver: Constructor.
DataSourceFileResolver(File, boolean) - Constructor for class org.apache.commons.mail.resolver.DataSourceFileResolver: Constructor.
DataSourceResolver - Interface in org.apache.commons.mail: Creates a DataSource based on an URL.
DataSourceUrlResolver - Class in org.apache.commons.mail.resolver: Creates a DataSource based on an URL.
DataSourceUrlResolver(URL) - Constructor for class org.apache.commons.mail.resolver.DataSourceUrlResolver: Constructor.
DataSourceUrlResolver(URL, boolean) - Constructor for class org.apache.commons.mail.resolver.DataSourceUrlResolver: Constructor.
debug - Variable in class org.apache.commons.mail.Email: Set session debugging on or off.
DefaultAuthenticator - Class in org.apache.commons.mail: This is a very simple authentication object that can be used for any transport needing basic userName and password type authentication.
DefaultAuthenticator(String, String) - Constructor for class org.apache.commons.mail.DefaultAuthenticator: Default constructor.

E

Email - Class in org.apache.commons.mail: The base class for all email messages.
Email() - Constructor for class org.apache.commons.mail.Email
EMAIL_BODY - Static variable in class org.apache.commons.mail.Email: Deprecated.
since 1.3, use EmailConstants.EMAIL_BODY instead
EMAIL_BODY - Static variable in class org.apache.commons.mail.EmailConstants: Deprecated.
since 1.3, not in use since 1.0
EMAIL_SUBJECT - Static variable in class org.apache.commons.mail.Email: Deprecated.
since 1.3, use EmailConstants.EMAIL_SUBJECT instead
EMAIL_SUBJECT - Static variable in class org.apache.commons.mail.EmailConstants: Deprecated.
since 1.3, not in use since 1.0
EmailAttachment - Class in org.apache.commons.mail: This class models an email attachment.
EmailAttachment() - Constructor for class org.apache.commons.mail.EmailAttachment
emailBody - Variable in class org.apache.commons.mail.Email: An attachment.
EmailConstants - Class in org.apache.commons.mail: Constants used by Email classes.
EmailException - Exception in org.apache.commons.mail: Exception thrown when a checked error occurs in commons-email.
EmailException() - Constructor for exception org.apache.commons.mail.EmailException: Constructs a new EmailException with no detail message.
EmailException(String) - Constructor for exception org.apache.commons.mail.EmailException: Constructs a new EmailException with specified detail message.
EmailException(Throwable) - Constructor for exception org.apache.commons.mail.EmailException: Constructs a new EmailException with specified nested Throwable root cause.
EmailException(String, Throwable) - Constructor for exception org.apache.commons.mail.EmailException: Constructs a new EmailException with specified detail message and nested Throwable root cause.
embed(String, String) - Method in class org.apache.commons.mail.HtmlEmail: Attempts to parse the specified String as a URL that will then be embedded in the message.
embed(URL, String) - Method in class org.apache.commons.mail.HtmlEmail: Embeds an URL in the HTML.
embed(File) - Method in class org.apache.commons.mail.HtmlEmail: Embeds a file in the HTML.
embed(File, String) - Method in class org.apache.commons.mail.HtmlEmail: Embeds a file in the HTML.
embed(DataSource, String) - Method in class org.apache.commons.mail.HtmlEmail: Embeds the specified DataSource in the HTML using a randomly generated Content-ID.
embed(DataSource, String, String) - Method in class org.apache.commons.mail.HtmlEmail: Embeds the specified DataSource in the HTML using the specified Content-ID.

F

FILE_SERVER - Static variable in class org.apache.commons.mail.Email: Deprecated.
since 1.3, use EmailConstants.FILE_SERVER instead
FILE_SERVER - Static variable in class org.apache.commons.mail.EmailConstants: Deprecated.
since 1.3, not in use since 1.0
findAttachmentByCid(String) - Method in class org.apache.commons.mail.util.MimeMessageParser: Find an attachment using its content-id.
findAttachmentByName(String) - Method in class org.apache.commons.mail.util.MimeMessageParser: Find an attachment using its name.
fromAddress - Variable in class org.apache.commons.mail.Email: The Address of the sending party, mandatory.

G

getAttachmentList() - Method in class org.apache.commons.mail.util.MimeMessageParser
getBaseDir() - Method in class org.apache.commons.mail.resolver.DataSourceFileResolver: Get the base directory used for resolving relative resource locations.
getBaseUrl() - Method in class org.apache.commons.mail.resolver.DataSourceUrlResolver: Get the base URL used for resolving relative resource locations.
getBcc() - Method in class org.apache.commons.mail.util.MimeMessageParser
getBccAddresses() - Method in class org.apache.commons.mail.Email: Get the list of "Bcc" addresses.
getBounceAddress() - Method in class org.apache.commons.mail.Email: Gets the "bounce address" of this email.
getCc() - Method in class org.apache.commons.mail.util.MimeMessageParser
getCcAddresses() - Method in class org.apache.commons.mail.Email: Get the list of "CC" addresses.
getClassPathBase() - Method in class org.apache.commons.mail.resolver.DataSourceClassPathResolver
getContainer() - Method in class org.apache.commons.mail.MultiPartEmail: Gets the message container.
getContentIds() - Method in class org.apache.commons.mail.util.MimeMessageParser: Returns a collection of all content-ids in the parsed message.
getContentType() - Method in class org.apache.commons.mail.ByteArrayDataSource: Deprecated.

Get the content type.
getDataSourceName(Part, DataSource) - Method in class org.apache.commons.mail.util.MimeMessageParser: Determines the name of the data source if it is not already set.
getDataSourceResolver() - Method in class org.apache.commons.mail.ImageHtmlEmail: Get the data source resolver.
getDataSourceResolvers() - Method in class org.apache.commons.mail.resolver.DataSourceCompositeResolver: Get the underlying data source resolvers.
getDescription() - Method in class org.apache.commons.mail.EmailAttachment: Get the description.
getDisposition() - Method in class org.apache.commons.mail.EmailAttachment: Get the disposition.
getFrom() - Method in class org.apache.commons.mail.util.MimeMessageParser
getFromAddress() - Method in class org.apache.commons.mail.Email: Gets the sender of the email.
getHeader(String) - Method in class org.apache.commons.mail.Email: Gets the specified header.
getHeaders() - Method in class org.apache.commons.mail.Email: Gets all headers on an Email.
getHostName() - Method in class org.apache.commons.mail.Email: Gets the host name of the SMTP server,
getHtmlContent() - Method in class org.apache.commons.mail.util.MimeMessageParser
getInputStream() - Method in class org.apache.commons.mail.ByteArrayDataSource: Deprecated.

Get the input stream.
getMailSession() - Method in class org.apache.commons.mail.Email: Determines the mail session used when sending this Email, creating the Session if necessary.
getMimeMessage() - Method in class org.apache.commons.mail.Email: Returns the internal MimeMessage.
getMimeMessage() - Method in class org.apache.commons.mail.util.MimeMessageParser
getName() - Method in class org.apache.commons.mail.ByteArrayDataSource: Deprecated.

Get the name.
getName() - Method in class org.apache.commons.mail.EmailAttachment: Get the name.
getOutputStream() - Method in class org.apache.commons.mail.ByteArrayDataSource: Deprecated.

Get the OutputStream to write to.
getPasswordAuthentication() - Method in class org.apache.commons.mail.DefaultAuthenticator: Gets the authentication object that will be used to login to the mail server.
getPath() - Method in class org.apache.commons.mail.EmailAttachment: Get the path.
getPlainContent() - Method in class org.apache.commons.mail.util.MimeMessageParser
getPrimaryBodyPart() - Method in class org.apache.commons.mail.MultiPartEmail: Gets first body part of the message.
getReplyTo() - Method in class org.apache.commons.mail.util.MimeMessageParser
getReplyToAddresses() - Method in class org.apache.commons.mail.Email: Get the list of "Reply-To" addresses.
getSentDate() - Method in class org.apache.commons.mail.Email: Gets the sent date for the email.
getSmtpPort() - Method in class org.apache.commons.mail.Email: Gets the listening port of the SMTP server.
getSocketConnectionTimeout() - Method in class org.apache.commons.mail.Email: Get the socket connection timeout value in milliseconds.
getSocketTimeout() - Method in class org.apache.commons.mail.Email: Get the socket I/O timeout value in milliseconds.
getSslSmtpPort() - Method in class org.apache.commons.mail.Email: Returns the current SSL port used by the SMTP transport.
getSubject() - Method in class org.apache.commons.mail.Email: Gets the subject of the email.
getSubject() - Method in class org.apache.commons.mail.util.MimeMessageParser
getSubType() - Method in class org.apache.commons.mail.MultiPartEmail: Get the MIME subtype of the email.
getTo() - Method in class org.apache.commons.mail.util.MimeMessageParser
getToAddresses() - Method in class org.apache.commons.mail.Email: Get the list of "To" addresses.
getURL() - Method in class org.apache.commons.mail.EmailAttachment: Get the URL.

H

hasAttachments() - Method in class org.apache.commons.mail.util.MimeMessageParser
hasHtmlContent() - Method in class org.apache.commons.mail.util.MimeMessageParser
hasPlainContent() - Method in class org.apache.commons.mail.util.MimeMessageParser
headers - Variable in class org.apache.commons.mail.Email: Used to specify the mail headers.
hostName - Variable in class org.apache.commons.mail.Email: The hostname of the mail server with which to connect.
html - Variable in class org.apache.commons.mail.HtmlEmail: Html part of the message.
HtmlEmail - Class in org.apache.commons.mail: An HTML multipart email.
HtmlEmail() - Constructor for class org.apache.commons.mail.HtmlEmail

I

IDNEmailAddressConverter - Class in org.apache.commons.mail.util: Converts email addresses containing International Domain Names into an ASCII representation suitable for sending an email.
IDNEmailAddressConverter() - Constructor for class org.apache.commons.mail.util.IDNEmailAddressConverter
ImageHtmlEmail - Class in org.apache.commons.mail: Small wrapper class on top of HtmlEmail which encapsulates the required logic to retrieve images that are contained in "<img src=..
ImageHtmlEmail() - Constructor for class org.apache.commons.mail.ImageHtmlEmail
init() - Method in class org.apache.commons.mail.MultiPartEmail: Initialize the multipart email.
INLINE - Static variable in class org.apache.commons.mail.EmailAttachment: Definition of the part being inline.
inlineEmbeds - Variable in class org.apache.commons.mail.HtmlEmail: Embedded images Map<String, InlineImage> where the key is the user-defined image name.
inlineImages - Variable in class org.apache.commons.mail.HtmlEmail: Deprecated.
As of commons-email 1.1, no longer used. Inline embedded objects are now stored in HtmlEmail.inlineEmbeds.
isBoolHasAttachments() - Method in class org.apache.commons.mail.MultiPartEmail: Checks whether there are attachments.
isCid(String) - Method in class org.apache.commons.mail.resolver.DataSourceBaseResolver: Is this a content id?
isFileUrl(String) - Method in class org.apache.commons.mail.resolver.DataSourceBaseResolver: Is this a file URL?
isHttpUrl(String) - Method in class org.apache.commons.mail.resolver.DataSourceBaseResolver: Is this a HTTP/HTTPS URL?
isInitialized() - Method in class org.apache.commons.mail.MultiPartEmail: Checks if this object is initialized.
isLenient() - Method in class org.apache.commons.mail.resolver.DataSourceBaseResolver: Shall we ignore resources not found or throw an exception?
isMultipart() - Method in class org.apache.commons.mail.util.MimeMessageParser
ISO_8859_1 - Static variable in class org.apache.commons.mail.Email: Deprecated.
since 1.3, use EmailConstants.ISO_8859_1 instead
ISO_8859_1 - Static variable in class org.apache.commons.mail.EmailConstants: charset constant for iso-8859-1
isSendPartial() - Method in class org.apache.commons.mail.Email: If partial sending of email enabled.
isSSL() - Method in class org.apache.commons.mail.Email: Deprecated.
since 1.3, use isSSLOnConnect() instead
isSSLCheckServerIdentity() - Method in class org.apache.commons.mail.Email: Is the server identity checked as specified by RFC 2595
isSSLOnConnect() - Method in class org.apache.commons.mail.Email: Returns whether SSL/TLS encryption for the transport is currently enabled (SMTPS/POPS).
isStartTLSEnabled() - Method in class org.apache.commons.mail.Email: Gets whether the client is configured to try to enable STARTTLS.
isStartTLSRequired() - Method in class org.apache.commons.mail.Email: Gets whether the client is configured to require STARTTLS.
isTLS() - Method in class org.apache.commons.mail.Email: Deprecated.
since 1.3, use isStartTLSEnabled() instead

K

KOI8_R - Static variable in class org.apache.commons.mail.Email: Deprecated.
since 1.3, use EmailConstants.KOI8_R instead
KOI8_R - Static variable in class org.apache.commons.mail.EmailConstants: charset constant for koi8-r

M

MAIL_DEBUG - Static variable in class org.apache.commons.mail.Email: Deprecated.
since 1.3, use EmailConstants.MAIL_DEBUG instead
MAIL_DEBUG - Static variable in class org.apache.commons.mail.EmailConstants: The debug mode to be used.
MAIL_FROM - Static variable in class org.apache.commons.mail.EmailConstants: The from email address.
MAIL_HOST - Static variable in class org.apache.commons.mail.Email: Deprecated.
since 1.3, use EmailConstants.MAIL_HOST instead
MAIL_HOST - Static variable in class org.apache.commons.mail.EmailConstants: The host name of the mail server.
MAIL_MIME_CHARSET - Static variable in class org.apache.commons.mail.EmailConstants: Defines the default mime charset to use when none has been specified for the message.
MAIL_PORT - Static variable in class org.apache.commons.mail.Email: Deprecated.
since 1.3, use EmailConstants.MAIL_PORT instead
MAIL_PORT - Static variable in class org.apache.commons.mail.EmailConstants: The port number of the mail server.
MAIL_SMTP_AUTH - Static variable in class org.apache.commons.mail.Email: Deprecated.
since 1.3, use EmailConstants.MAIL_SMTP_AUTH instead
MAIL_SMTP_AUTH - Static variable in class org.apache.commons.mail.EmailConstants: If set to true, tries to authenticate the user using the AUTH command.
MAIL_SMTP_CONNECTIONTIMEOUT - Static variable in class org.apache.commons.mail.Email: Deprecated.
since 1.3, use EmailConstants.MAIL_SMTP_CONNECTIONTIMEOUT instead
MAIL_SMTP_CONNECTIONTIMEOUT - Static variable in class org.apache.commons.mail.EmailConstants: Socket connection timeout value in milliseconds.
MAIL_SMTP_FROM - Static variable in class org.apache.commons.mail.Email: Deprecated.
since 1.3, use EmailConstants.MAIL_SMTP_FROM instead
MAIL_SMTP_FROM - Static variable in class org.apache.commons.mail.EmailConstants: The email address to use for SMTP MAIL command.
MAIL_SMTP_PASSWORD - Static variable in class org.apache.commons.mail.Email: Deprecated.
since 1.3, use EmailConstants.MAIL_SMTP_PASSWORD instead
MAIL_SMTP_PASSWORD - Static variable in class org.apache.commons.mail.EmailConstants: The SMTP password.
MAIL_SMTP_SEND_PARTIAL - Static variable in class org.apache.commons.mail.EmailConstants: If set to true, and a message has some valid and some invalid addresses, send the message anyway, reporting the partial failure with a SendFailedException.
MAIL_SMTP_SOCKET_FACTORY_CLASS - Static variable in class org.apache.commons.mail.Email: Deprecated.
since 1.3, use EmailConstants.MAIL_SMTP_SOCKET_FACTORY_CLASS instead
MAIL_SMTP_SOCKET_FACTORY_CLASS - Static variable in class org.apache.commons.mail.EmailConstants: Specifies the SocketFactory class to create smtp sockets.
MAIL_SMTP_SOCKET_FACTORY_FALLBACK - Static variable in class org.apache.commons.mail.Email: Deprecated.
since 1.3, use EmailConstants.MAIL_SMTP_SOCKET_FACTORY_FALLBACK instead
MAIL_SMTP_SOCKET_FACTORY_FALLBACK - Static variable in class org.apache.commons.mail.EmailConstants: Whether to use Socket as a fallback if the initial connection fails or not.
MAIL_SMTP_SOCKET_FACTORY_PORT - Static variable in class org.apache.commons.mail.Email: Deprecated.
since 1.3, use EmailConstants.MAIL_SMTP_SOCKET_FACTORY_PORT instead
MAIL_SMTP_SOCKET_FACTORY_PORT - Static variable in class org.apache.commons.mail.EmailConstants: Specifies the port to connect to when using a socket factory.
MAIL_SMTP_SSL_CHECKSERVERIDENTITY - Static variable in class org.apache.commons.mail.EmailConstants: If set to true, check the server identity as specified in RFC 2595.
MAIL_SMTP_SSL_ENABLE - Static variable in class org.apache.commons.mail.EmailConstants: If set to true, use SSL to connect and use the SSL port by default.
MAIL_SMTP_SSL_SOCKET_FACTORY_CLASS - Static variable in class org.apache.commons.mail.EmailConstants: Specifies the SSLSocketFactory class to use to create SMTP SSL sockets.
MAIL_SMTP_SSL_SOCKET_FACTORY_PORT - Static variable in class org.apache.commons.mail.EmailConstants: Specifies the port to connect to when using the SMTP SSL socket factory.
MAIL_SMTP_TIMEOUT - Static variable in class org.apache.commons.mail.Email: Deprecated.
since 1.3, use EmailConstants.MAIL_SMTP_TIMEOUT instead
MAIL_SMTP_TIMEOUT - Static variable in class org.apache.commons.mail.EmailConstants: Socket I/O timeout value in milliseconds.
MAIL_SMTP_USER - Static variable in class org.apache.commons.mail.Email: Deprecated.
since 1.3, use EmailConstants.MAIL_SMTP_USER instead
MAIL_SMTP_USER - Static variable in class org.apache.commons.mail.EmailConstants: The SMTP user name.
MAIL_SMTPS_SEND_PARTIAL - Static variable in class org.apache.commons.mail.EmailConstants: If set to true, and a message has some valid and some invalid addresses, send the message anyway, reporting the partial failure with a SendFailedException.
MAIL_TRANSPORT_PROTOCOL - Static variable in class org.apache.commons.mail.Email: Deprecated.
since 1.3, use EmailConstants.MAIL_TRANSPORT_PROTOCOL instead
MAIL_TRANSPORT_PROTOCOL - Static variable in class org.apache.commons.mail.EmailConstants: Specifies the default transport protocol
MAIL_TRANSPORT_STARTTLS_ENABLE - Static variable in class org.apache.commons.mail.EmailConstants: Indicates if the STARTTLS command shall be used to initiate a TLS-secured connection.
MAIL_TRANSPORT_STARTTLS_REQUIRED - Static variable in class org.apache.commons.mail.EmailConstants: If true, requires the use of the STARTTLS command.
MAIL_TRANSPORT_TLS - Static variable in class org.apache.commons.mail.Email: Deprecated.
since 1.3, use EmailConstants.MAIL_TRANSPORT_TLS instead
MAIL_TRANSPORT_TLS - Static variable in class org.apache.commons.mail.EmailConstants: Deprecated.
since 1.3
message - Variable in class org.apache.commons.mail.Email: The email message to send.
MimeMessageParser - Class in org.apache.commons.mail.util: Parses a MimeMessage and stores the individual parts such a plain text, HTML text and attachments.
MimeMessageParser(MimeMessage) - Constructor for class org.apache.commons.mail.util.MimeMessageParser: Constructs an instance with the MimeMessage to be extracted.
MimeMessageUtils - Class in org.apache.commons.mail.util: Static helper methods.
MultiPartEmail - Class in org.apache.commons.mail: A multipart email.
MultiPartEmail() - Constructor for class org.apache.commons.mail.MultiPartEmail

O

org.apache.commons.mail - package org.apache.commons.mail: Commons-Email aims to provide a API for sending email.
org.apache.commons.mail.resolver - package org.apache.commons.mail.resolver: Contains implementation classes to resolve data sources from the following locations: class path file system URL
org.apache.commons.mail.util - package org.apache.commons.mail.util: This package provides some utility classes.

P

parse() - Method in class org.apache.commons.mail.util.MimeMessageParser: Does the actual extraction.
parse(Multipart, MimePart) - Method in class org.apache.commons.mail.util.MimeMessageParser: Extracts the content of a MimeMessage recursively.
popBeforeSmtp - Variable in class org.apache.commons.mail.Email: Used to determine whether to use pop3 before smtp, and if so the settings.
popHost - Variable in class org.apache.commons.mail.Email: the host name of the pop3 server.
popPassword - Variable in class org.apache.commons.mail.Email: the password to log into the pop3 server.
popUsername - Variable in class org.apache.commons.mail.Email: the user name to log into the pop3 server.
printStackTrace() - Method in exception org.apache.commons.mail.EmailException: Prints the stack trace of this exception to the standard error stream.
printStackTrace(PrintStream) - Method in exception org.apache.commons.mail.EmailException: Prints the stack trace of this exception to the specified stream.
printStackTrace(PrintWriter) - Method in exception org.apache.commons.mail.EmailException: Prints the stack trace of this exception to the specified writer.

R

RECEIVER_EMAIL - Static variable in class org.apache.commons.mail.Email: Deprecated.
since 1.3, use EmailConstants.RECEIVER_EMAIL instead
RECEIVER_EMAIL - Static variable in class org.apache.commons.mail.EmailConstants: Deprecated.
since 1.3, not in use since 1.0
RECEIVER_NAME - Static variable in class org.apache.commons.mail.Email: Deprecated.
since 1.3, use EmailConstants.RECEIVER_NAME instead
RECEIVER_NAME - Static variable in class org.apache.commons.mail.EmailConstants: Deprecated.
since 1.3, not in use since 1.0
REGEX_IMG_SRC - Static variable in class org.apache.commons.mail.ImageHtmlEmail: Regexp for extracting <img> tags
REGEX_SCRIPT_SRC - Static variable in class org.apache.commons.mail.ImageHtmlEmail: regexp for extracting <script> tags
replyList - Variable in class org.apache.commons.mail.Email: List of "replyTo" email addresses.
resolve(String) - Method in interface org.apache.commons.mail.DataSourceResolver: Resolves the given resource location to a DataSource.
resolve(String, boolean) - Method in interface org.apache.commons.mail.DataSourceResolver: Resolves the given resource location to a DataSource.
resolve(String) - Method in class org.apache.commons.mail.resolver.DataSourceClassPathResolver: Resolves the given resource location to a DataSource.
resolve(String, boolean) - Method in class org.apache.commons.mail.resolver.DataSourceClassPathResolver: Resolves the given resource location to a DataSource.
resolve(String) - Method in class org.apache.commons.mail.resolver.DataSourceCompositeResolver: Resolves the given resource location to a DataSource.
resolve(String, boolean) - Method in class org.apache.commons.mail.resolver.DataSourceCompositeResolver: Resolves the given resource location to a DataSource.
resolve(String) - Method in class org.apache.commons.mail.resolver.DataSourceFileResolver: Resolves the given resource location to a DataSource.
resolve(String, boolean) - Method in class org.apache.commons.mail.resolver.DataSourceFileResolver: Resolves the given resource location to a DataSource.
resolve(String) - Method in class org.apache.commons.mail.resolver.DataSourceUrlResolver: Resolves the given resource location to a DataSource.
resolve(String, boolean) - Method in class org.apache.commons.mail.resolver.DataSourceUrlResolver: Resolves the given resource location to a DataSource.

S

send() - Method in class org.apache.commons.mail.Email: Sends the email.
SENDER_EMAIL - Static variable in class org.apache.commons.mail.Email: Deprecated.
since 1.3, use EmailConstants.SENDER_EMAIL instead
SENDER_EMAIL - Static variable in class org.apache.commons.mail.EmailConstants: Deprecated.
since 1.3, not in use since 1.0
SENDER_NAME - Static variable in class org.apache.commons.mail.Email: Deprecated.
since 1.3, use EmailConstants.SENDER_NAME instead
SENDER_NAME - Static variable in class org.apache.commons.mail.EmailConstants: Deprecated.
since 1.3, not in use since 1.0
sendMimeMessage() - Method in class org.apache.commons.mail.Email: Sends the previously created MimeMessage to the SMTP server.
sentDate - Variable in class org.apache.commons.mail.Email: Sent date.
setAuthentication(String, String) - Method in class org.apache.commons.mail.Email: Sets the userName and password if authentication is needed.
setAuthenticator(Authenticator) - Method in class org.apache.commons.mail.Email: Sets the Authenticator to be used when authentication is requested from the mail server.
setBcc(Collection<InternetAddress>) - Method in class org.apache.commons.mail.Email: Set a list of "BCC" addresses.
setBoolHasAttachments(boolean) - Method in class org.apache.commons.mail.MultiPartEmail: Sets whether there are attachments.
setBounceAddress(String) - Method in class org.apache.commons.mail.Email: Set the "bounce address" - the address to which undeliverable messages will be returned.
setCc(Collection<InternetAddress>) - Method in class org.apache.commons.mail.Email: Set a list of "CC" addresses.
setCharset(String) - Method in class org.apache.commons.mail.Email: Set the charset of the message.
setContent(MimeMultipart) - Method in class org.apache.commons.mail.Email: Set the emailBody to a MimeMultiPart
setContent(Object, String) - Method in class org.apache.commons.mail.Email: Set the content and contentType.
setDataSourceResolver(DataSourceResolver) - Method in class org.apache.commons.mail.ImageHtmlEmail: Set the data source resolver.
setDebug(boolean) - Method in class org.apache.commons.mail.Email: Setting to true will enable the display of debug information.
setDescription(String) - Method in class org.apache.commons.mail.EmailAttachment: Set the description.
setDisposition(String) - Method in class org.apache.commons.mail.EmailAttachment: Set the disposition.
setFrom(String) - Method in class org.apache.commons.mail.Email: Set the FROM field of the email to use the specified address.
setFrom(String, String) - Method in class org.apache.commons.mail.Email: Set the FROM field of the email to use the specified address and the specified personal name.
setFrom(String, String, String) - Method in class org.apache.commons.mail.Email: Set the FROM field of the email to use the specified address, personal name, and charset encoding for the name.
setHeaders(Map<String, String>) - Method in class org.apache.commons.mail.Email: Used to specify the mail headers.
setHostName(String) - Method in class org.apache.commons.mail.Email: Set the hostname of the outgoing mail server.
setHtmlMsg(String) - Method in class org.apache.commons.mail.HtmlEmail: Set the HTML content.
setInitialized(boolean) - Method in class org.apache.commons.mail.MultiPartEmail: Sets the initialized status of this object.
setMailSession(Session) - Method in class org.apache.commons.mail.Email: Supply a mail Session object to use.
setMailSessionFromJNDI(String) - Method in class org.apache.commons.mail.Email: Supply a mail Session object from a JNDI directory.
setMsg(String) - Method in class org.apache.commons.mail.Email: Define the content of the mail.
setMsg(String) - Method in class org.apache.commons.mail.HtmlEmail: Set the message.
setMsg(String) - Method in class org.apache.commons.mail.MultiPartEmail: Set the message of the email.
setMsg(String) - Method in class org.apache.commons.mail.SimpleEmail: Set the content of the mail.
setName(String) - Method in class org.apache.commons.mail.ByteArrayDataSource: Deprecated.

Sets the name for this DataSource.
setName(String) - Method in class org.apache.commons.mail.EmailAttachment: Set the name.
setPath(String) - Method in class org.apache.commons.mail.EmailAttachment: Set the path to the attachment.
setPopBeforeSmtp(boolean, String, String, String) - Method in class org.apache.commons.mail.Email: Set details regarding "pop3 before smtp" authentication.
setReplyTo(Collection<InternetAddress>) - Method in class org.apache.commons.mail.Email: Set a list of reply to addresses.
setSendPartial(boolean) - Method in class org.apache.commons.mail.Email: Sets whether the email is partially send in case of invalid addresses.
setSentDate(Date) - Method in class org.apache.commons.mail.Email: Sets the sent date for the email.
setSmtpPort(int) - Method in class org.apache.commons.mail.Email: Set the non-SSL port number of the outgoing mail server.
setSocketConnectionTimeout(int) - Method in class org.apache.commons.mail.Email: Set the socket connection timeout value in milliseconds.
setSocketTimeout(int) - Method in class org.apache.commons.mail.Email: Set the socket I/O timeout value in milliseconds.
setSSL(boolean) - Method in class org.apache.commons.mail.Email: Deprecated.
since 1.3, use setSSLOnConnect() instead
setSSLCheckServerIdentity(boolean) - Method in class org.apache.commons.mail.Email: Sets whether the server identity is checked as specified by RFC 2595
setSSLOnConnect(boolean) - Method in class org.apache.commons.mail.Email: Sets whether SSL/TLS encryption should be enabled for the SMTP transport upon connection (SMTPS/POPS).
setSslSmtpPort(String) - Method in class org.apache.commons.mail.Email: Sets the SSL port to use for the SMTP transport.
setStartTLSEnabled(boolean) - Method in class org.apache.commons.mail.Email: Set or disable the STARTTLS encryption.
setStartTLSRequired(boolean) - Method in class org.apache.commons.mail.Email: Set or disable the required STARTTLS encryption.
setSubject(String) - Method in class org.apache.commons.mail.Email: Sets the email subject.
setSubType(String) - Method in class org.apache.commons.mail.MultiPartEmail: Set the MIME subtype of the email.
setTextMsg(String) - Method in class org.apache.commons.mail.HtmlEmail: Set the text content.
setTLS(boolean) - Method in class org.apache.commons.mail.Email: Deprecated.
since 1.3, use setStartTLSEnabled() instead
setTo(Collection<InternetAddress>) - Method in class org.apache.commons.mail.Email: Set a list of "TO" addresses.
setURL(URL) - Method in class org.apache.commons.mail.EmailAttachment: Set the URL.
SimpleEmail - Class in org.apache.commons.mail: This class is used to send simple internet email messages without attachments.
SimpleEmail() - Constructor for class org.apache.commons.mail.SimpleEmail
SMTP - Static variable in class org.apache.commons.mail.Email: Deprecated.
since 1.3, use EmailConstants.SMTP instead
SMTP - Static variable in class org.apache.commons.mail.EmailConstants: the value to use SMTP as transport protocol
smtpPort - Variable in class org.apache.commons.mail.Email: The port number of the mail server to connect to.
SOCKET_TIMEOUT_MS - Static variable in class org.apache.commons.mail.EmailConstants: Default socket timeout.
socketConnectionTimeout - Variable in class org.apache.commons.mail.Email: socket connection timeout value in milliseconds.
socketTimeout - Variable in class org.apache.commons.mail.Email: socket I/O timeout value in milliseconds.
ssl - Variable in class org.apache.commons.mail.Email: Deprecated.
since 1.3, use setSSLOnConnect() instead
sslSmtpPort - Variable in class org.apache.commons.mail.Email: The port number of the SSL enabled SMTP server; defaults to the standard port, 465.
subject - Variable in class org.apache.commons.mail.Email: The Subject.

T

text - Variable in class org.apache.commons.mail.HtmlEmail: Text part of the message.
TEXT_HTML - Static variable in class org.apache.commons.mail.Email: Deprecated.
since 1.3, use EmailConstants.TEXT_HTML instead
TEXT_HTML - Static variable in class org.apache.commons.mail.EmailConstants: defines the text/html content type
TEXT_PLAIN - Static variable in class org.apache.commons.mail.Email: Deprecated.
since 1.3, use EmailConstants.TEXT_PLAIN instead
TEXT_PLAIN - Static variable in class org.apache.commons.mail.EmailConstants: defines the text/plain content type
TEXT_SUBTYPE_HTML - Static variable in class org.apache.commons.mail.EmailConstants: defines the html subtype
tls - Variable in class org.apache.commons.mail.Email: Deprecated.
since 1.3, use setStartTLSEnabled() instead
toASCII(String) - Method in class org.apache.commons.mail.util.IDNEmailAddressConverter: Convert an email address to its ASCII representation using "Punycode".
toInternetAddressArray(List<InternetAddress>) - Method in class org.apache.commons.mail.Email: Utility to copy List of known InternetAddress objects into an array.
toList - Variable in class org.apache.commons.mail.Email: List of "to" email addresses.

U

updateContentType(String) - Method in class org.apache.commons.mail.Email: Update the contentType.
US_ASCII - Static variable in class org.apache.commons.mail.Email: Deprecated.
since 1.3, use EmailConstants.US_ASCII instead
US_ASCII - Static variable in class org.apache.commons.mail.EmailConstants: charset constant for us-ascii
UTF_8 - Static variable in class org.apache.commons.mail.EmailConstants: charset constant for utf-8

W

writeMimeMessage(MimeMessage, File) - Static method in class org.apache.commons.mail.util.MimeMessageUtils: Convenience method to write a MimeMessage into a file.

A B C D E F G H I K M O P R S T U W