Index
All Classes and Interfaces|All Packages|Constant Field Values
A
- addBcc(String) - Method in class org.apache.commons.mail2.jakarta.Email
-
Adds a blind BCC recipient to the email.
- addBcc(String...) - Method in class org.apache.commons.mail2.jakarta.Email
-
Adds an array of blind BCC recipients to the email.
- addBcc(String, String) - Method in class org.apache.commons.mail2.jakarta.Email
-
Adds 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.mail2.jakarta.Email
-
Adds 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.mail2.jakarta.Email
-
Adds a recipient CC to the email.
- addCc(String...) - Method in class org.apache.commons.mail2.jakarta.Email
-
Adds an array of CC recipients to the email.
- addCc(String, String) - Method in class org.apache.commons.mail2.jakarta.Email
-
Adds 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.mail2.jakarta.Email
-
Adds 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.mail2.jakarta.Email
-
Adds a header ( name, value ) to the headers Map.
- addPart(MimeMultipart) - Method in class org.apache.commons.mail2.jakarta.MultiPartEmail
-
Adds a new part to the email.
- addPart(MimeMultipart, int) - Method in class org.apache.commons.mail2.jakarta.MultiPartEmail
-
Adds a new part to the email.
- addPart(String, String) - Method in class org.apache.commons.mail2.jakarta.MultiPartEmail
-
Adds a new part to the email.
- addReplyTo(String) - Method in class org.apache.commons.mail2.jakarta.Email
-
Adds a reply to address to the email.
- addReplyTo(String, String) - Method in class org.apache.commons.mail2.jakarta.Email
-
Adds 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.mail2.jakarta.Email
-
Adds 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.mail2.jakarta.Email
-
Adds a recipient TO to the email.
- addTo(String...) - Method in class org.apache.commons.mail2.jakarta.Email
-
Adds a list of TO recipients to the email.
- addTo(String, String) - Method in class org.apache.commons.mail2.jakarta.Email
-
Adds 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.mail2.jakarta.Email
-
Adds a recipient TO to the email using the specified address, personal name, and charset encoding for the name.
- attach(DataSource, String, String) - Method in class org.apache.commons.mail2.jakarta.MultiPartEmail
-
Attaches a file specified as a DataSource interface.
- attach(DataSource, String, String, String) - Method in class org.apache.commons.mail2.jakarta.MultiPartEmail
-
Attaches a file specified as a DataSource interface.
- attach(File) - Method in class org.apache.commons.mail2.jakarta.MultiPartEmail
-
Attaches a file.
- attach(URL, String, String) - Method in class org.apache.commons.mail2.jakarta.MultiPartEmail
-
Attaches a file located by its URL.
- attach(URL, String, String, String) - Method in class org.apache.commons.mail2.jakarta.MultiPartEmail
-
Attaches a file located by its URL.
- attach(Path, OpenOption...) - Method in class org.apache.commons.mail2.jakarta.MultiPartEmail
-
Attaches a path.
- attach(EmailAttachment) - Method in class org.apache.commons.mail2.jakarta.MultiPartEmail
-
Attaches an EmailAttachment.
- ATTACHMENT - Static variable in class org.apache.commons.mail2.jakarta.EmailAttachment
-
Definition of the part being an attachment.
B
- buildMimeMessage() - Method in class org.apache.commons.mail2.jakarta.Email
-
Builds the MimeMessage.
- buildMimeMessage() - Method in class org.apache.commons.mail2.jakarta.HtmlEmail
-
Builds the MimeMessage.
- buildMimeMessage() - Method in class org.apache.commons.mail2.jakarta.ImageHtmlEmail
-
Does the work of actually building the MimeMessage.
- buildMimeMessage() - Method in class org.apache.commons.mail2.jakarta.MultiPartEmail
-
Builds the MimeMessage.
C
- CID_LENGTH - Static variable in class org.apache.commons.mail2.jakarta.HtmlEmail
-
Definition of the length of generated CID's.
- createBodyPart() - Method in class org.apache.commons.mail2.jakarta.MultiPartEmail
-
Creates a body part object.
- createDataSource(Multipart, MimePart) - Method in class org.apache.commons.mail2.jakarta.util.MimeMessageParser
-
Parses the MimePart to create a DataSource.
- createMimeMessage(Session) - Method in class org.apache.commons.mail2.jakarta.Email
-
Creates a customized MimeMessage which can be implemented by a derived class, e.g.
- createMimeMessage(Session, byte[]) - Static method in class org.apache.commons.mail2.jakarta.util.MimeMessageUtils
-
Creates a MimeMessage.
- createMimeMessage(Session, File) - Static method in class org.apache.commons.mail2.jakarta.util.MimeMessageUtils
-
Creates a MimeMessage.
- createMimeMessage(Session, InputStream) - Static method in class org.apache.commons.mail2.jakarta.util.MimeMessageUtils
-
Creates a MimeMessage.
- createMimeMessage(Session, String) - Static method in class org.apache.commons.mail2.jakarta.util.MimeMessageUtils
-
Creates a MimeMessage using the platform's default character encoding.
- createMimeMessage(Session, Path, OpenOption...) - Static method in class org.apache.commons.mail2.jakarta.util.MimeMessageUtils
-
Creates a MimeMessage.
- createMimeMultipart() - Method in class org.apache.commons.mail2.jakarta.MultiPartEmail
-
Creates a mime multipart object.
- createUrl(String) - Method in class org.apache.commons.mail2.jakarta.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.mail2.jakarta.resolver
-
Abstract class for resolvers.
- DataSourceBaseResolver() - Constructor for class org.apache.commons.mail2.jakarta.resolver.DataSourceBaseResolver
-
Constructs a new instance.
- DataSourceBaseResolver(boolean) - Constructor for class org.apache.commons.mail2.jakarta.resolver.DataSourceBaseResolver
-
Constructs a new instance.
- DataSourceClassPathResolver - Class in org.apache.commons.mail2.jakarta.resolver
-
Creates a
DataSource
based on an class path. - DataSourceClassPathResolver() - Constructor for class org.apache.commons.mail2.jakarta.resolver.DataSourceClassPathResolver
-
Constructs a new instance.
- DataSourceClassPathResolver(String) - Constructor for class org.apache.commons.mail2.jakarta.resolver.DataSourceClassPathResolver
-
Constructs a new instance.
- DataSourceClassPathResolver(String, boolean) - Constructor for class org.apache.commons.mail2.jakarta.resolver.DataSourceClassPathResolver
-
Constructs a new instance.
- DataSourceCompositeResolver - Class in org.apache.commons.mail2.jakarta.resolver
-
A composite data source resolver.
- DataSourceCompositeResolver(DataSourceResolver[]) - Constructor for class org.apache.commons.mail2.jakarta.resolver.DataSourceCompositeResolver
-
Constructs a new instance.
- DataSourceCompositeResolver(DataSourceResolver[], boolean) - Constructor for class org.apache.commons.mail2.jakarta.resolver.DataSourceCompositeResolver
-
Constructs a new instance.
- DataSourceFileResolver - Class in org.apache.commons.mail2.jakarta.resolver
-
Creates a
DataSource
based on a File. - DataSourceFileResolver() - Constructor for class org.apache.commons.mail2.jakarta.resolver.DataSourceFileResolver
-
Constructs a new instance.
- DataSourceFileResolver(File) - Constructor for class org.apache.commons.mail2.jakarta.resolver.DataSourceFileResolver
-
Constructs a new instance.
- DataSourceFileResolver(File, boolean) - Constructor for class org.apache.commons.mail2.jakarta.resolver.DataSourceFileResolver
-
Constructs a new instance.
- DataSourcePathResolver - Class in org.apache.commons.mail2.jakarta.resolver
-
Creates a
DataSource
based on aPath
. - DataSourcePathResolver() - Constructor for class org.apache.commons.mail2.jakarta.resolver.DataSourcePathResolver
-
Constructs a new instance.
- DataSourcePathResolver(Path) - Constructor for class org.apache.commons.mail2.jakarta.resolver.DataSourcePathResolver
-
Constructs a new instance.
- DataSourcePathResolver(Path, boolean, OpenOption...) - Constructor for class org.apache.commons.mail2.jakarta.resolver.DataSourcePathResolver
-
Constructs a new instance.
- DataSourceResolver - Interface in org.apache.commons.mail2.jakarta
-
Creates a
DataSource
based on an URL. - DataSourceUrlResolver - Class in org.apache.commons.mail2.jakarta.resolver
-
Creates a
DataSource
based on an URL. - DataSourceUrlResolver(URL) - Constructor for class org.apache.commons.mail2.jakarta.resolver.DataSourceUrlResolver
-
Constructs a new instance.
- DataSourceUrlResolver(URL, boolean) - Constructor for class org.apache.commons.mail2.jakarta.resolver.DataSourceUrlResolver
-
Constructs a new instance.
- DefaultAuthenticator - Class in org.apache.commons.mail2.jakarta
-
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.mail2.jakarta.DefaultAuthenticator
-
Default constructor.
E
- Email - Class in org.apache.commons.mail2.jakarta
-
The abstract class for all email messages.
- Email() - Constructor for class org.apache.commons.mail2.jakarta.Email
-
Constructs a new instance.
- EmailAttachment - Class in org.apache.commons.mail2.jakarta
-
This class models an email attachment.
- EmailAttachment() - Constructor for class org.apache.commons.mail2.jakarta.EmailAttachment
-
Constructs a new instance.
- embed(DataSource, String) - Method in class org.apache.commons.mail2.jakarta.HtmlEmail
-
Embeds the specified
DataSource
in the HTML using a randomly generated Content-ID. - embed(DataSource, String, String) - Method in class org.apache.commons.mail2.jakarta.HtmlEmail
-
Embeds the specified
DataSource
in the HTML using the specified Content-ID. - embed(File) - Method in class org.apache.commons.mail2.jakarta.HtmlEmail
-
Embeds a file in the HTML.
- embed(File, String) - Method in class org.apache.commons.mail2.jakarta.HtmlEmail
-
Embeds a file in the HTML.
- embed(String, String) - Method in class org.apache.commons.mail2.jakarta.HtmlEmail
-
Parses the specified
String
as a URL that will then be embedded in the message. - embed(URL, String) - Method in class org.apache.commons.mail2.jakarta.HtmlEmail
-
Embeds an URL in the HTML.
F
- findAttachmentByCid(String) - Method in class org.apache.commons.mail2.jakarta.util.MimeMessageParser
-
Find an attachment using its content-id.
- findAttachmentByName(String) - Method in class org.apache.commons.mail2.jakarta.util.MimeMessageParser
-
Find an attachment using its name.
G
- getAttachmentList() - Method in class org.apache.commons.mail2.jakarta.util.MimeMessageParser
-
Gets the attachment list.
- getAuthenticator() - Method in class org.apache.commons.mail2.jakarta.Email
-
Gets the authenticator.
- getBaseDir() - Method in class org.apache.commons.mail2.jakarta.resolver.DataSourceFileResolver
-
Gets the base directory used for resolving relative resource locations.
- getBaseDir() - Method in class org.apache.commons.mail2.jakarta.resolver.DataSourcePathResolver
-
Gets the base directory used for resolving relative resource locations.
- getBaseUrl() - Method in class org.apache.commons.mail2.jakarta.resolver.DataSourceUrlResolver
-
Gets the base URL used for resolving relative resource locations.
- getBcc() - Method in class org.apache.commons.mail2.jakarta.util.MimeMessageParser
-
Gets the BCC Address list.
- getBccAddresses() - Method in class org.apache.commons.mail2.jakarta.Email
-
Gets the list of "Bcc" addresses.
- getBounceAddress() - Method in class org.apache.commons.mail2.jakarta.Email
-
Gets the "bounce address" of this email.
- getCc() - Method in class org.apache.commons.mail2.jakarta.util.MimeMessageParser
-
Gets the CC Address list.
- getCcAddresses() - Method in class org.apache.commons.mail2.jakarta.Email
-
Gets the list of "CC" addresses.
- getCharsetName() - Method in class org.apache.commons.mail2.jakarta.Email
-
Gets the Charset.
- getClassPathBase() - Method in class org.apache.commons.mail2.jakarta.resolver.DataSourceClassPathResolver
-
Gets the class path base.
- getContainer() - Method in class org.apache.commons.mail2.jakarta.MultiPartEmail
-
Gets the message container.
- getContent() - Method in class org.apache.commons.mail2.jakarta.Email
-
Gets the content.
- getContentIds() - Method in class org.apache.commons.mail2.jakarta.util.MimeMessageParser
-
Returns a collection of all content-ids in the parsed message.
- getContentType() - Method in class org.apache.commons.mail2.jakarta.activation.InputStreamDataSource
- getContentType() - Method in class org.apache.commons.mail2.jakarta.activation.PathDataSource
-
Gets the MIME type of the data as a String.
- getContentType() - Method in class org.apache.commons.mail2.jakarta.Email
-
Gets the content type.
- getDataSourceName(Part, DataSource) - Method in class org.apache.commons.mail2.jakarta.util.MimeMessageParser
-
Determines the name of the data source if it is not already set.
- getDataSourceResolver() - Method in class org.apache.commons.mail2.jakarta.ImageHtmlEmail
-
Gets the data source resolver.
- getDataSourceResolvers() - Method in class org.apache.commons.mail2.jakarta.resolver.DataSourceCompositeResolver
-
Gets the underlying data source resolvers.
- getDescription() - Method in class org.apache.commons.mail2.jakarta.EmailAttachment
-
Gets the description.
- getDisposition() - Method in class org.apache.commons.mail2.jakarta.EmailAttachment
-
Gets the disposition.
- getEmailBody() - Method in class org.apache.commons.mail2.jakarta.Email
-
Gets the email body.
- getFrom() - Method in class org.apache.commons.mail2.jakarta.util.MimeMessageParser
-
Gets the FROM field.
- getFromAddress() - Method in class org.apache.commons.mail2.jakarta.Email
-
Gets the sender of the email.
- getHeader(String) - Method in class org.apache.commons.mail2.jakarta.Email
-
Gets the specified header.
- getHeaders() - Method in class org.apache.commons.mail2.jakarta.Email
-
Gets all headers on an Email.
- getHostName() - Method in class org.apache.commons.mail2.jakarta.Email
-
Gets the host name of the SMTP server,
- getHtml() - Method in class org.apache.commons.mail2.jakarta.HtmlEmail
-
Gets the HTML content.
- getHtmlContent() - Method in class org.apache.commons.mail2.jakarta.util.MimeMessageParser
-
Gets the htmlContent if any.
- getInputStream() - Method in class org.apache.commons.mail2.jakarta.activation.InputStreamDataSource
- getInputStream() - Method in class org.apache.commons.mail2.jakarta.activation.PathDataSource
-
Gets an InputStream representing the the data and will throw an IOException if it can not do so.
- getMailSession() - Method in class org.apache.commons.mail2.jakarta.Email
-
Gets the mail session used when sending this Email, creating the Session if necessary.
- getMessage() - Method in class org.apache.commons.mail2.jakarta.Email
-
Gets the message.
- getMimeMessage() - Method in class org.apache.commons.mail2.jakarta.Email
-
Gets the internal MimeMessage.
- getMimeMessage() - Method in class org.apache.commons.mail2.jakarta.util.MimeMessageParser
-
Gets the MimeMessage.
- getName() - Method in class org.apache.commons.mail2.jakarta.activation.InputStreamDataSource
- getName() - Method in class org.apache.commons.mail2.jakarta.activation.PathDataSource
-
Gets the name of this object.
- getName() - Method in class org.apache.commons.mail2.jakarta.EmailAttachment
-
Gets the name.
- getOutputStream() - Method in class org.apache.commons.mail2.jakarta.activation.InputStreamDataSource
-
Always throws
UnsupportedOperationException
. - getOutputStream() - Method in class org.apache.commons.mail2.jakarta.activation.PathDataSource
-
Gets an OutputStream representing the the data and will throw an IOException if it can not do so.
- getPasswordAuthentication() - Method in class org.apache.commons.mail2.jakarta.DefaultAuthenticator
-
Gets the authentication object that will be used to login to the mail server.
- getPath() - Method in class org.apache.commons.mail2.jakarta.activation.PathDataSource
-
Gets the File object that corresponds to this PathDataSource.
- getPath() - Method in class org.apache.commons.mail2.jakarta.EmailAttachment
-
Gets the path.
- getPlainContent() - Method in class org.apache.commons.mail2.jakarta.util.MimeMessageParser
-
Gets the plain content if any.
- getPopHost() - Method in class org.apache.commons.mail2.jakarta.Email
-
Gets the POP3 host.
- getPopPassword() - Method in class org.apache.commons.mail2.jakarta.Email
-
Gets the POP3 password.
- getPopUserName() - Method in class org.apache.commons.mail2.jakarta.Email
-
Gets the POP3 user name.
- getPrimaryBodyPart() - Method in class org.apache.commons.mail2.jakarta.MultiPartEmail
-
Gets first body part of the message.
- getReplyTo() - Method in class org.apache.commons.mail2.jakarta.util.MimeMessageParser
-
Gets the 'replyTo' address of the email.
- getReplyToAddresses() - Method in class org.apache.commons.mail2.jakarta.Email
-
Gets the list of "Reply-To" addresses.
- getSentDate() - Method in class org.apache.commons.mail2.jakarta.Email
-
Gets the sent date for the email.
- getSmtpPort() - Method in class org.apache.commons.mail2.jakarta.Email
-
Gets the listening port of the SMTP server.
- getSocketConnectionTimeout() - Method in class org.apache.commons.mail2.jakarta.Email
-
Gets the socket connection timeout value in milliseconds.
- getSocketTimeout() - Method in class org.apache.commons.mail2.jakarta.Email
-
Gets the socket I/O timeout value in milliseconds.
- getSslSmtpPort() - Method in class org.apache.commons.mail2.jakarta.Email
-
Gets the current SSL port used by the SMTP transport.
- getSubject() - Method in class org.apache.commons.mail2.jakarta.Email
-
Gets the subject of the email.
- getSubject() - Method in class org.apache.commons.mail2.jakarta.util.MimeMessageParser
-
Gets the MIME message subject.
- getSubType() - Method in class org.apache.commons.mail2.jakarta.MultiPartEmail
-
Gets the MIME subtype of the email.
- getText() - Method in class org.apache.commons.mail2.jakarta.HtmlEmail
-
Gets the message text.
- getTo() - Method in class org.apache.commons.mail2.jakarta.util.MimeMessageParser
-
Gets the MIME message 'to' list.
- getToAddresses() - Method in class org.apache.commons.mail2.jakarta.Email
-
Gets the list of "To" addresses.
- getURL() - Method in class org.apache.commons.mail2.jakarta.EmailAttachment
-
Gets the URL.
H
- hasAttachments() - Method in class org.apache.commons.mail2.jakarta.util.MimeMessageParser
-
Tests if attachments are present.
- hasHtmlContent() - Method in class org.apache.commons.mail2.jakarta.util.MimeMessageParser
-
Tests is HTML content is present.
- hasPlainContent() - Method in class org.apache.commons.mail2.jakarta.util.MimeMessageParser
-
Tests is plain content is present.
- HtmlEmail - Class in org.apache.commons.mail2.jakarta
-
An HTML multipart email.
- HtmlEmail() - Constructor for class org.apache.commons.mail2.jakarta.HtmlEmail
-
Constructs a new instance.
I
- IDNEmailAddressConverter - Class in org.apache.commons.mail2.jakarta.util
-
Converts email addresses containing International Domain Names into an ASCII representation suitable for sending an email.
- IDNEmailAddressConverter() - Constructor for class org.apache.commons.mail2.jakarta.util.IDNEmailAddressConverter
-
Constructs a new instance.
- ImageHtmlEmail - Class in org.apache.commons.mail2.jakarta
-
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.mail2.jakarta.ImageHtmlEmail
-
Constructs a new instance.
- init() - Method in class org.apache.commons.mail2.jakarta.MultiPartEmail
-
Initialize the multipart email.
- INLINE - Static variable in class org.apache.commons.mail2.jakarta.EmailAttachment
-
Definition of the part being inline.
- InputStreamDataSource - Class in org.apache.commons.mail2.jakarta.activation
-
A JavaBeans Activation Framework
DataSource
specialized forInputStream
. - InputStreamDataSource(InputStream, String) - Constructor for class org.apache.commons.mail2.jakarta.activation.InputStreamDataSource
-
Constructs a new instance.
- InputStreamDataSource(InputStream, String, String) - Constructor for class org.apache.commons.mail2.jakarta.activation.InputStreamDataSource
-
Constructs a new instance.
- isBoolHasAttachments() - Method in class org.apache.commons.mail2.jakarta.MultiPartEmail
-
Tests whether there are attachments.
- isCid(String) - Method in class org.apache.commons.mail2.jakarta.resolver.DataSourceBaseResolver
-
Tests whether the argument is a content id.
- isDebug() - Method in class org.apache.commons.mail2.jakarta.Email
-
Tests whether debug is on.
- isFileUrl(String) - Method in class org.apache.commons.mail2.jakarta.resolver.DataSourceBaseResolver
-
Tests whether this a file URL.
- isHttpUrl(String) - Method in class org.apache.commons.mail2.jakarta.resolver.DataSourceBaseResolver
-
Tests whether this a HTTP or HTTPS URL.
- isInitialized() - Method in class org.apache.commons.mail2.jakarta.MultiPartEmail
-
Tests if this object is initialized.
- isLenient() - Method in class org.apache.commons.mail2.jakarta.resolver.DataSourceBaseResolver
-
Tests whether to ignore resources not found or throw an exception.
- isMultipart() - Method in class org.apache.commons.mail2.jakarta.util.MimeMessageParser
-
Tests whether this is multipart.
- isPopBeforeSmtp() - Method in class org.apache.commons.mail2.jakarta.Email
-
Tests whether to use POP3 before SMTP, and if so the settings.
- isSendPartial() - Method in class org.apache.commons.mail2.jakarta.Email
-
Tests whether partial sending of email is enabled.
- isSSLCheckServerIdentity() - Method in class org.apache.commons.mail2.jakarta.Email
-
Tests whether the server identity checked as specified by RFC 2595
- isSSLOnConnect() - Method in class org.apache.commons.mail2.jakarta.Email
-
Tests whether SSL/TLS encryption for the transport is currently enabled (SMTPS/POPS).
- isStartTLSEnabled() - Method in class org.apache.commons.mail2.jakarta.Email
-
Tests whether the client is configured to try to enable STARTTLS.
- isStartTLSRequired() - Method in class org.apache.commons.mail2.jakarta.Email
-
Tests whether the client is configured to require STARTTLS.
M
- MimeMessageParser - Class in org.apache.commons.mail2.jakarta.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.mail2.jakarta.util.MimeMessageParser
-
Constructs an instance with the MimeMessage to be extracted.
- MimeMessageUtils - Class in org.apache.commons.mail2.jakarta.util
-
Creates
MimeMessage
instances and other helper methods. - MultiPartEmail - Class in org.apache.commons.mail2.jakarta
-
A multipart email.
- MultiPartEmail() - Constructor for class org.apache.commons.mail2.jakarta.MultiPartEmail
-
Constructs a new instance.
O
- org.apache.commons.mail2.jakarta - package org.apache.commons.mail2.jakarta
-
Commons-Email aims to provide a API for sending email.
- org.apache.commons.mail2.jakarta.activation - package org.apache.commons.mail2.jakarta.activation
-
Contains JavaBeans Activation Framework implementations.
- org.apache.commons.mail2.jakarta.resolver - package org.apache.commons.mail2.jakarta.resolver
-
Contains implementation classes to resolve data sources from the following locations: class path file system URL
- org.apache.commons.mail2.jakarta.util - package org.apache.commons.mail2.jakarta.util
-
This package provides some utility classes.
P
- parse() - Method in class org.apache.commons.mail2.jakarta.util.MimeMessageParser
-
Does the actual extraction.
- parse(Multipart, MimePart) - Method in class org.apache.commons.mail2.jakarta.util.MimeMessageParser
-
Extracts the content of a MimeMessage recursively.
- PathDataSource - Class in org.apache.commons.mail2.jakarta.activation
-
A JavaBeans Activation Framework
DataSource
that encapsulates aPath
. - PathDataSource(Path) - Constructor for class org.apache.commons.mail2.jakarta.activation.PathDataSource
-
Creates a new instance from a Path.
- PathDataSource(Path, FileTypeMap, OpenOption...) - Constructor for class org.apache.commons.mail2.jakarta.activation.PathDataSource
-
Creates a new instance from a Path.
R
- REGEX_IMG_SRC - Static variable in class org.apache.commons.mail2.jakarta.ImageHtmlEmail
-
Regexp for extracting
<img>
tags - REGEX_SCRIPT_SRC - Static variable in class org.apache.commons.mail2.jakarta.ImageHtmlEmail
-
Regexp for extracting
<script>
tags - resolve(String) - Method in interface org.apache.commons.mail2.jakarta.DataSourceResolver
-
Resolves the given resource location to a
DataSource
. - resolve(String) - Method in class org.apache.commons.mail2.jakarta.resolver.DataSourceClassPathResolver
-
Resolves the given resource location to a
DataSource
. - resolve(String) - Method in class org.apache.commons.mail2.jakarta.resolver.DataSourceCompositeResolver
-
Resolves the given resource location to a
DataSource
. - resolve(String) - Method in class org.apache.commons.mail2.jakarta.resolver.DataSourceFileResolver
-
Resolves the given resource location to a
DataSource
. - resolve(String) - Method in class org.apache.commons.mail2.jakarta.resolver.DataSourcePathResolver
-
Resolves the given resource location to a
DataSource
. - resolve(String) - Method in class org.apache.commons.mail2.jakarta.resolver.DataSourceUrlResolver
-
Resolves the given resource location to a
DataSource
. - resolve(String, boolean) - Method in interface org.apache.commons.mail2.jakarta.DataSourceResolver
-
Resolves the given resource location to a
DataSource
. - resolve(String, boolean) - Method in class org.apache.commons.mail2.jakarta.resolver.DataSourceClassPathResolver
-
Resolves the given resource location to a
DataSource
. - resolve(String, boolean) - Method in class org.apache.commons.mail2.jakarta.resolver.DataSourceCompositeResolver
-
Resolves the given resource location to a
DataSource
. - resolve(String, boolean) - Method in class org.apache.commons.mail2.jakarta.resolver.DataSourceFileResolver
-
Resolves the given resource location to a
DataSource
. - resolve(String, boolean) - Method in class org.apache.commons.mail2.jakarta.resolver.DataSourcePathResolver
-
Resolves the given resource location to a
DataSource
. - resolve(String, boolean) - Method in class org.apache.commons.mail2.jakarta.resolver.DataSourceUrlResolver
-
Resolves the given resource location to a
DataSource
.
S
- send() - Method in class org.apache.commons.mail2.jakarta.Email
-
Sends the email.
- sendMimeMessage() - Method in class org.apache.commons.mail2.jakarta.Email
-
Sends the previously created MimeMessage to the SMTP server.
- setAuthentication(String, String) - Method in class org.apache.commons.mail2.jakarta.Email
-
Sets the userName and password if authentication is needed.
- setAuthenticator(Authenticator) - Method in class org.apache.commons.mail2.jakarta.Email
-
Sets the
Authenticator
to be used when authentication is requested from the mail server. - setBcc(Collection<InternetAddress>) - Method in class org.apache.commons.mail2.jakarta.Email
-
Sets a list of "BCC" addresses.
- setBoolHasAttachments(boolean) - Method in class org.apache.commons.mail2.jakarta.MultiPartEmail
-
Sets whether there are attachments.
- setBounceAddress(String) - Method in class org.apache.commons.mail2.jakarta.Email
-
Sets the "bounce address" - the address to which undeliverable messages will be returned.
- setCc(Collection<InternetAddress>) - Method in class org.apache.commons.mail2.jakarta.Email
-
Sets a list of "CC" addresses.
- setCharset(String) - Method in class org.apache.commons.mail2.jakarta.Email
-
Sets the charset of the message.
- setContent(MimeMultipart) - Method in class org.apache.commons.mail2.jakarta.Email
-
Sets the emailBody to a MimeMultiPart
- setContent(Object) - Method in class org.apache.commons.mail2.jakarta.Email
-
Sets the content.
- setContent(Object, String) - Method in class org.apache.commons.mail2.jakarta.Email
-
Sets the content and contentType.
- setContentType(String) - Method in class org.apache.commons.mail2.jakarta.Email
-
Sets the content type.
- setDataSourceResolver(DataSourceResolver) - Method in class org.apache.commons.mail2.jakarta.ImageHtmlEmail
-
Sets the data source resolver.
- setDebug(boolean) - Method in class org.apache.commons.mail2.jakarta.Email
-
Sets the display of debug information.
- setDescription(String) - Method in class org.apache.commons.mail2.jakarta.EmailAttachment
-
Sets the description.
- setDisposition(String) - Method in class org.apache.commons.mail2.jakarta.EmailAttachment
-
Sets the disposition.
- setFrom(String) - Method in class org.apache.commons.mail2.jakarta.Email
-
Sets the FROM field of the email to use the specified address.
- setFrom(String, String) - Method in class org.apache.commons.mail2.jakarta.Email
-
Sets 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.mail2.jakarta.Email
-
Sets the FROM field of the email to use the specified address, personal name, and charset encoding for the name.
- setFromAddress(InternetAddress) - Method in class org.apache.commons.mail2.jakarta.Email
-
Sets the From address.
- setHeaders(Map<String, String>) - Method in class org.apache.commons.mail2.jakarta.Email
-
Sets the mail headers.
- setHostName(String) - Method in class org.apache.commons.mail2.jakarta.Email
-
Sets the hostname of the outgoing mail server.
- setHtmlMsg(String) - Method in class org.apache.commons.mail2.jakarta.HtmlEmail
-
Sets the HTML content.
- setInitialized(boolean) - Method in class org.apache.commons.mail2.jakarta.MultiPartEmail
-
Sets the initialized status of this object.
- setMailSession(Session) - Method in class org.apache.commons.mail2.jakarta.Email
-
Sets a mail Session object to use.
- setMailSessionFromJNDI(String) - Method in class org.apache.commons.mail2.jakarta.Email
-
Sets a mail Session object from a JNDI directory.
- setMessage(MimeMessage) - Method in class org.apache.commons.mail2.jakarta.Email
-
Sets the MIME message.
- setMsg(String) - Method in class org.apache.commons.mail2.jakarta.Email
-
Sets the content of the mail.
- setMsg(String) - Method in class org.apache.commons.mail2.jakarta.HtmlEmail
-
Sets the message.
- setMsg(String) - Method in class org.apache.commons.mail2.jakarta.MultiPartEmail
-
Sets the message of the email.
- setMsg(String) - Method in class org.apache.commons.mail2.jakarta.SimpleEmail
-
Sets the content of the mail.
- setName(String) - Method in class org.apache.commons.mail2.jakarta.EmailAttachment
-
Sets the name.
- setPath(String) - Method in class org.apache.commons.mail2.jakarta.EmailAttachment
-
Sets the path to the attachment.
- setPopBeforeSmtp(boolean) - Method in class org.apache.commons.mail2.jakarta.Email
-
Sets whether to use POP3 before SMTP, and if so the settings.
- setPopBeforeSmtp(boolean, String, String, String) - Method in class org.apache.commons.mail2.jakarta.Email
-
Sets details regarding "POP3 before SMTP" authentication.
- setPopHost(String) - Method in class org.apache.commons.mail2.jakarta.Email
-
Sets the POP3 host.
- setPopPassword(String) - Method in class org.apache.commons.mail2.jakarta.Email
-
Sets the POP3 password.
- setPopUsername(String) - Method in class org.apache.commons.mail2.jakarta.Email
-
Sets the POP3 user name.
- setReplyTo(Collection<InternetAddress>) - Method in class org.apache.commons.mail2.jakarta.Email
-
Sets a list of reply to addresses.
- setSendPartial(boolean) - Method in class org.apache.commons.mail2.jakarta.Email
-
Sets whether the email is partially send in case of invalid addresses.
- setSentDate(Date) - Method in class org.apache.commons.mail2.jakarta.Email
-
Sets the sent date for the email.
- setSmtpPort(int) - Method in class org.apache.commons.mail2.jakarta.Email
-
Sets the non-SSL port number of the outgoing mail server.
- setSocketConnectionTimeout(Duration) - Method in class org.apache.commons.mail2.jakarta.Email
-
Sets the socket connection timeout value in milliseconds.
- setSocketTimeout(Duration) - Method in class org.apache.commons.mail2.jakarta.Email
-
Sets the socket I/O timeout value in milliseconds.
- setSSLCheckServerIdentity(boolean) - Method in class org.apache.commons.mail2.jakarta.Email
-
Sets whether the server identity is checked as specified by RFC 2595
- setSSLOnConnect(boolean) - Method in class org.apache.commons.mail2.jakarta.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.mail2.jakarta.Email
-
Sets the SSL port to use for the SMTP transport.
- setStartTLSEnabled(boolean) - Method in class org.apache.commons.mail2.jakarta.Email
-
Sets or disable the STARTTLS encryption.
- setStartTLSRequired(boolean) - Method in class org.apache.commons.mail2.jakarta.Email
-
Sets or disable the required STARTTLS encryption.
- setSubject(String) - Method in class org.apache.commons.mail2.jakarta.Email
-
Sets the email subject.
- setSubType(String) - Method in class org.apache.commons.mail2.jakarta.MultiPartEmail
-
Sets the MIME subtype of the email.
- setTextMsg(String) - Method in class org.apache.commons.mail2.jakarta.HtmlEmail
-
Sets the text content.
- setTo(Collection<InternetAddress>) - Method in class org.apache.commons.mail2.jakarta.Email
-
Sets a list of "TO" addresses.
- setURL(URL) - Method in class org.apache.commons.mail2.jakarta.EmailAttachment
-
Sets the URL.
- SimpleEmail - Class in org.apache.commons.mail2.jakarta
-
Sends simple Internet email messages without attachments.
- SimpleEmail() - Constructor for class org.apache.commons.mail2.jakarta.SimpleEmail
-
Constructs a new instance.
T
- toASCII(String) - Method in class org.apache.commons.mail2.jakarta.util.IDNEmailAddressConverter
-
Converts an email address to its ASCII representation using "Punycode".
- toInternetAddressArray(List<InternetAddress>) - Method in class org.apache.commons.mail2.jakarta.Email
-
Converts to copy List of known InternetAddress objects into an array.
U
- updateContentType(String) - Method in class org.apache.commons.mail2.jakarta.Email
-
Updates the contentType.
W
- writeMimeMessage(MimeMessage, File) - Static method in class org.apache.commons.mail2.jakarta.util.MimeMessageUtils
-
Writes a MimeMessage into a file.
All Classes and Interfaces|All Packages|Constant Field Values