- 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
-
- ATTACHMENTS - Static variable in class org.apache.commons.mail.EmailConstants
-
- 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.
- 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
-
- EMAIL_BODY - Static variable in class org.apache.commons.mail.EmailConstants
-
- EMAIL_SUBJECT - Static variable in class org.apache.commons.mail.Email
-
- EMAIL_SUBJECT - Static variable in class org.apache.commons.mail.EmailConstants
-
- 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.
- 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.
- 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.
- getContentType() - Method in class org.apache.commons.mail.ByteArrayDataSource
-
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.
- 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
-
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
-
Get the name.
- getName() - Method in class org.apache.commons.mail.EmailAttachment
-
Get the name.
- getOutputStream() - Method in class org.apache.commons.mail.ByteArrayDataSource
-
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.
- 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=../>" elements in the HTML
code.
- 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 where the key is the
user-defined image name.
- inlineImages - Variable in class org.apache.commons.mail.HtmlEmail
-
- 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
-
- ISO_8859_1 - Static variable in class org.apache.commons.mail.EmailConstants
-
charset constant for iso-8859-1
- isSSL() - Method in class org.apache.commons.mail.Email
-
- 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
-
- MAIL_DEBUG - Static variable in class org.apache.commons.mail.Email
-
- MAIL_DEBUG - Static variable in class org.apache.commons.mail.EmailConstants
-
The debug mode to be used.
- MAIL_HOST - Static variable in class org.apache.commons.mail.Email
-
- MAIL_HOST - Static variable in class org.apache.commons.mail.EmailConstants
-
The host name of the mail server.
- MAIL_PORT - Static variable in class org.apache.commons.mail.Email
-
- 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
-
- 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
-
- 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
-
- 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
-
- MAIL_SMTP_PASSWORD - Static variable in class org.apache.commons.mail.EmailConstants
-
The SMTP password.
- MAIL_SMTP_SOCKET_FACTORY_CLASS - Static variable in class org.apache.commons.mail.Email
-
- MAIL_SMTP_SOCKET_FACTORY_CLASS - Static variable in class org.apache.commons.mail.EmailConstants
-
- MAIL_SMTP_SOCKET_FACTORY_FALLBACK - Static variable in class org.apache.commons.mail.Email
-
- 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
-
- 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
-
- 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
-
- 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
-
- MAIL_SMTP_USER - Static variable in class org.apache.commons.mail.EmailConstants
-
The SMTP user name.
- MAIL_TRANSPORT_PROTOCOL - Static variable in class org.apache.commons.mail.Email
-
- 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
-
- MAIL_TRANSPORT_TLS - Static variable in class org.apache.commons.mail.EmailConstants
-
- 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
-