Serialized Form

Package org.simplejavamail

Class org.simplejavamail.MailException extends RuntimeException implements Serializable

Package org.simplejavamail.api.email

Class org.simplejavamail.api.email.AttachmentResource extends Object implements Serializable

serialVersionUID:

1234567L

Serialized Fields

name

String name

See Also:

AttachmentResource(String, DataSource, String)

description

String description

See Also:

AttachmentResource(String, DataSource, String)

contentTransferEncoding

ContentTransferEncoding contentTransferEncoding

See Also:

AttachmentResource(String, DataSource, String)

Class org.simplejavamail.api.email.Email extends Object implements Serializable

serialVersionUID:

1234567L

Serialized Fields

ignoreDefaults

boolean ignoreDefaults

See Also:

EmailPopulatingBuilder.ignoringDefaults(boolean)

ignoreOverrides

boolean ignoreOverrides

See Also:

EmailPopulatingBuilder.ignoringOverrides(boolean)

propertiesNotToApplyDefaultValueFor

Set<E> propertiesNotToApplyDefaultValueFor

See Also:

EmailPopulatingBuilder.dontApplyDefaultValueFor(EmailProperty...)

propertiesNotToApplyOverrideValueFor

Set<E> propertiesNotToApplyOverrideValueFor

See Also:

EmailPopulatingBuilder.dontApplyOverrideValueFor(EmailProperty...)

id

String id

See Also:

EmailPopulatingBuilder.fixingMessageId(String)

fromRecipient

Recipient fromRecipient

See Also:

EmailPopulatingBuilder.from(Recipient)

replyToRecipients

List<E> replyToRecipients

See Also:

EmailPopulatingBuilder.withReplyTo(Recipient)

bounceToRecipient

Recipient bounceToRecipient

See Also:

EmailPopulatingBuilder.withBounceTo(Recipient)

text

String text

See Also:

EmailPopulatingBuilder.withPlainText(String)

textHTML

String textHTML

See Also:

EmailPopulatingBuilder.withHTMLText(String)

calendarMethod

CalendarMethod calendarMethod

See Also:

EmailPopulatingBuilder.withCalendarText(CalendarMethod, String)

textCalendar

String textCalendar

See Also:

EmailPopulatingBuilder.withCalendarText(CalendarMethod, String)

contentTransferEncoding

ContentTransferEncoding contentTransferEncoding

See Also:

EmailPopulatingBuilder.withContentTransferEncoding(ContentTransferEncoding)

subject

String subject

See Also:

EmailPopulatingBuilder.withSubject(String)

recipients

List<E> recipients

See Also:

EmailPopulatingBuilder.to(Recipient...), EmailPopulatingBuilder.cc(Recipient...), EmailPopulatingBuilder.bcc(Recipient...)

embeddedImages

List<E> embeddedImages

See Also:

EmailPopulatingBuilder.withEmbeddedImage(String, DataSource)

attachments

List<E> attachments

See Also:

EmailPopulatingBuilder.withAttachment(String, DataSource)

decryptedAttachments

List<E> decryptedAttachments

If the S/MIME module is loaded, this list will contain the same attachments as Email.attachments, but with any S/MIME signed attachments decrypted.

headers

Map<K,V> headers

See Also:

EmailPopulatingBuilder.withHeader(String, Object), EmailStartingBuilder.replyingTo(MimeMessage, boolean, String)

useDispositionNotificationTo

Boolean useDispositionNotificationTo

See Also:

EmailPopulatingBuilder.withDispositionNotificationTo(), EmailPopulatingBuilder.withDispositionNotificationTo(Recipient)

dispositionNotificationTo

Recipient dispositionNotificationTo

See Also:

EmailPopulatingBuilder.withDispositionNotificationTo(), EmailPopulatingBuilder.withDispositionNotificationTo(Recipient)

useReturnReceiptTo

Boolean useReturnReceiptTo

See Also:

EmailPopulatingBuilder.withReturnReceiptTo(), EmailPopulatingBuilder.withReturnReceiptTo(Recipient)

returnReceiptTo

Recipient returnReceiptTo

See Also:

EmailPopulatingBuilder.withReturnReceiptTo(), EmailPopulatingBuilder.withReturnReceiptTo(Recipient)

overrideReceivers

List<E> overrideReceivers

See Also:

EmailPopulatingBuilder.withOverrideReceivers(Recipient...)

dkimConfig

DkimConfig dkimConfig

See Also:

EmailPopulatingBuilder.signWithDomainKey(DkimConfig), EmailPopulatingBuilder.signWithDomainKey(byte[], String, String, Set)

smimeEncryptionConfig

SmimeEncryptionConfig smimeEncryptionConfig

See Also:

EmailPopulatingBuilder.encryptWithSmime(SmimeEncryptionConfig), EmailPopulatingBuilder.encryptWithSmime(File, String, String)

smimeSignedEmail

Email smimeSignedEmail

See Also:

EmailPopulatingBuilder.getSmimeSignedEmail()

originalSmimeDetails

OriginalSmimeDetails originalSmimeDetails

See Also:

EmailPopulatingBuilder.getOriginalSmimeDetails()

wasMergedWithSmimeSignedMessage

boolean wasMergedWithSmimeSignedMessage

See Also:

"ExtendedEmail.wasMergedWithSmimeSignedMessage()"

sentDate

Date sentDate

See Also:

EmailPopulatingBuilder.fixingSentDate(Date)

Class org.simplejavamail.api.email.Recipient extends Object implements Serializable

serialVersionUID:

1234567L

Serialized Fields

name

String name

address

String address

type

jakarta.mail.Message.RecipientType type

Package org.simplejavamail.api.email.config

Class org.simplejavamail.api.email.config.DkimConfig extends Object implements Serializable

serialVersionUID:

1234567L

Serialized Fields

dkimPrivateKeyData

byte[] dkimPrivateKeyData

See Also:

EmailPopulatingBuilder.signWithDomainKey(DkimConfig), EmailPopulatingBuilder.signWithDomainKey(byte[], String, String, Set)

dkimSigningDomain

String dkimSigningDomain

See Also:

EmailPopulatingBuilder.signWithDomainKey(DkimConfig), EmailPopulatingBuilder.signWithDomainKey(byte[], String, String, Set)

dkimSelector

String dkimSelector

See Also:

EmailPopulatingBuilder.signWithDomainKey(DkimConfig), EmailPopulatingBuilder.signWithDomainKey(byte[], String, String, Set)

useLengthParam

Boolean useLengthParam

Controls the inclusion of the l= parameter (body length tag) in the DKIM signature. The l= parameter specifies the exact length of the body content that was signed.

Default Value: null (indicating that the default behavior is determined by the library, which typically excludes the l= parameter).

Warning: Exercise caution when enabling this parameter. Its inclusion can enhance robustness in scenarios where emails undergo legitimate alterations after sending (such as the addition of footers by mailing lists). However, it also poses security risks by allowing attackers to append malicious content to the message without compromising the integrity of the DKIM signature. It is advisable to disable this option (set to false) unless a specific scenario necessitates its use.

excludedHeadersFromDkimDefaultSigningList

Set<E> excludedHeadersFromDkimDefaultSigningList

See Also:

EmailPopulatingBuilder.signWithDomainKey(DkimConfig), EmailPopulatingBuilder.signWithDomainKey(byte[], String, String, Set)

headerCanonicalization

DkimConfig.Canonicalization headerCanonicalization

Specifies the canonicalization algorithm for header fields in the DKIM signature. Canonicalization is the process of standardizing data into a consistent format before signing. This affects the processing and signing of email headers.

Available Values:
- SIMPLE: Applies minimal canonicalization, aiming to preserve the original form of headers as closely as possible.
- RELAXED: Implements a more forgiving canonicalization, accommodating minor alterations in whitespace and case sensitivity.

Default Value: RELAXED

NOTE: The choice between SIMPLE and RELAXED can impact the success rate of DKIM verification across different mail servers. The RELAXED option tends to normalize minor discrepancies in headers, offering broader compatibility.

bodyCanonicalization

DkimConfig.Canonicalization bodyCanonicalization

Defines the canonicalization algorithm for the email body, mirroring the functionality described for DkimConfig.headerCanonicalization. It dictates the standardization process for the body content before signing.

signingAlgorithm

String signingAlgorithm

Selects the cryptographic algorithm for generating the DKIM signature. This choice influences the security and interoperability of your DKIM signature.

Default Value: SHA256withRSA, which balances robust security with good performance and is broadly supported across platforms.

Supported Signature Algorithms:
- SHA256_WITH_RSA (Recommended)
- SHA1_WITH_RSA
- SHA256_WITH_ED25519

NOTE: The rsa-sha256 algorithm (or another algorithm offering similar security) is strongly recommended. Weaker algorithms, such as rsa-sha1, are no longer deemed secure against contemporary cryptographic threats.

Class org.simplejavamail.api.email.config.SmimeEncryptionConfig extends Object implements Serializable

serialVersionUID:

1234567L

Serialized Fields

x509Certificate

X509Certificate x509Certificate

keyEncapsulationAlgorithm

String keyEncapsulationAlgorithm

Configuration for S/MIME encryption, specifying the key encapsulation algorithm used for securing the encryption key. This setting is crucial for the security of the encrypted message, ensuring that the encryption key itself is transmitted securely and can only be accessed by the intended recipient.

Default Algorithm: RSA. Selected for broad compatibility and historical reasons, RSA without OAEP padding is the default. However, for enhanced security, it's recommended to use RSA with OAEP padding and SHA-256 or higher.

Recommended Algorithms: The use of RSA with OAEP padding is advised due to its improved security properties over plain RSA. Algorithms with SHA-256 or higher offer a stronger level of security and are recommended for most applications:

• RSA (Default, suitable for broad compatibility)
• RSA_OAEP_SHA224 (More secure than plain RSA, consider for transitional applications)
• RSA_OAEP_SHA256 (Highly recommended for new applications)
• RSA_OAEP_SHA384 (Enhanced security for higher requirements)
• RSA_OAEP_SHA512 (Maximum security level, recommended for very sensitive communications)

Refer to org.simplejavamail.utils.mail.smime.KeyEncapsulationAlgorithm for the most current list of supported algorithms.

Note: While the default RSA is widely compatible, the move towards RSA with OAEP padding is encouraged to ensure a higher level of security against modern cryptographic attacks. The choice of SHA-256 or higher as the hashing algorithm for OAEP provides a good balance between security and performance.

See Also:

EmailPopulatingBuilder.encryptWithSmime(SmimeEncryptionConfig)

cipherAlgorithm

String cipherAlgorithm

Configuration for S/MIME encryption, specifying the algorithm used for encrypting the email content. The choice of encryption algorithm impacts both the security of the encrypted message and its compatibility.

Default Algorithm: DES_EDE3_CBC. While this is provided for broad compatibility, it's recommended to use AES-based algorithms for enhanced security.

Recommended Encryption Algorithms: The following list focuses on secure and commonly used algorithms for S/MIME encryption. Note that AES is preferred due to its strong security features and performance efficiency. For a complete and updated list, consult the Bouncy Castle documentation. For a complete list of supported algorithms, refer to the Bouncy Castle's see org.bouncycastle.cms.CMSAlgorithm class.

• AES256_CBC (Recommended)
• AES192_CBC
• AES128_CBC
• DES_EDE3_CBC (for legacy compatibility)

Note: While DES_EDE3_CBC is supported for backward compatibility, AES (128, 192, 256) is strongly recommended for new applications due to its enhanced security and efficiency.

See Also:

EmailPopulatingBuilder.encryptWithSmime(SmimeEncryptionConfig)

Package org.simplejavamail.api.mailer

Class org.simplejavamail.api.mailer.EmailTooBigException extends RuntimeException implements Serializable