- addBcc(String) - Method in class org.apache.commons.mail.Email
-
Add a blind BCC recipient 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, 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, 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(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
-
- 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_SUBJECT - Static variable in class org.apache.commons.mail.Email
-
- 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
- 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.
- getBccAddresses() - Method in class org.apache.commons.mail.Email
-
Get the list of "Bcc" addresses.
- getCause() - Method in exception org.apache.commons.mail.EmailException
-
Gets the cause of this throwable.
- getCcAddresses() - Method in class org.apache.commons.mail.Email
-
Get the list of "CC" addresses.
- 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.
- getDescription() - Method in class org.apache.commons.mail.EmailAttachment
-
Get the description.
- getDisposition() - Method in class org.apache.commons.mail.EmailAttachment
-
Get the disposition.
- 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,
- getInputStream() - Method in class org.apache.commons.mail.ByteArrayDataSource
-
Get the input stream.
- getMailSession() - Method in class org.apache.commons.mail.Email
-
Initialise a mailsession object
- getMimeMessage() - Method in class org.apache.commons.mail.Email
-
Returns the internal MimeMessage.
- 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.
- getPrimaryBodyPart() - Method in class org.apache.commons.mail.MultiPartEmail
-
Gets first body part of the message.
- 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.
- getSubType() - Method in class org.apache.commons.mail.MultiPartEmail
-
Get the MIME subtype of the email.
- 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.
- send() - Method in class org.apache.commons.mail.Email
-
Sends the email.
- SENDER_EMAIL - Static variable in class org.apache.commons.mail.Email
-
- SENDER_NAME - Static variable in class org.apache.commons.mail.Email
-
- 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) - 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) - 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 & contentType
- 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) - 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.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) - Method in class org.apache.commons.mail.Email
-
Set a list of reply to 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 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
-
Sets whether SSL encryption should be enabled for the SMTP transport.
- setSslSmtpPort(String) - Method in class org.apache.commons.mail.Email
-
Sets the SSL port to use for the SMTP transport.
- setSubject(String) - Method in class org.apache.commons.mail.Email
-
Set 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
-
Set or disable the TLS encryption
- setTo(Collection) - 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
-
- smtpPort - Variable in class org.apache.commons.mail.Email
-
The port number of the mail server to connect to.
- 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
-
does the current transport use SSL encryption?
- 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