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

A

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.

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.

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.

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.

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.

B

bccList - Variable in class org.apache.commons.mail.Email

List of "bcc" email adresses

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

define the buffer size

buildMimeMessage() - Method in class org.apache.commons.mail.Email

Build the internal MimeMessage to be sent.

buildMimeMessage() - Method in class org.apache.commons.mail.HtmlEmail

Does the work of actually building the email.

buildMimeMessage() - Method in class org.apache.commons.mail.MultiPartEmail

Builds the actual MimeMessage

ByteArrayDataSource - Class in org.apache.commons.mail

This class implements a typed DataSource from:
- an InputStream
- a byte array
- a String

ByteArrayDataSource(byte[], String) - Constructor for class org.apache.commons.mail.ByteArrayDataSource

Create a datasource from a byte array.

ByteArrayDataSource(InputStream, String) - Constructor for class org.apache.commons.mail.ByteArrayDataSource

Create a datasource from an input stream.

ByteArrayDataSource(String, String) - Constructor for class org.apache.commons.mail.ByteArrayDataSource

Create a datasource from a String.

C

ccList - Variable in class org.apache.commons.mail.Email

List of "cc" email adresses

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

contentType - Variable in class org.apache.commons.mail.Email

The content type

createBodyPart() - Method in class org.apache.commons.mail.MultiPartEmail

Method that can be overridden if you don't want to create a MimeBodyPart.

createMimeMultipart() - Method in class org.apache.commons.mail.MultiPartEmail

D

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

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(URL, String) - Method in class org.apache.commons.mail.HtmlEmail

Embeds an URL in the HTML.

F

FILE_SERVER - Static variable in class org.apache.commons.mail.Email

fromAddress - Variable in class org.apache.commons.mail.Email

The Address of the sending party, mandatory

G

getCause() - Method in exception org.apache.commons.mail.EmailException

Gets the cause of this throwable.

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.

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.

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.

getURL() - Method in class org.apache.commons.mail.EmailAttachment

Get the URL.

H

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

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

inlineImages - Variable in class org.apache.commons.mail.HtmlEmail

Embedded images

isBoolHasAttachments() - Method in class org.apache.commons.mail.MultiPartEmail

isInitialized() - Method in class org.apache.commons.mail.MultiPartEmail

ISO_8859_1 - Static variable in class org.apache.commons.mail.Email

K

KOI8_R - Static variable in class org.apache.commons.mail.Email

M

MAIL_DEBUG - Static variable in class org.apache.commons.mail.Email

MAIL_HOST - Static variable in class org.apache.commons.mail.Email

MAIL_PORT - Static variable in class org.apache.commons.mail.Email

MAIL_SMTP_AUTH - Static variable in class org.apache.commons.mail.Email

MAIL_SMTP_FROM - Static variable in class org.apache.commons.mail.Email

MAIL_TRANSPORT_PROTOCOL - Static variable in class org.apache.commons.mail.Email

message - Variable in class org.apache.commons.mail.Email

The email message to send.

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.

P

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

RECEIVER_NAME - Static variable in class org.apache.commons.mail.Email

replyList - Variable in class org.apache.commons.mail.Email

List of "replyTo" email adresses

S

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

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.

setFrom(String, String) - Method in class org.apache.commons.mail.Email

Set the FROM field of the email.

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

setMailSession(Session) - Method in class org.apache.commons.mail.Email

Supply a mail Session object to use

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.

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.

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.

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.

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

TEXT_PLAIN - Static variable in class org.apache.commons.mail.Email

toInternetAddressArray(List) - 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 adresses

U

US_ASCII - Static variable in class org.apache.commons.mail.Email

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