Skip navigation links
A B C D E F G H I K L M N O P R S T U V W X 

A

allowingEmbeddedImageOutsideBaseClassPath(boolean) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Dictates whether sources will be resolved for embedded images when they are not nested under the baseClassPath (if baseClassPath is set).
allowingEmbeddedImageOutsideBaseDir(boolean) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Dictates whether files will be resolved for embedded images when they are not nested under the baseDir (if baseDir is set).
allowingEmbeddedImageOutsideBaseUrl(boolean) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Dictates whether url's will be resolved for embedded images when they are not nested under the baseUrl (if baseUrl is set).
appendText(File) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
appendText(String) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Appends text to the current plain text body (or starts it if plain text body is missing).
appendTextHTML(File) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
appendTextHTML(String) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Appends HTML text to the current HTML text body (or starts it if HTML text body is missing).
async() - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
Changes the default for sending emails and testing server connections to asynchronous (batch mode).
AttachmentResource - Class in org.simplejavamail.api.email
A named immutable email attachment information object.
AttachmentResource(String, DataSource) - Constructor for class org.simplejavamail.api.email.AttachmentResource
Delegates to AttachmentResource(String, DataSource, String, ContentTransferEncoding) with null-description and no forced content transfer encoding
AttachmentResource(String, DataSource, String) - Constructor for class org.simplejavamail.api.email.AttachmentResource
Delegates to AttachmentResource(String, DataSource, String, ContentTransferEncoding) with no forced content transfer encoding
AttachmentResource(String, DataSource, String, ContentTransferEncoding) - Constructor for class org.simplejavamail.api.email.AttachmentResource
Constructor; initializes the attachment resource with a name and data.

B

bcc(Recipient...) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.withRecipients(Collection, Message.RecipientType) with fixedRecipientType=Message.RecipientType#BCC.
bcc(Collection<Recipient>) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.withRecipients(Collection, Message.RecipientType) with fixedRecipientType=Message.RecipientType#BCC.
bcc(String, String) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.withRecipients(String, boolean, Collection, Message.RecipientType), with recipientType=Message.RecipientType#BCC and fixedName=true assigning or overwriting existing names with the provided name.
bcc(String) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.withRecipientsWithDefaultName(String, Collection, Message.RecipientType) with recipientType=Message.RecipientType#BCC and empty default name.
bcc(String, String...) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
bcc(String, Collection<String>) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
bcc(String, InternetAddress) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
bcc(InternetAddress) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.withAddressesWithDefaultName(String, Collection, Message.RecipientType) with recipientType=Message.RecipientType#BCC and empty default name.
bcc(String, InternetAddress...) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
bccAddresses(Collection<String>) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.withRecipientsWithDefaultName(String, Collection, Message.RecipientType) with recipientType=Message.RecipientType#BCC and empty default name.
bccAddresses(String, Collection<InternetAddress>) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
bccAddressesWithDefaultName(String, InternetAddress...) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
bccAddressesWithDefaultName(String, Collection<InternetAddress>) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
bccAddressesWithFixedName(String, InternetAddress...) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
bccAddressesWithFixedName(String, Collection<InternetAddress>) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
bccMultiple(String...) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.withRecipientsWithDefaultName(String, Collection, Message.RecipientType) with recipientType=Message.RecipientType#BCC and empty default name.
bccMultiple(InternetAddress...) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.withAddressesWithDefaultName(String, Collection, Message.RecipientType) with recipientType=Message.RecipientType#BCC and empty default name.
bccMultipleAddresses(Collection<InternetAddress>) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.withAddressesWithDefaultName(String, Collection, Message.RecipientType) with recipientType=Message.RecipientType#BCC and empty default name.
bccWithDefaultName(String, String...) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
bccWithDefaultName(String, Collection<String>) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
bccWithFixedName(String, String...) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
bccWithFixedName(String, Collection<String>) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
bodyCanonicalization(DkimConfig.Canonicalization) - Method in class org.simplejavamail.api.email.config.DkimConfig.DkimConfigBuilder
 
build() - Method in class org.simplejavamail.api.email.config.DkimConfig.DkimConfigBuilder
 
build() - Method in class org.simplejavamail.api.email.config.SmimeEncryptionConfig.SmimeEncryptionConfigBuilder
 
build() - Method in class org.simplejavamail.api.email.config.SmimeSigningConfig.SmimeSigningConfigBuilder
 
build() - Method in class org.simplejavamail.api.mailer.config.Pkcs12Config.Pkcs12ConfigBuilder
 
buildEmail() - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Validated DKIM values and then delegates to Email(EmailPopulatingBuilder) with this as argument.
buildEmailCompletedWithDefaultsAndOverrides() - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.buildEmailCompletedWithDefaultsAndOverrides(EmailGovernance) with an empty default email governance, which will still apply default config (System) properties (files).
buildEmailCompletedWithDefaultsAndOverrides(EmailGovernance) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Like EmailPopulatingBuilder.buildEmail(), but returning the final email version right away.
builder() - Static method in class org.simplejavamail.api.email.config.DkimConfig
 
builder() - Static method in class org.simplejavamail.api.email.config.SmimeEncryptionConfig
 
builder() - Static method in class org.simplejavamail.api.email.config.SmimeSigningConfig
 
builder() - Static method in class org.simplejavamail.api.mailer.config.Pkcs12Config
 
buildMailer() - Method in interface org.simplejavamail.api.mailer.MailerFromSessionBuilder
Builds the actual Mailer instance with everything configured on this builder instance.
buildMailer() - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
 
buildMailer() - Method in interface org.simplejavamail.api.mailer.MailerRegularBuilder
Builds the actual Mailer instance with everything configured on this builder instance.
byEncoder(String) - Static method in enum org.simplejavamail.api.email.ContentTransferEncoding
 

C

CalendarMethod - Enum in org.simplejavamail.api.email
Possible RFC-2446 VEVENT calendar component methods.
cc(Recipient...) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.withRecipients(Collection, Message.RecipientType) with recipientType=Message.RecipientType#CC.
cc(Collection<Recipient>) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.withRecipients(Collection, Message.RecipientType) with recipientType=Message.RecipientType#CC.
cc(String, String) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.withRecipients(String, boolean, Collection, Message.RecipientType), with recipientType=Message.RecipientType#CC and fixedName=true assigning or overwriting existing names with the provided name.
cc(String) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.withRecipientsWithDefaultName(String, Collection, Message.RecipientType) with recipientType=Message.RecipientType#CC and empty default name.
cc(String, String...) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
cc(String, Collection<String>) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
cc(String, InternetAddress) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
cc(InternetAddress) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.withAddressesWithDefaultName(String, Collection, Message.RecipientType) with recipientType=Message.RecipientType#CC and empty default name.
cc(String, InternetAddress...) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
ccAddresses(Collection<String>) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.withRecipientsWithDefaultName(String, Collection, Message.RecipientType) with recipientType=Message.RecipientType#CC and empty default name.
ccAddresses(String, Collection<InternetAddress>) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
ccAddressesWithDefaultName(String, InternetAddress...) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
ccAddressesWithDefaultName(String, Collection<InternetAddress>) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
ccAddressesWithFixedName(String, InternetAddress...) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
ccAddressesWithFixedName(String, Collection<InternetAddress>) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
ccMultiple(String...) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.withRecipientsWithDefaultName(String, Collection, Message.RecipientType) with recipientType=Message.RecipientType#CC and empty default name.
ccMultiple(InternetAddress...) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.withAddressesWithDefaultName(String, Collection, Message.RecipientType) with recipientType=Message.RecipientType#CC and empty default name.
ccMultipleAddresses(Collection<InternetAddress>) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.withAddressesWithDefaultName(String, Collection, Message.RecipientType) with recipientType=Message.RecipientType#CC and empty default name.
ccWithDefaultName(String, String...) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
ccWithDefaultName(String, Collection<String>) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
ccWithFixedName(String, String...) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
ccWithFixedName(String, Collection<String>) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
cipherAlgorithm(String) - Method in class org.simplejavamail.api.email.config.SmimeEncryptionConfig.SmimeEncryptionConfigBuilder
For detailed information, see SmimeEncryptionConfig.cipherAlgorithm.
clearAttachments() - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Resets attachments to empty.
clearBounceTo() - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Resets bounceToRecipient to empty.
clearCalendarText() - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Resets calendarText to empty.
clearContentTransferEncoding() - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Resets contentTransferEncoding to ContentTransferEncoding.QUOTED_PRINTABLE.
clearDispositionNotificationTo() - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Resets dispositionNotificationTo to empty.
clearDkim() - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Resets all dkim properties to empty.
clearEmailDefaults() - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
Makes the reference Email instance null, meaning no defaults will be applied.
clearEmailOverrides() - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
Makes the reference Email instance null, meaning no overrides will be applied.
clearEmailValidator() - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
Makes the email validator null, meaning validation won't take place.
clearEmbeddedImageBaseClassPath() - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Resets classpath base for embedded images to null.
clearEmbeddedImageBaseDir() - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Resets base dir for embedded images to null.
clearEmbeddedImageBaseUrl() - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Resets base URL for embedded images to null.
clearEmbeddedImages() - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Resets embeddedImages to empty.
clearFromRecipient() - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Resets fromRecipient to empty.
clearHeaders() - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Resets headers to empty.
clearHTMLText() - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Resets textHTML to empty.
clearId() - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Resets id to empty.
clearMaximumEmailSize() - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
Makes the maximum email size null, meaning no size check will be performed.
clearOverrideReceivers() - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Resets overrideReceivers to empty.
clearPlainText() - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Resets text to empty.
clearProperties() - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
Removes all properties.
clearProxy() - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
Empties all proxy configuration.
clearRecipients() - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Resets recipients to empty.
clearReplyTo() - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Resets replyToRecipients to empty.
clearReturnReceiptTo() - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Resets returnReceiptTo to empty.
clearSentDate() - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Clears the fixed sent-date so that the current date is used again at the time of sending.
clearSmime() - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
For signing and encrypting this email when sending, resets all S/MIME properties to empty.
clearSMIMESignedAttachmentMergingBehavior() - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
When readig and converting an email, this flag makes the behavior revert to the default merging behavior for single S/MIME signed attachments, which is that it is merged into the root message.
clearSubject() - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Resets subject to empty.
clearTrustedSSLHosts() - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
Removes all trusted hosts from the list.
ConfigLoader - Class in org.simplejavamail.config
Contains list of possible properties names and can produce a map of property values, if provided as file "simplejavamail.properties" on the classpath or as environment property.
ConfigLoader.Property - Enum in org.simplejavamail.config
List of all the properties recognized by Simple Java Mail.
ContentTransferEncoding - Enum in org.simplejavamail.api.email
Possible encoders for email content (text/html/iCalendar).
copying(MimeMessage) - Method in interface org.simplejavamail.api.email.EmailStartingBuilder
Delegates to EmailStartingBuilder.copying(Email), by converting the provided message first.
copying(EmailPopulatingBuilder) - Method in interface org.simplejavamail.api.email.EmailStartingBuilder
Delegates to EmailStartingBuilder.copying(Email), by building the email first.
copying(Email) - Method in interface org.simplejavamail.api.email.EmailStartingBuilder
Preconfigures the builder with all the properties from the given email that are non-null.
CustomMailer - Interface in org.simplejavamail.api.mailer
By default, Simple Java Mail handles the ultimate connection and sending of emails.

D

DEFAULT_CONFIG_FILENAME - Static variable in class org.simplejavamail.config.ConfigLoader
By default, the optional file "simplejavamail.properties" will be loaded from classpath to load initial defaults.
DEFAULT_CONNECTIONPOOL_CLAIMTIMEOUT_MILLIS - Static variable in interface org.simplejavamail.api.mailer.MailerGenericBuilder
2147483647 (Integer.MAX_VALUE), effectively indefinately.
DEFAULT_CONNECTIONPOOL_CORE_SIZE - Static variable in interface org.simplejavamail.api.mailer.MailerGenericBuilder
0
DEFAULT_CONNECTIONPOOL_EXPIREAFTER_MILLIS - Static variable in interface org.simplejavamail.api.mailer.MailerGenericBuilder
5000
DEFAULT_CONNECTIONPOOL_LOADBALANCING_STRATEGY - Static variable in interface org.simplejavamail.api.mailer.MailerGenericBuilder
"ROUND_ROBIN"
DEFAULT_CONNECTIONPOOL_MAX_SIZE - Static variable in interface org.simplejavamail.api.mailer.MailerGenericBuilder
4
DEFAULT_DISABLE_ALL_CLIENTVALIDATION - Static variable in interface org.simplejavamail.api.mailer.MailerGenericBuilder
Defaults to false, validating emailaddresses (can be configured seperately, but this does override it) and CRLF injection detection (will arn instead).
DEFAULT_JAVAXMAIL_DEBUG - Static variable in interface org.simplejavamail.api.mailer.MailerGenericBuilder
Defaults to false, sending mails rather than just only logging the mails.
DEFAULT_POOL_KEEP_ALIVE_TIME - Static variable in interface org.simplejavamail.api.mailer.MailerGenericBuilder
1
DEFAULT_POOL_SIZE - Static variable in interface org.simplejavamail.api.mailer.MailerGenericBuilder
10
DEFAULT_PROXY_BRIDGE_PORT - Static variable in interface org.simplejavamail.api.mailer.MailerGenericBuilder
The temporary intermediary SOCKS5 relay server bridge is a server that sits in between JavaMail and the remote proxy.
DEFAULT_PROXY_PORT - Static variable in interface org.simplejavamail.api.mailer.MailerGenericBuilder
Default port is 1080.
DEFAULT_QUOTING_MARKUP - Static variable in interface org.simplejavamail.api.email.EmailStartingBuilder
Default simple quoting markup for email replies:
DEFAULT_SESSION_TIMEOUT_MILLIS - Static variable in interface org.simplejavamail.api.mailer.MailerGenericBuilder
The default maximum timeout value for the transport socket is 60000 milliseconds (affects socket connect-, read- and write timeouts).
DEFAULT_TRANSPORT_MODE_LOGGING_ONLY - Static variable in interface org.simplejavamail.api.mailer.MailerGenericBuilder
Defaults to false, sending mails rather than just only logging the mails.
DEFAULT_TRUST_ALL_HOSTS - Static variable in interface org.simplejavamail.api.mailer.MailerGenericBuilder
true
DEFAULT_VERIFY_SERVER_IDENTITY - Static variable in interface org.simplejavamail.api.mailer.MailerGenericBuilder
true
disablingAllClientValidation(Boolean) - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
Controls whether there will be any client-sided validation, including email address validation and CRLF injection attack detection (which will be warning instead).
DkimConfig - Class in org.simplejavamail.api.email.config
 
DkimConfig.Canonicalization - Enum in org.simplejavamail.api.email.config
 
DkimConfig.DkimConfigBuilder - Class in org.simplejavamail.api.email.config
 
DkimConfigBuilder() - Constructor for class org.simplejavamail.api.email.config.DkimConfig.DkimConfigBuilder
 
dkimPrivateKeyData(InputStream) - Method in class org.simplejavamail.api.email.config.DkimConfig.DkimConfigBuilder
 
dkimPrivateKeyData(String) - Method in class org.simplejavamail.api.email.config.DkimConfig.DkimConfigBuilder
 
dkimPrivateKeyData(byte[]) - Method in class org.simplejavamail.api.email.config.DkimConfig.DkimConfigBuilder
 
dkimPrivateKeyPath(String) - Method in class org.simplejavamail.api.email.config.DkimConfig.DkimConfigBuilder
 
dkimPrivateKeyPath(File) - Method in class org.simplejavamail.api.email.config.DkimConfig.DkimConfigBuilder
 
dkimSelector(String) - Method in class org.simplejavamail.api.email.config.DkimConfig.DkimConfigBuilder
 
dkimSigningDomain(String) - Method in class org.simplejavamail.api.email.config.DkimConfig.DkimConfigBuilder
 
dontApplyDefaultValueFor(EmailProperty...) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Allows you to prevent a property to be configured with default values.
dontApplyOverrideValueFor(EmailProperty...) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Allows you to prevent a property to be configured with override values.

E

Email - Class in org.simplejavamail.api.email
Email message with all necessary data for an effective mailing action, including attachments etc.
Email(EmailPopulatingBuilder) - Constructor for class org.simplejavamail.api.email.Email
Simply transfers everything from EmailPopulatingBuilder to this Email instance.
EmailGovernance - Interface in org.simplejavamail.api.mailer.config
Governance for all emails being sent through the current Mailer instance.
EmailPopulatingBuilder - Interface in org.simplejavamail.api.email
Fluent interface Builder for populating Email instances.
EmailStartingBuilder - Interface in org.simplejavamail.api.email
Entry Builder API for starting new emails.
EmailTooBigException - Exception in org.simplejavamail.api.mailer
Thrown when an email (as MimeMessage) is bigger than the maximum allowed size.
EmailTooBigException(long, long) - Constructor for exception org.simplejavamail.api.mailer.EmailTooBigException
 
EmailWithDefaultsAndOverridesApplied - Interface in org.simplejavamail.api.email
Since defaults and overrides are not applied all the way in the beginning anymore when creating an Email instance, at the time of sending we want to double-check that defaults and overrides are applied by that time at least.
embeddedImageAutoResolutionMustBeSuccesful(boolean) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
When embedded image auto resolution is enabled, this option will make sure unresolved images sources result in an exception.
encryptWithSmime(File, String, String) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.encryptWithSmime(SmimeEncryptionConfig) using the provided PEM file.
encryptWithSmime(SmimeEncryptionConfig) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Encrypts this email with a X509 certificate according to the S/MIME spec signature.
equals(Object) - Method in class org.simplejavamail.api.email.AttachmentResource
 
equals(Object) - Method in class org.simplejavamail.api.email.Email
 
equals(Object) - Method in class org.simplejavamail.api.email.Recipient
 
equalsEmail(Email, Email) - Static method in class org.simplejavamail.api.email.EqualsHelper
 
EqualsHelper - Class in org.simplejavamail.api.email
Util class to get rid of some boilerplate code in the core classes.
EqualsHelper() - Constructor for class org.simplejavamail.api.email.EqualsHelper
 
excludedHeadersFromDkimDefaultSigningList(Set<String>) - Method in class org.simplejavamail.api.email.config.DkimConfig.DkimConfigBuilder
 
excludedHeadersFromDkimDefaultSigningList(String...) - Method in class org.simplejavamail.api.email.config.DkimConfig.DkimConfigBuilder
 

F

findStrategyForSession(Session) - Static method in enum org.simplejavamail.api.mailer.config.TransportStrategy
For internal use only.
fixingMessageId(String) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Sets optional ID to a fixed value, which is otherwise generated by the underlying JavaMail framework when sending the email.
fixingSentDate(Date) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
When an email is sent it is converted to a MimeMessage at which time the sent-date is filled with the current date.
forwarding(Email) - Method in interface org.simplejavamail.api.email.EmailStartingBuilder
Delegates to EmailStartingBuilder.forwarding(MimeMessage) with the provided Email converted to MimeMessage.
forwarding(MimeMessage) - Method in interface org.simplejavamail.api.email.EmailStartingBuilder
Primes the email to be build with proper subject and include the forwarded email as "message/rfc822" bodypart (valid RFC forward).
from(String) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.from(String, String) with empty name.
from(String, String) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.from(Recipient) with a new Recipient wrapped around the given name and email address.
from(String, InternetAddress) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.from(Recipient) with a new Recipient wrapped around the given fixed name and email address.
from(InternetAddress) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.from(Recipient) with a new Recipient wrapped around the given email address.
from(Recipient) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Sets the address of the sender of this email with given Recipient (ignoring its Message.RecipientType if provided).

G

generateProperties() - Method in enum org.simplejavamail.api.mailer.config.TransportStrategy
For internal use only.
getAddress() - Method in class org.simplejavamail.api.email.Recipient
Bean getter for Recipient.address;
getAttachments() - Method in class org.simplejavamail.api.email.Email
 
getAttachments() - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
 
getBccRecipients() - Method in class org.simplejavamail.api.email.Email
 
getBooleanProperty(ConfigLoader.Property) - Static method in class org.simplejavamail.config.ConfigLoader
 
getBounceToRecipient() - Method in class org.simplejavamail.api.email.Email
 
getBounceToRecipient() - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
 
getCalendarMethod() - Method in class org.simplejavamail.api.email.Email
 
getCalendarMethod() - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
 
getCalendarText() - Method in class org.simplejavamail.api.email.Email
 
getCcRecipients() - Method in class org.simplejavamail.api.email.Email
 
getClusterKey() - Method in interface org.simplejavamail.api.mailer.config.OperationalConfig
 
getClusterKey() - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
 
getConnectionPoolClaimTimeoutMillis() - Method in interface org.simplejavamail.api.mailer.config.OperationalConfig
 
getConnectionPoolClaimTimeoutMillis() - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
 
getConnectionPoolCoreSize() - Method in interface org.simplejavamail.api.mailer.config.OperationalConfig
 
getConnectionPoolCoreSize() - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
 
getConnectionPoolExpireAfterMillis() - Method in interface org.simplejavamail.api.mailer.config.OperationalConfig
 
getConnectionPoolExpireAfterMillis() - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
 
getConnectionPoolLoadBalancingStrategy() - Method in interface org.simplejavamail.api.mailer.config.OperationalConfig
 
getConnectionPoolLoadBalancingStrategy() - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
 
getConnectionPoolMaxSize() - Method in interface org.simplejavamail.api.mailer.config.OperationalConfig
 
getConnectionPoolMaxSize() - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
 
getContentTransferEncoding() - Method in class org.simplejavamail.api.email.AttachmentResource
 
getContentTransferEncoding() - Method in class org.simplejavamail.api.email.Email
 
getContentTransferEncoding() - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
 
getCustomMailer() - Method in interface org.simplejavamail.api.mailer.config.OperationalConfig
 
getCustomMailer() - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
 
getCustomSSLFactory() - Method in interface org.simplejavamail.api.mailer.MailerRegularBuilder
 
getCustomSSLFactoryClass() - Method in interface org.simplejavamail.api.mailer.config.ServerConfig
 
getCustomSSLFactoryInstance() - Method in interface org.simplejavamail.api.mailer.config.ServerConfig
 
getDataSource() - Method in class org.simplejavamail.api.email.AttachmentResource
 
getDataSourceInputStream() - Method in class org.simplejavamail.api.email.AttachmentResource
Delegates to DataSource.getInputStream()
getDecryptedAttachments() - Method in class org.simplejavamail.api.email.Email
 
getDecryptedAttachments() - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
If the S/MIME library is loaded, this method returns a copy list of the attachments, but with any signed attachments replaced with decrypted ones.
getDefault() - Static method in enum org.simplejavamail.api.email.ContentTransferEncoding
 
getDefaultServerPort() - Method in enum org.simplejavamail.api.mailer.config.TransportStrategy
For internal use only.
getDescription() - Method in class org.simplejavamail.api.email.AttachmentResource
 
getDispositionNotificationTo() - Method in class org.simplejavamail.api.email.Email
 
getDispositionNotificationTo() - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
 
getDkimConfig() - Method in class org.simplejavamail.api.email.Email
 
getDkimConfig() - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
 
getDkimPrivateKeyData() - Method in class org.simplejavamail.api.email.config.DkimConfig
 
getEmailDefaults() - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
 
getEmailGovernance() - Method in interface org.simplejavamail.api.mailer.Mailer
 
getEmailOverrides() - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
 
getEmailToForward() - Method in class org.simplejavamail.api.email.Email
 
getEmailToForward() - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
 
getEmailValidator() - Method in interface org.simplejavamail.api.mailer.config.EmailGovernance
 
getEmailValidator() - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
 
getEmbeddedImages() - Method in class org.simplejavamail.api.email.Email
 
getEmbeddedImages() - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
 
getExecutorService() - Method in interface org.simplejavamail.api.mailer.config.OperationalConfig
 
getExecutorService() - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
Returns the user set ExecutorService or else null as the default ExecutorService is not created until the OperationalConfig is created for the new Mailer instance.
getFromRecipient() - Method in class org.simplejavamail.api.email.Email
 
getFromRecipient() - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
 
getHeaders() - Method in class org.simplejavamail.api.email.Email
 
getHeaders() - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
 
getHost() - Method in interface org.simplejavamail.api.mailer.config.ServerConfig
 
getHost() - Method in interface org.simplejavamail.api.mailer.MailerRegularBuilder
 
getHTMLText() - Method in class org.simplejavamail.api.email.Email
 
getId() - Method in class org.simplejavamail.api.email.Email
 
getId() - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
 
getIntegerProperty(ConfigLoader.Property) - Static method in class org.simplejavamail.config.ConfigLoader
 
getKeyAlias() - Method in class org.simplejavamail.api.mailer.config.Pkcs12Config
 
getKeyPassword() - Method in class org.simplejavamail.api.mailer.config.Pkcs12Config
 
getMaximumEmailSize() - Method in interface org.simplejavamail.api.mailer.config.EmailGovernance
 
getMaximumEmailSize() - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
 
getName() - Method in class org.simplejavamail.api.email.AttachmentResource
 
getName() - Method in class org.simplejavamail.api.email.Recipient
Bean getter for Recipient.name;
getOperationalConfig() - Method in interface org.simplejavamail.api.mailer.Mailer
 
getOriginalSmimeDetails() - Method in class org.simplejavamail.api.email.Email
 
getOriginalSmimeDetails() - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
If this Email instance was the result of a conversion in which the source message was S/MIME signed / encrypted, this field will be filled for historical purpose.
getOverrideReceivers() - Method in class org.simplejavamail.api.email.Email
 
getOverrideReceivers() - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
 
getPassword() - Method in interface org.simplejavamail.api.mailer.config.ProxyConfig
 
getPassword() - Method in interface org.simplejavamail.api.mailer.config.ServerConfig
 
getPassword() - Method in interface org.simplejavamail.api.mailer.MailerRegularBuilder
 
getPkcs12StoreData() - Method in class org.simplejavamail.api.mailer.config.Pkcs12Config
 
getPlainText() - Method in class org.simplejavamail.api.email.Email
 
getPort() - Method in interface org.simplejavamail.api.mailer.config.ServerConfig
 
getPort() - Method in interface org.simplejavamail.api.mailer.MailerRegularBuilder
 
getProperties() - Method in interface org.simplejavamail.api.mailer.config.OperationalConfig
 
getProperties() - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
 
getPropertiesNotToApplyDefaultValueFor() - Method in class org.simplejavamail.api.email.Email
 
getPropertiesNotToApplyDefaultValueFor() - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
 
getPropertiesNotToApplyOverrideValueFor() - Method in class org.simplejavamail.api.email.Email
 
getPropertiesNotToApplyOverrideValueFor() - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
 
getProperty(ConfigLoader.Property) - Static method in class org.simplejavamail.config.ConfigLoader
 
getProxyBridgePort() - Method in interface org.simplejavamail.api.mailer.config.ProxyConfig
 
getProxyBridgePort() - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
 
getProxyConfig() - Method in interface org.simplejavamail.api.mailer.Mailer
 
getProxyHost() - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
 
getProxyPassword() - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
 
getProxyPort() - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
 
getProxyUsername() - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
 
getRecipients() - Method in class org.simplejavamail.api.email.Email
 
getRecipients() - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
 
getRemoteProxyHost() - Method in interface org.simplejavamail.api.mailer.config.ProxyConfig
 
getRemoteProxyPort() - Method in interface org.simplejavamail.api.mailer.config.ProxyConfig
 
getReplyToRecipients() - Method in class org.simplejavamail.api.email.Email
 
getReplyToRecipients() - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
 
getReturnReceiptTo() - Method in class org.simplejavamail.api.email.Email
 
getReturnReceiptTo() - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
 
getSentDate() - Method in class org.simplejavamail.api.email.Email
 
getSentDate() - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
 
getServerConfig() - Method in interface org.simplejavamail.api.mailer.Mailer
 
getSession() - Method in interface org.simplejavamail.api.mailer.Mailer
In case Simple Java Mail falls short somehow, you can get a hold of the internal Session instance to debug or tweak.
getSession() - Method in interface org.simplejavamail.api.mailer.MailerFromSessionBuilder
 
getSessionTimeout() - Method in interface org.simplejavamail.api.mailer.config.OperationalConfig
 
getSessionTimeout() - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
 
getSmimeEncryptionConfig() - Method in class org.simplejavamail.api.email.Email
 
getSmimeEncryptionConfig() - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
 
getSmimeMicalg() - Method in interface org.simplejavamail.api.email.OriginalSmimeDetails
 
getSmimeMime() - Method in interface org.simplejavamail.api.email.OriginalSmimeDetails
 
getSmimeMode() - Method in interface org.simplejavamail.api.email.OriginalSmimeDetails
 
getSmimeName() - Method in interface org.simplejavamail.api.email.OriginalSmimeDetails
 
getSmimeProtocol() - Method in interface org.simplejavamail.api.email.OriginalSmimeDetails
 
getSmimeSignatureValid() - Method in interface org.simplejavamail.api.email.OriginalSmimeDetails
 
getSmimeSignedBy() - Method in interface org.simplejavamail.api.email.OriginalSmimeDetails
 
getSmimeSignedEmail() - Method in class org.simplejavamail.api.email.Email
 
getSmimeSignedEmail() - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
If the Email instance currently being built was the result of a conversion in which the source message was S/MIME signed / encrypted, this field will contain the decrypted MimeMessage instance.
getSmimeSigningConfig() - Method in class org.simplejavamail.api.email.Email
 
getSmimeSigningConfig() - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
 
getSmimeType() - Method in interface org.simplejavamail.api.email.OriginalSmimeDetails
 
getSslHostsToTrust() - Method in interface org.simplejavamail.api.mailer.config.OperationalConfig
 
getSslHostsToTrust() - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
 
getStorePassword() - Method in class org.simplejavamail.api.mailer.config.Pkcs12Config
 
getStringProperty(ConfigLoader.Property) - Static method in class org.simplejavamail.config.ConfigLoader
 
getSubject() - Method in class org.simplejavamail.api.email.Email
 
getSubject() - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
 
getText() - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
 
getTextCalendar() - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
 
getTextHTML() - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
 
getThreadPoolKeepAliveTime() - Method in interface org.simplejavamail.api.mailer.config.OperationalConfig
 
getThreadPoolKeepAliveTime() - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
 
getThreadPoolSize() - Method in interface org.simplejavamail.api.mailer.config.OperationalConfig
 
getThreadPoolSize() - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
 
getToRecipients() - Method in class org.simplejavamail.api.email.Email
 
getTransportStrategy() - Method in interface org.simplejavamail.api.mailer.Mailer
 
getTransportStrategy() - Method in interface org.simplejavamail.api.mailer.MailerRegularBuilder
 
getType() - Method in class org.simplejavamail.api.email.Recipient
Bean getter for Recipient.type;
getUseDispositionNotificationTo() - Method in class org.simplejavamail.api.email.Email
 
getUseDispositionNotificationTo() - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
 
getUseReturnReceiptTo() - Method in class org.simplejavamail.api.email.Email
 
getUseReturnReceiptTo() - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
 
getUsername() - Method in interface org.simplejavamail.api.mailer.config.ProxyConfig
 
getUsername() - Method in interface org.simplejavamail.api.mailer.config.ServerConfig
 
getUsername() - Method in interface org.simplejavamail.api.mailer.MailerRegularBuilder
 

H

hashCode() - Method in class org.simplejavamail.api.email.AttachmentResource
 
hashCode() - Method in class org.simplejavamail.api.email.Email
 
hashCode() - Method in class org.simplejavamail.api.email.Recipient
 
hasProperty(ConfigLoader.Property) - Static method in class org.simplejavamail.config.ConfigLoader
 
headerCanonicalization(DkimConfig.Canonicalization) - Method in class org.simplejavamail.api.email.config.DkimConfig.DkimConfigBuilder
 

I

ignoringDefaults(boolean) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Indicates that when the email is sent, no default values whatsoever should be applied to the email.
ignoringDefaults() - Method in interface org.simplejavamail.api.email.EmailStartingBuilder
Configures this builder to create an email ignoring the all defaults from (System) properties, config files or defaults email on Mailer level in the EmailGovernance.
ignoringOverrides(boolean) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Indicates that when the email is sent, no override values whatsoever should be applied to the email.
ignoringOverrides() - Method in interface org.simplejavamail.api.email.EmailStartingBuilder
Configures this builder to create an email ignoring the all overrides from (System) properties, config files or defaults email on Mailer level in the EmailGovernance.
IMG_SRC_PATTERN - Static variable in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Regular Expression to find all <img src="..."> entries in an HTML document.It needs to cater for various things, like more whitespaces including newlines on any place, HTML is not case-sensitive and there can be arbitrary text between "IMG" and "SRC" like IDs and other things.
isAsync() - Method in interface org.simplejavamail.api.mailer.config.OperationalConfig
 
isAsync() - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
 
isDebugLogging() - Method in interface org.simplejavamail.api.mailer.config.OperationalConfig
 
isDebugLogging() - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
 
isDisableAllClientValidation() - Method in interface org.simplejavamail.api.mailer.config.OperationalConfig
 
isDisableAllClientValidation() - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
 
isExecutorServiceIsUserProvided() - Method in interface org.simplejavamail.api.mailer.config.OperationalConfig
Indicates whether the executor service was provided by the user or internally.
isIgnoreDefaults() - Method in class org.simplejavamail.api.email.Email
 
isIgnoreDefaults() - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
 
isIgnoreOverrides() - Method in class org.simplejavamail.api.email.Email
 
isIgnoreOverrides() - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
 
isMergeSingleSMIMESignedAttachment() - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
 
isTransportModeLoggingOnly() - Method in interface org.simplejavamail.api.mailer.config.OperationalConfig
 
isTransportModeLoggingOnly() - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
 
isTrustAllSSLHost() - Method in interface org.simplejavamail.api.mailer.config.OperationalConfig
 
isTrustAllSSLHost() - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
 
isVerifyingServerIdentity() - Method in interface org.simplejavamail.api.mailer.config.OperationalConfig
 
isVerifyingServerIdentity() - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
 

K

key() - Method in enum org.simplejavamail.config.ConfigLoader.Property
 
keyAlias(String) - Method in class org.simplejavamail.api.mailer.config.Pkcs12Config.Pkcs12ConfigBuilder
 
keyEncapsulationAlgorithm(String) - Method in class org.simplejavamail.api.email.config.SmimeEncryptionConfig.SmimeEncryptionConfigBuilder
keyPassword(char[]) - Method in class org.simplejavamail.api.mailer.config.Pkcs12Config.Pkcs12ConfigBuilder
 
keyPassword(String) - Method in class org.simplejavamail.api.mailer.config.Pkcs12Config.Pkcs12ConfigBuilder
 

L

LINE_START_PATTERN - Static variable in interface org.simplejavamail.api.email.EmailStartingBuilder
Used for replying to email, when quoting the original email.
LoadBalancingStrategy - Enum in org.simplejavamail.api.mailer.config
Defines the various types of load balancing modes supported by the connection pool ion the batch-module.
loadProperties(String, boolean) - Static method in class org.simplejavamail.config.ConfigLoader
Loads properties from property file on the classpath, if provided.
loadProperties(Properties, boolean) - Static method in class org.simplejavamail.config.ConfigLoader
Loads properties from another properties source, in case you want to provide your own list.
loadProperties(InputStream, boolean) - Static method in class org.simplejavamail.config.ConfigLoader
Loads properties from InputStream.

M

Mailer - Interface in org.simplejavamail.api.mailer
Mailing tool created exclusively using MailerRegularBuilder.
MailerFromSessionBuilder<T extends MailerFromSessionBuilder<?>> - Interface in org.simplejavamail.api.mailer
Intermediate builder interface that supports a fixed Session instance.
MailerGenericBuilder<T extends MailerGenericBuilder<?>> - Interface in org.simplejavamail.api.mailer
Builder superclass which contains API to take care of all generic Mailer properties unrelated to the SMTP server (host, port, username, password and transport strategy).
MailerRegularBuilder<T extends MailerRegularBuilder<?>> - Interface in org.simplejavamail.api.mailer
Default builder for generating Mailer instances.
MailException - Exception in org.simplejavamail
This exception is used to communicate errors during the creation, validation and sending of email.
markAsDefaultsAndOverridesApplied() - Method in interface org.simplejavamail.api.email.EmailWithDefaultsAndOverridesApplied
 

N

notMergingSingleSMIMESignedAttachment() - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
When the S/MIME module is loaded, S/MIME signed / encrypted attachments are decrypted and kept in a separate list.

O

OAUTH2_TOKEN_PROPERTY - Static variable in enum org.simplejavamail.api.mailer.config.TransportStrategy
This is used internally to keep the OAuth2 token in the Session, rather than passing the token troughout the code explicitly.
OperationalConfig - Interface in org.simplejavamail.api.mailer.config
Contains all the configuration that affect how a Mailer operates.
org.simplejavamail - package org.simplejavamail
 
org.simplejavamail.api - package org.simplejavamail.api
Contains the API layer, containing all the public API for working with emails and mailers.
org.simplejavamail.api.email - package org.simplejavamail.api.email
 
org.simplejavamail.api.email.config - package org.simplejavamail.api.email.config
 
org.simplejavamail.api.mailer - package org.simplejavamail.api.mailer
 
org.simplejavamail.api.mailer.config - package org.simplejavamail.api.mailer.config
 
org.simplejavamail.config - package org.simplejavamail.config
 
OriginalSmimeDetails - Interface in org.simplejavamail.api.email
Indicates S/MIME details about an email.
OriginalSmimeDetails.SmimeMode - Enum in org.simplejavamail.api.email
 

P

pkcs12Config(Pkcs12Config) - Method in class org.simplejavamail.api.email.config.SmimeSigningConfig.SmimeSigningConfigBuilder
 
pkcs12Config(File, String, String, String) - Method in class org.simplejavamail.api.email.config.SmimeSigningConfig.SmimeSigningConfigBuilder
pkcs12Config(InputStream, String, String, String) - Method in class org.simplejavamail.api.email.config.SmimeSigningConfig.SmimeSigningConfigBuilder
pkcs12Config(byte[], String, String, String) - Method in class org.simplejavamail.api.email.config.SmimeSigningConfig.SmimeSigningConfigBuilder
Pkcs12Config - Class in org.simplejavamail.api.mailer.config
Config holder for PKCS12 store+key info used for S/MIME encrypting / decrypting.
Pkcs12Config.Pkcs12ConfigBuilder - Class in org.simplejavamail.api.mailer.config
 
pkcs12Store(String) - Method in class org.simplejavamail.api.mailer.config.Pkcs12Config.Pkcs12ConfigBuilder
 
pkcs12Store(File) - Method in class org.simplejavamail.api.mailer.config.Pkcs12Config.Pkcs12ConfigBuilder
Note that this method creates a new FileInputStream without closing it.
pkcs12Store(InputStream) - Method in class org.simplejavamail.api.mailer.config.Pkcs12Config.Pkcs12ConfigBuilder
 
pkcs12Store(byte[]) - Method in class org.simplejavamail.api.mailer.config.Pkcs12Config.Pkcs12ConfigBuilder
 
prependText(File) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
prependText(String) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Prepends text to the current plain text body (or starts it if plain text body is missing).
prependTextHTML(File) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
prependTextHTML(String) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Prepends HTML text to the current HTML text body (or starts it if HTML text body is missing).
produceEmailApplyingDefaultsAndOverrides(Email) - Method in interface org.simplejavamail.api.mailer.config.EmailGovernance
This method will apply the defaults and overrides to the given email and return the result as a new instance.
propertyNameAuthenticate() - Method in enum org.simplejavamail.api.mailer.config.TransportStrategy
For internal use only.
propertyNameCheckServerIdentity() - Method in enum org.simplejavamail.api.mailer.config.TransportStrategy
For internal use only.
propertyNameConnectionTimeout() - Method in enum org.simplejavamail.api.mailer.config.TransportStrategy
For internal use only.
propertyNameEnvelopeFrom() - Method in enum org.simplejavamail.api.mailer.config.TransportStrategy
For internal use only.
propertyNameHost() - Method in enum org.simplejavamail.api.mailer.config.TransportStrategy
For internal use only.
propertyNamePort() - Method in enum org.simplejavamail.api.mailer.config.TransportStrategy
For internal use only.
propertyNameSocksHost() - Method in enum org.simplejavamail.api.mailer.config.TransportStrategy
For internal use only.
propertyNameSocksPort() - Method in enum org.simplejavamail.api.mailer.config.TransportStrategy
For internal use only.
propertyNameSSLTrust() - Method in enum org.simplejavamail.api.mailer.config.TransportStrategy
For internal use only.
propertyNameTimeout() - Method in enum org.simplejavamail.api.mailer.config.TransportStrategy
For internal use only.
propertyNameUsername() - Method in enum org.simplejavamail.api.mailer.config.TransportStrategy
For internal use only.
propertyNameWriteTimeout() - Method in enum org.simplejavamail.api.mailer.config.TransportStrategy
For internal use only.
ProxyConfig - Interface in org.simplejavamail.api.mailer.config
The proxy configuration that indicates whether the connections should be routed through a proxy.

R

RANDOM_ACCESS_REF - Static variable in enum org.simplejavamail.api.mailer.config.LoadBalancingStrategy
 
readAllBytes() - Method in class org.simplejavamail.api.email.AttachmentResource
Delegates to MiscUtil.readInputStreamToBytes(InputStream) with data source input stream.
readAllData() - Method in class org.simplejavamail.api.email.AttachmentResource
 
readAllData(Charset) - Method in class org.simplejavamail.api.email.AttachmentResource
Delegates to MiscUtil.readInputStreamToString(InputStream, Charset) with data source input stream.
Recipient - Class in org.simplejavamail.api.email
An immutable recipient object, with a name, emailaddress and recipient type (eg Message.RecipientType.BCC).
Recipient(String, String, Message.RecipientType) - Constructor for class org.simplejavamail.api.email.Recipient
Constructor; initializes this recipient object.
replyingTo(Email) - Method in interface org.simplejavamail.api.email.EmailStartingBuilder
Delegates to EmailStartingBuilder.replyingTo(MimeMessage, boolean, String) with replyToAll set to false and a default HTML quoting template.
replyingTo(Email, String) - Method in interface org.simplejavamail.api.email.EmailStartingBuilder
Delegates to EmailStartingBuilder.replyingTo(MimeMessage, boolean, String) with replyToAll set to false.
replyingTo(MimeMessage) - Method in interface org.simplejavamail.api.email.EmailStartingBuilder
Delegates to EmailStartingBuilder.replyingTo(MimeMessage, boolean, String) with replyToAll set to false and a default HTML quoting template.
replyingTo(MimeMessage, String) - Method in interface org.simplejavamail.api.email.EmailStartingBuilder
Delegates to EmailStartingBuilder.replyingTo(MimeMessage, boolean, String) with replyToAll set to false.
replyingTo(MimeMessage, boolean, String) - Method in interface org.simplejavamail.api.email.EmailStartingBuilder
Primes the email with subject, quoted content, headers, originally embedded images and recipients needed for a valid RFC reply.
replyingToAll(Email) - Method in interface org.simplejavamail.api.email.EmailStartingBuilder
Delegates to EmailStartingBuilder.replyingTo(MimeMessage, boolean, String) with replyToAll set to true and a default HTML quoting template.
replyingToAll(Email, String) - Method in interface org.simplejavamail.api.email.EmailStartingBuilder
Delegates to EmailStartingBuilder.replyingTo(MimeMessage, boolean, String) with replyToAll set to true.
replyingToAll(MimeMessage, String) - Method in interface org.simplejavamail.api.email.EmailStartingBuilder
Delegates to EmailStartingBuilder.replyingTo(MimeMessage, boolean, String) with replyToAll set to true.
replyingToAll(MimeMessage) - Method in interface org.simplejavamail.api.email.EmailStartingBuilder
Delegates to EmailStartingBuilder.replyingTo(MimeMessage, boolean, String) with replyToAll set to true and a default HTML quoting template.
requiresAuthentication() - Method in interface org.simplejavamail.api.mailer.config.ProxyConfig
 
requiresProxy() - Method in interface org.simplejavamail.api.mailer.config.ProxyConfig
 
resetClusterKey() - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
Reset the cluster key to empty, so it will be generated uniquely, avoiding clustering with any other Mailer.
resetConnectionPoolClaimTimeoutMillis() - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
Resets connection pool connection claim timeout back to indefinately.
resetConnectionPoolCoreSize() - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
Resets connection pool core size to its default (0).
resetConnectionPoolExpireAfterMillis() - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
Resets connection pool expire-after-milliseconds property to its default (5000).
resetConnectionPoolLoadBalancingStrategy() - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
Resets connection pool load balancing strategy to its default ("ROUND_ROBIN").
resetConnectionPoolMaxSize() - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
Resets connection pool max size to its default (4).
resetDisableAllClientValidations() - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
Reverts to default value 'true' for the behaviour of disabling client-sided validations (email addresses and CRLF injection scanning).
resetEmailValidator() - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
Resets the email validator to JMail.strictValidator().
resetExecutorService() - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
Resets the executor services to be used back to the default, created by the Batch module if loaded, or else Executors.newSingleThreadExecutor().
resetSessionTimeout() - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
Resets session time to its default (60000).
resetThreadPoolKeepAliveTime() - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
Resets thread pool keepAliveTime to its default (1).
resetThreadPoolSize() - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
Resets max thread pool size to its default of 10.
resetTransportModeLoggingOnly() - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
Resets transportModeLoggingOnly to false.
resetTrustingAllHosts() - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
Reset trusting any host; trust all hosts is set to true.
resetVerifyingServerIdentity() - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
Reset verifying the server's identity to true.
ROUND_ROBIN_REF - Static variable in enum org.simplejavamail.api.mailer.config.LoadBalancingStrategy
 

S

sendMail(Email) - Method in interface org.simplejavamail.api.mailer.Mailer
Delegates to Mailer.sendMail(Email, boolean), with async = false.
sendMail(Email, boolean) - Method in interface org.simplejavamail.api.mailer.Mailer
Processes an Email instance into a completely configured Message.
sendMessage(OperationalConfig, Session, Email, MimeMessage) - Method in interface org.simplejavamail.api.mailer.CustomMailer
 
ServerConfig - Interface in org.simplejavamail.api.mailer.config
 
setOpportunisticTLS(Boolean) - Method in enum org.simplejavamail.api.mailer.config.TransportStrategy
Determines whether TLS should be attempted for SMTP plain protocol (optional if offered by the SMTP server).
shutdownConnectionPool() - Method in interface org.simplejavamail.api.mailer.Mailer
Shuts down the connection pool associated with this Mailer instance and closes remaining open connections.
signatureAlgorithm(String) - Method in class org.simplejavamail.api.email.config.SmimeSigningConfig.SmimeSigningConfigBuilder
For detailed information, see SmimeSigningConfig.signatureAlgorithm.
signingAlgorithm(String) - Method in class org.simplejavamail.api.email.config.DkimConfig.DkimConfigBuilder
 
signWithDomainKey(byte[], String, String, Set<String>) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Primes this email for signing with a DKIM domain key.
signWithDomainKey(DkimConfig) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Allows for more customization of the DKIM signing process by providing a DkimConfig instance.
signWithSmime(File, String, String, String, String) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
signWithSmime(SmimeSigningConfig) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Signs this email with an S/MIME signature, so the receiving client can verify whether the email content was tampered with.
SmimeEncryptionConfig - Class in org.simplejavamail.api.email.config
 
SmimeEncryptionConfig() - Constructor for class org.simplejavamail.api.email.config.SmimeEncryptionConfig
 
SmimeEncryptionConfig.SmimeEncryptionConfigBuilder - Class in org.simplejavamail.api.email.config
 
SmimeEncryptionConfigBuilder() - Constructor for class org.simplejavamail.api.email.config.SmimeEncryptionConfig.SmimeEncryptionConfigBuilder
 
SmimeSigningConfig - Class in org.simplejavamail.api.email.config
 
SmimeSigningConfig() - Constructor for class org.simplejavamail.api.email.config.SmimeSigningConfig
 
SmimeSigningConfig.SmimeSigningConfigBuilder - Class in org.simplejavamail.api.email.config
 
SmimeSigningConfigBuilder() - Constructor for class org.simplejavamail.api.email.config.SmimeSigningConfig.SmimeSigningConfigBuilder
 
startingBlank() - Method in interface org.simplejavamail.api.email.EmailStartingBuilder
Most common use case for creating a new email.
storePassword(char[]) - Method in class org.simplejavamail.api.mailer.config.Pkcs12Config.Pkcs12ConfigBuilder
 
storePassword(String) - Method in class org.simplejavamail.api.mailer.config.Pkcs12Config.Pkcs12ConfigBuilder
 

T

testConnection(OperationalConfig, Session) - Method in interface org.simplejavamail.api.mailer.CustomMailer
 
testConnection() - Method in interface org.simplejavamail.api.mailer.Mailer
Delegates to Mailer.testConnection(boolean) with async == false.
testConnection(boolean) - Method in interface org.simplejavamail.api.mailer.Mailer
Tries to connect to the configured SMTP server, including (authenticated) proxy if set up.
to(Recipient...) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.withRecipients(Collection, Message.RecipientType) with recipientType=Message.RecipientType#TO.
to(Collection<Recipient>) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.withRecipients(Collection, Message.RecipientType) with recipientType=Message.RecipientType#TO.
to(String, String) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.withRecipients(String, boolean, Collection, Message.RecipientType), with recipientType=Message.RecipientType#TO and fixedName=true assigning or overwriting existing names with the provided name.
to(String) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.withRecipientsWithDefaultName(String, Collection, Message.RecipientType) with recipientType=Message.RecipientType#TO and empty default name.
to(String, String...) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
to(String, Collection<String>) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
to(String, InternetAddress) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
to(InternetAddress) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.withAddressesWithDefaultName(String, Collection, Message.RecipientType) with recipientType=Message.RecipientType#TO and empty default name.
to(String, InternetAddress...) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
toAddresses(String, Collection<InternetAddress>) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
toAddressesWithDefaultName(String, InternetAddress...) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
toAddressesWithDefaultName(String, Collection<InternetAddress>) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
toAddressesWithFixedName(String, InternetAddress...) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
toAddressesWithFixedName(String, Collection<InternetAddress>) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
toMultiple(String...) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.withRecipientsWithDefaultName(String, Collection, Message.RecipientType) with recipientType=Message.RecipientType#TO and empty default name.
toMultiple(Collection<String>) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.withRecipientsWithDefaultName(String, Collection, Message.RecipientType) with recipientType=Message.RecipientType#TO and empty default name.
toMultiple(InternetAddress...) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.withAddressesWithDefaultName(String, Collection, Message.RecipientType) with recipientType=Message.RecipientType#TO and empty default name.
toMultipleAddresses(Collection<InternetAddress>) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.withAddressesWithDefaultName(String, Collection, Message.RecipientType) with recipientType=Message.RecipientType#TO and empty default name.
toString() - Method in class org.simplejavamail.api.email.AttachmentResource
 
toString() - Method in enum org.simplejavamail.api.email.ContentTransferEncoding
 
toString() - Method in class org.simplejavamail.api.email.Email
 
toString() - Method in class org.simplejavamail.api.email.Recipient
 
toString() - Method in class org.simplejavamail.api.mailer.config.Pkcs12Config
 
toString() - Method in interface org.simplejavamail.api.mailer.config.ProxyConfig
 
toString(Properties) - Method in enum org.simplejavamail.api.mailer.config.TransportStrategy
 
toWithDefaultName(String, String...) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
toWithDefaultName(String, Collection<String>) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
toWithFixedName(String, String...) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
toWithFixedName(String, Collection<String>) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
TransportStrategy - Enum in org.simplejavamail.api.mailer.config
Defines the various types of transport protocols and implements respective properties so that a Session may be configured using a TransportStrategy implementation.
trustingAllHosts(boolean) - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
Configures the current session to trust all hosts.
trustingSSLHosts(String...) - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
Configures the new session to only accept server certificates issued to one of the provided hostnames.

U

useLengthParam(Boolean) - Method in class org.simplejavamail.api.email.config.DkimConfig.DkimConfigBuilder
 
usingSession(Session) - Method in interface org.simplejavamail.api.mailer.MailerFromSessionBuilder
Only use this API if you must use your own Session instance.

V

validate(Email) - Method in interface org.simplejavamail.api.mailer.Mailer
Validates an Email instance.
valueOf(String) - Static method in enum org.simplejavamail.api.email.CalendarMethod
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.simplejavamail.api.email.config.DkimConfig.Canonicalization
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.simplejavamail.api.email.ContentTransferEncoding
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.simplejavamail.api.email.OriginalSmimeDetails.SmimeMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.simplejavamail.api.mailer.config.LoadBalancingStrategy
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.simplejavamail.api.mailer.config.TransportStrategy
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.simplejavamail.config.ConfigLoader.Property
Returns the enum constant of this type with the specified name.
valueOrProperty(T, ConfigLoader.Property) - Static method in class org.simplejavamail.config.ConfigLoader
 
valueOrProperty(T, ConfigLoader.Property, T) - Static method in class org.simplejavamail.config.ConfigLoader
Returns the given value if not null and not empty, otherwise tries to resolve the given property and if still not found resort to the default value if provided.
valueOrPropertyAsBoolean(Boolean, ConfigLoader.Property, Boolean) - Static method in class org.simplejavamail.config.ConfigLoader
valueOrPropertyAsInteger(Integer, ConfigLoader.Property, Integer) - Static method in class org.simplejavamail.config.ConfigLoader
valueOrPropertyAsString(String, ConfigLoader.Property, String) - Static method in class org.simplejavamail.config.ConfigLoader
values() - Static method in enum org.simplejavamail.api.email.CalendarMethod
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.simplejavamail.api.email.config.DkimConfig.Canonicalization
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.simplejavamail.api.email.ContentTransferEncoding
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.simplejavamail.api.email.OriginalSmimeDetails.SmimeMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.simplejavamail.api.mailer.config.LoadBalancingStrategy
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.simplejavamail.api.mailer.config.TransportStrategy
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.simplejavamail.config.ConfigLoader.Property
Returns an array containing the constants of this enum type, in the order they are declared.
verifyDefaultsAndOverridesApplied() - Method in interface org.simplejavamail.api.email.EmailWithDefaultsAndOverridesApplied
 
verifyingServerIdentity(boolean) - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
Configures the current session to not verify the server's identity on an SSL connection.

W

withAddresses(String, boolean, Collection<InternetAddress>, Message.RecipientType) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.withRecipient(String, String, Message.RecipientType) for each address in the provided collection.
withAddressesWithDefaultName(String, Collection<InternetAddress>, Message.RecipientType) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.withAddresses(String, boolean, Collection, Message.RecipientType), leaving existing names intact and defaulting when missing.
withAddressesWithFixedName(String, Collection<InternetAddress>, Message.RecipientType) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.withAddresses(String, boolean, Collection, Message.RecipientType), with fixedName=true assigning or overwriting existing names with the provided name.
withAttachment(String, byte[], String) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.withAttachment(String, byte[], String, String, ContentTransferEncoding) with null-description and no forced content transfer encoding.
withAttachment(String, byte[], String, String) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
withAttachment(String, byte[], String, String, ContentTransferEncoding) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.withAttachment(String, DataSource), with a named ByteArrayDataSource created using the provided name, data and mimetype.
withAttachment(String, DataSource) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.withAttachment(String, DataSource, String, ContentTransferEncoding) with null-description and no forced content transfer encoding.
withAttachment(String, DataSource, String) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
withAttachment(String, DataSource, String, ContentTransferEncoding) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Adds an attachment to the email message, which will be shown in the email client as seperate files available for download or inline display if the client supports it (for example, most browsers these days display PDF's in a popup).
withAttachments(List<AttachmentResource>) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
withBounceTo(String) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.withBounceTo(Recipient) with a new Recipient wrapped around the email address (or null if missing).
withBounceTo(String, String) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.withBounceTo(Recipient) with a new Recipient wrapped around the given name and email address.
withBounceTo(InternetAddress) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.withBounceTo(Recipient) with a new Recipient wrapped around the given address.
withBounceTo(String, InternetAddress) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.withBounceTo(Recipient) with a new Recipient wrapped around the given fixed name and address.
withBounceTo(Recipient) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Sets the bounceTo address of this email with given Recipient (ignoring its Message.RecipientType if provided).
withCalendarText(CalendarMethod, String) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Sets the optional calendar details that clients such as Outlook might be able to handle.
withClusterKey(UUID) - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
By defining a clusterKey, you can form clusters where other Mailer instances represent individual connection pools within the same cluster.
withConnectionPoolClaimTimeoutMillis(Integer) - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
If >0, configures the connection pool to wait for a limited time after which the attempt to claim a Transport connection errors out.
withConnectionPoolCoreSize(Integer) - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
Configures the connection pool's core size (default 0), which means the SMTP connection pool will keep X connections open at all times until shut down.
withConnectionPoolExpireAfterMillis(Integer) - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
If >0, configures the connection pool to automatically close connections after some milliseconds (default 5000) since last usage.
withConnectionPoolLoadBalancingStrategy(LoadBalancingStrategy) - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
Defines the various types of load balancing modes supported by the connection pool ion the batch-module.
withConnectionPoolMaxSize(Integer) - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
Configures the connection pool's max size (default 4) in case of high thread contention.
withContentTransferEncoding(ContentTransferEncoding) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Determines what encoding is applied to the text/html/iCalendar encoding in the MimeMessage/EML.
withCustomMailer(CustomMailer) - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
 
withCustomSSLFactoryClass(String) - Method in interface org.simplejavamail.api.mailer.MailerRegularBuilder
Configures the session with the right property to use your own factory for obtaining SSL connections.
withCustomSSLFactoryInstance(SSLSocketFactory) - Method in interface org.simplejavamail.api.mailer.MailerRegularBuilder
Configures the session with the right property to use your own factory for obtaining SSL connections.
withDebugLogging(Boolean) - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
This flag is set on the Session instance through Session.setDebug(boolean) so that it generates debug information.
withDispositionNotificationTo() - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Indicates that we want to use the NPM flag dispositionNotificationTo.
withDispositionNotificationTo(String) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.withDispositionNotificationTo(Recipient) with a new Recipient wrapped around the provided address.
withDispositionNotificationTo(String, String) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.withDispositionNotificationTo(Recipient) with a new Recipient wrapped around the provided name and address.
withDispositionNotificationTo(InternetAddress) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.withDispositionNotificationTo(Recipient) with a new Recipient wrapped around the provided address.
withDispositionNotificationTo(String, InternetAddress) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.withDispositionNotificationTo(Recipient) with a new Recipient wrapped around the provided fixed name and address.
withDispositionNotificationTo(Recipient) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Indicates this email should use the NPM flag "Disposition-Notification-To" with the given preconfigred Recipient.
withEmailDefaults(Email) - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
Sets a reference Email to be used for default values on all emails coming through this Mailer instance.
withEmailOverrides(Email) - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
Sets a reference Email to be used for default values on all emails coming through this Mailer instance.
withEmailValidator(EmailValidator) - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
Sets the email address validator used when validating and sending emails using the current Mailer instance.
withEmbeddedImage(String, byte[], String) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.withEmbeddedImage(String, DataSource), with a named ByteArrayDataSource created using the provided name, data and mimetype.
withEmbeddedImage(String, DataSource) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Adds image data to this email that can be referred to from the email HTML body.
withEmbeddedImageAutoResolutionForClassPathResources(boolean) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Enables auto resolution of classpath datasources for embedded images.
withEmbeddedImageAutoResolutionForFiles(boolean) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Enables auto resolution of file datasources for embedded images.
withEmbeddedImageAutoResolutionForURLs(boolean) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Enables auto resolution of URL's for embedded images.
withEmbeddedImageBaseClassPath(String) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Sets the classpath base used when resolving images sources in HTML text.
withEmbeddedImageBaseDir(String) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Sets the base folder used when resolving images sources in HTML text.
withEmbeddedImageBaseUrl(String) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
withEmbeddedImageBaseUrl(URL) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Sets the base URL used when resolving images sources in HTML text.
withEmbeddedImages(List<AttachmentResource>) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
withExecutorService(ExecutorService) - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
For advanced use cases.
withHeader(String, Object) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.withHeader(String, Object, boolean) with replaceHeader set to false.
withHeader(String, Object, boolean) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Adds a header which will be included in the email.
withHeaders(Map<String, Collection<T>>) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.withHeader(String, Object) for each header in the provided Map.
withHTMLText(File) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
withHTMLText(String) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Sets the optional email message body in HTML text.
withMaximumEmailSize(int) - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
Sets a maximum size for emails (as MimeMessage) in bytes.
withOverrideReceivers(Recipient...) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
withOverrideReceivers(List<Recipient>) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
When provided, Simple Java Mail will ignore all recipients set on the email and instead send to the provided recipients only (when calling Transport.sendMessage(Message, Address[])).
withPlainText(File) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
withPlainText(String) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Sets the optional email message body in plain text.
withProperties(Properties) - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
Adds the given properties to the total list applied to the Session when building a mailer.
withProperties(Map<String, String>) - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
 
withProperty(String, Object) - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
Sets property or removes it if the provided value is null.
withProxy(String, Integer) - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
withProxy(String, Integer, String, String) - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
withProxyBridgePort(Integer) - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
Relevant only when using username authentication with a proxy.
withProxyHost(String) - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
Sets the optional proxy host, which will override any default that might have been set (through properties file or programmatically).
withProxyPassword(String) - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
Sets the optional password to authenticate with the proxy.
withProxyPort(Integer) - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
Sets the proxy port, which will override any default that might have been set (through properties file or programmatically).
withProxyUsername(String) - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
Sets the optional username to authenticate with the proxy.
withRecipient(String, Message.RecipientType) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
withRecipient(String, String, Message.RecipientType) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.withRecipient(String, boolean, String, Message.RecipientType) with the name omitted and fixedName = true.
withRecipient(String, boolean, String, Message.RecipientType) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Adds a new Recipient instance with the given name, address and Message.RecipientType.
withRecipient(Recipient) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Adds a new Recipient instance as copy of the provided recipient (copying name, address and Message.RecipientType).
withRecipients(String, boolean, Message.RecipientType, String...) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
withRecipients(String, boolean, Collection<String>, Message.RecipientType) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.withRecipient(Recipient) for each address found in not just the collection, but also in every individual address string that is in the collection.
withRecipients(Collection<Recipient>) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.withRecipients(Collection, Message.RecipientType) with Message.RecipientType left empty (so it will use the original values).
withRecipients(Recipient...) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.withRecipients(Collection, Message.RecipientType) with Message.RecipientType left empty (so it will use the original values).
withRecipients(Collection<Recipient>, Message.RecipientType) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.withRecipient(String, String, Message.RecipientType) for each recipient in the provided collection, optionally fixing the recipientType for all recipients to the provided type.
withRecipientsWithDefaultName(String, Collection<String>, Message.RecipientType) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.withRecipients(String, boolean, Collection, Message.RecipientType), leaving existing names intact and defaulting when missing.
withRecipientsWithDefaultName(String, Message.RecipientType, String...) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
withRecipientsWithFixedName(String, Collection<String>, Message.RecipientType) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.withRecipients(String, boolean, Collection, Message.RecipientType), with fixedName=true assigning or overwriting existing names with the provided name.
withRecipientsWithFixedName(String, Message.RecipientType, String...) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
withReplyTo(String) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.withReplyTo(Recipient) with a new Recipient wrapped around the given email address.
withReplyTo(String, String) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.withReplyTo(Recipient) with a new Recipient wrapped around the given fixed name and email address.
withReplyTo(InternetAddress) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.withReplyTo(Recipient) with a new Recipient wrapped around the given address.
withReplyTo(String, InternetAddress) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.withReplyTo(Recipient) with a new Recipient wrapped around the given fixed name and address.
withReplyTo(Recipient) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to #withReplyTo(Recipient...)
withReplyTo(List<Recipient>) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Sets the replyTo address of this email with given Recipient (ignoring its Message.RecipientType if provided).
withReturnReceiptTo() - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Indicates that we want to use the flag returnReceiptTo.
withReturnReceiptTo(String) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.withReturnReceiptTo(Recipient) with a new Recipient wrapped around the provided address.
withReturnReceiptTo(String, String) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.withReturnReceiptTo(Recipient) with a new Recipient wrapped around the provided name and address.
withReturnReceiptTo(InternetAddress) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.withReturnReceiptTo(Recipient) with a new Recipient wrapped around the provided address.
withReturnReceiptTo(String, InternetAddress) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Delegates to EmailPopulatingBuilder.withReturnReceiptTo(Recipient) with a new Recipient wrapped around the provided fixed name and address.
withReturnReceiptTo(Recipient) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Indicates that this email should use the RRT flag "Return-Receipt-To" with the preconfigured Recipient.
withSessionTimeout(Integer) - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
Controls the timeout to use when sending emails (affects socket connect-, read- and write timeouts).
withSMTPServer(String, Integer, String, String) - Method in interface org.simplejavamail.api.mailer.MailerRegularBuilder
withSMTPServer(String, Integer, String) - Method in interface org.simplejavamail.api.mailer.MailerRegularBuilder
withSMTPServer(String, Integer) - Method in interface org.simplejavamail.api.mailer.MailerRegularBuilder
withSMTPServerHost(String) - Method in interface org.simplejavamail.api.mailer.MailerRegularBuilder
Sets the optional SMTP host.
withSMTPServerPassword(String) - Method in interface org.simplejavamail.api.mailer.MailerRegularBuilder
Sets the optional SMTP password or OAUTH2 token (in case of TransportStrategy.SMTP_OAUTH2).
withSMTPServerPort(Integer) - Method in interface org.simplejavamail.api.mailer.MailerRegularBuilder
Sets the optional SMTP port.
withSMTPServerUsername(String) - Method in interface org.simplejavamail.api.mailer.MailerRegularBuilder
Sets the optional SMTP username.
withSubject(String) - Method in interface org.simplejavamail.api.email.EmailPopulatingBuilder
Sets the optional subject of this email.
withThreadPoolKeepAliveTime(Integer) - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
When set to a non-zero value (milliseconds), this keepAlivetime is applied to both core and extra threads.
withThreadPoolSize(Integer) - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
Sets max thread pool size to the given size (default is 10).
withTransportModeLoggingOnly(Boolean) - Method in interface org.simplejavamail.api.mailer.MailerGenericBuilder
Determines whether at the very last moment an email is sent out using JavaMail's native API or whether the email is simply only logged.
withTransportStrategy(TransportStrategy) - Method in interface org.simplejavamail.api.mailer.MailerRegularBuilder
To learn more about the various transport modes, the properties they set and the security implications, please refer to the full TransportStrategy
javadoc.

X

x509Certificate(X509Certificate) - Method in class org.simplejavamail.api.email.config.SmimeEncryptionConfig.SmimeEncryptionConfigBuilder
 
x509Certificate(String) - Method in class org.simplejavamail.api.email.config.SmimeEncryptionConfig.SmimeEncryptionConfigBuilder
x509Certificate(File) - Method in class org.simplejavamail.api.email.config.SmimeEncryptionConfig.SmimeEncryptionConfigBuilder
x509Certificate(InputStream) - Method in class org.simplejavamail.api.email.config.SmimeEncryptionConfig.SmimeEncryptionConfigBuilder
A B C D E F G H I K L M N O P R S T U V W X 
Skip navigation links

Copyright © 2009–2025. All rights reserved.