| Package | Description |
|---|---|
| org.simplejavamail.api.email |
| Modifier and Type | Method and Description |
|---|---|
EmailPopulatingBuilder |
EmailPopulatingBuilder.allowingEmbeddedImageOutsideBaseClassPath(boolean allowEmbeddedImageOutsideBaseClassPath)
Dictates whether sources will be resolved for embedded images when they are not nested under the baseClassPath (if baseClassPath is set).
|
EmailPopulatingBuilder |
EmailPopulatingBuilder.allowingEmbeddedImageOutsideBaseDir(boolean allowEmbeddedImageOutsideBaseDir)
Dictates whether files will be resolved for embedded images when they are not nested under the baseDir (if baseDir is set).
|
EmailPopulatingBuilder |
EmailPopulatingBuilder.allowingEmbeddedImageOutsideBaseUrl(boolean allowEmbeddedImageOutsideBaseUrl)
Dictates whether url's will be resolved for embedded images when they are not nested under the baseUrl (if baseUrl is set).
|
EmailPopulatingBuilder |
EmailPopulatingBuilder.appendText(@NotNull File textFile)
Delegates to
appendText(String). |
EmailPopulatingBuilder |
EmailPopulatingBuilder.appendText(@NotNull String text)
Appends text to the current plain text body (or starts it if plain text body is missing).
|
EmailPopulatingBuilder |
EmailPopulatingBuilder.appendTextHTML(@NotNull File textHTMLFile)
Delegates to
appendTextHTML(String). |
EmailPopulatingBuilder |
EmailPopulatingBuilder.appendTextHTML(@NotNull String textHTML)
Appends HTML text to the current HTML text body (or starts it if HTML text body is missing).
|
EmailPopulatingBuilder |
EmailPopulatingBuilder.bcc(@NotNull Collection<Recipient> recipients)
Delegates to
withRecipients(Collection, Message.RecipientType) with fixedRecipientType=Message.RecipientType#BCC. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.bcc(@NotNull jakarta.mail.internet.InternetAddress address)
Delegates to
withAddressesWithDefaultName(String, Collection, Message.RecipientType) with recipientType=Message.RecipientType#BCC and empty default name. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.bcc(Recipient... recipients)
Delegates to
withRecipients(Collection, Message.RecipientType) with fixedRecipientType=Message.RecipientType#BCC. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.bcc(@NotNull String oneOrMoreAddresses)
Delegates to
withRecipientsWithDefaultName(String, Collection, Message.RecipientType) with recipientType=Message.RecipientType#BCC and empty default name. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.bcc(@Nullable String name,
@NotNull Collection<String> oneOrMoreAddressesEach)
Alias for
bccWithFixedName(String, Collection). |
EmailPopulatingBuilder |
EmailPopulatingBuilder.bcc(@Nullable String name,
jakarta.mail.internet.InternetAddress... addresses)
|
EmailPopulatingBuilder |
EmailPopulatingBuilder.bcc(@Nullable String name,
jakarta.mail.internet.InternetAddress address)
|
EmailPopulatingBuilder |
EmailPopulatingBuilder.bcc(@Nullable String name,
String... oneOrMoreAddressesEach)
Alias for
bccWithFixedName(String, String...). |
EmailPopulatingBuilder |
EmailPopulatingBuilder.bcc(@Nullable String name,
String oneOrMoreAddresses)
Delegates to
withRecipients(String, boolean, Collection, Message.RecipientType), with recipientType=Message.RecipientType#BCC
and fixedName=true assigning or overwriting existing names with the provided name. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.bccAddresses(@NotNull Collection<String> oneOrMoreAddressesEach)
Delegates to
withRecipientsWithDefaultName(String, Collection, Message.RecipientType) with recipientType=Message.RecipientType#BCC and empty default name. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.bccAddresses(@Nullable String name,
@NotNull Collection<jakarta.mail.internet.InternetAddress> addresses)
|
EmailPopulatingBuilder |
EmailPopulatingBuilder.bccAddressesWithDefaultName(@NotNull String name,
@NotNull Collection<jakarta.mail.internet.InternetAddress> addresses)
Delegates to
withAddressesWithDefaultName(String, Collection, Message.RecipientType) with recipientType=Message.RecipientType#BCC. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.bccAddressesWithDefaultName(@NotNull String name,
jakarta.mail.internet.InternetAddress... addresses)
Delegates to
withAddressesWithDefaultName(String, Collection, Message.RecipientType) with recipientType=Message.RecipientType#BCC. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.bccAddressesWithFixedName(@Nullable String name,
@NotNull Collection<jakarta.mail.internet.InternetAddress> addresses)
Delegates to
withAddressesWithFixedName(String, Collection, Message.RecipientType) with recipientType=Message.RecipientType#BCC. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.bccAddressesWithFixedName(@Nullable String name,
jakarta.mail.internet.InternetAddress... addresses)
Delegates to
withAddressesWithFixedName(String, Collection, Message.RecipientType) with recipientType=Message.RecipientType#BCC. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.bccMultiple(jakarta.mail.internet.InternetAddress... addresses)
Delegates to
withAddressesWithDefaultName(String, Collection, Message.RecipientType) with recipientType=Message.RecipientType#BCC and empty default name. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.bccMultiple(String... oneOrMoreAddressesEach)
Delegates to
withRecipientsWithDefaultName(String, Collection, Message.RecipientType) with recipientType=Message.RecipientType#BCC and empty default name. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.bccMultipleAddresses(@NotNull Collection<jakarta.mail.internet.InternetAddress> addresses)
Delegates to
withAddressesWithDefaultName(String, Collection, Message.RecipientType) with recipientType=Message.RecipientType#BCC and empty default name. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.bccWithDefaultName(@NotNull String name,
@NotNull Collection<String> oneOrMoreAddressesEach)
Delegates to
withRecipientsWithDefaultName(String, Collection, Message.RecipientType) with recipientType=Message.RecipientType#BCC. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.bccWithDefaultName(@NotNull String name,
String... oneOrMoreAddressesEach)
Delegates to
withRecipientsWithDefaultName(String, Collection, Message.RecipientType) with recipientType=Message.RecipientType#BCC. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.bccWithFixedName(@Nullable String name,
@NotNull Collection<String> oneOrMoreAddressesEach)
Delegates to
withRecipientsWithFixedName(String, Collection, Message.RecipientType) with recipientType=Message.RecipientType#BCC. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.bccWithFixedName(@Nullable String name,
String... oneOrMoreAddressesEach)
Delegates to
withRecipientsWithFixedName(String, Collection, Message.RecipientType) with recipientType=Message.RecipientType#BCC. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.cc(@NotNull Collection<Recipient> recipients)
Delegates to
withRecipients(Collection, Message.RecipientType) with recipientType=Message.RecipientType#CC. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.cc(@NotNull jakarta.mail.internet.InternetAddress address)
Delegates to
withAddressesWithDefaultName(String, Collection, Message.RecipientType) with recipientType=Message.RecipientType#CC and empty default name. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.cc(Recipient... recipients)
Delegates to
withRecipients(Collection, Message.RecipientType) with recipientType=Message.RecipientType#CC. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.cc(@NotNull String oneOrMoreAddresses)
Delegates to
withRecipientsWithDefaultName(String, Collection, Message.RecipientType) with recipientType=Message.RecipientType#CC and empty default name. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.cc(@Nullable String name,
@NotNull Collection<String> oneOrMoreAddressesEach)
Alias for
ccWithFixedName(String, Collection). |
EmailPopulatingBuilder |
EmailPopulatingBuilder.cc(@Nullable String name,
jakarta.mail.internet.InternetAddress... addresses)
|
EmailPopulatingBuilder |
EmailPopulatingBuilder.cc(@Nullable String name,
jakarta.mail.internet.InternetAddress address)
|
EmailPopulatingBuilder |
EmailPopulatingBuilder.cc(@Nullable String name,
String... oneOrMoreAddressesEach)
Alias for
ccWithFixedName(String, String...). |
EmailPopulatingBuilder |
EmailPopulatingBuilder.cc(@Nullable String name,
String oneOrMoreAddresses)
Delegates to
withRecipients(String, boolean, Collection, Message.RecipientType), with recipientType=Message.RecipientType#CC
and fixedName=true assigning or overwriting existing names with the provided name. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.ccAddresses(@NotNull Collection<String> oneOrMoreAddressesEach)
Delegates to
withRecipientsWithDefaultName(String, Collection, Message.RecipientType) with recipientType=Message.RecipientType#CC and empty default name. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.ccAddresses(@Nullable String name,
@NotNull Collection<jakarta.mail.internet.InternetAddress> addresses)
Alias for
ccAddressesWithFixedName(String, Collection). |
EmailPopulatingBuilder |
EmailPopulatingBuilder.ccAddressesWithDefaultName(@NotNull String name,
@NotNull Collection<jakarta.mail.internet.InternetAddress> addresses)
Delegates to
withAddressesWithDefaultName(String, Collection, Message.RecipientType) with recipientType=Message.RecipientType#CC. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.ccAddressesWithDefaultName(@NotNull String name,
jakarta.mail.internet.InternetAddress... addresses)
Delegates to
withAddressesWithDefaultName(String, Collection, Message.RecipientType) with recipientType=Message.RecipientType#CC. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.ccAddressesWithFixedName(@Nullable String name,
@NotNull Collection<jakarta.mail.internet.InternetAddress> addresses)
Delegates to
withAddressesWithFixedName(String, Collection, Message.RecipientType) with recipientType=Message.RecipientType#CC. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.ccAddressesWithFixedName(@Nullable String name,
jakarta.mail.internet.InternetAddress... addresses)
Delegates to
withAddressesWithFixedName(String, Collection, Message.RecipientType) with recipientType=Message.RecipientType#CC. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.ccMultiple(jakarta.mail.internet.InternetAddress... addresses)
Delegates to
withAddressesWithDefaultName(String, Collection, Message.RecipientType) with recipientType=Message.RecipientType#CC and empty default name. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.ccMultiple(String... oneOrMoreAddressesEach)
Delegates to
withRecipientsWithDefaultName(String, Collection, Message.RecipientType) with recipientType=Message.RecipientType#CC and empty default name. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.ccMultipleAddresses(@NotNull Collection<jakarta.mail.internet.InternetAddress> addresses)
Delegates to
withAddressesWithDefaultName(String, Collection, Message.RecipientType) with recipientType=Message.RecipientType#CC and empty default name. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.ccWithDefaultName(@NotNull String name,
@NotNull Collection<String> oneOrMoreAddressesEach)
Delegates to
withRecipientsWithDefaultName(String, Collection, Message.RecipientType) with recipientType=Message.RecipientType#CC. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.ccWithDefaultName(@NotNull String name,
String... oneOrMoreAddressesEach)
Delegates to
withRecipientsWithDefaultName(String, Collection, Message.RecipientType) with recipientType=Message.RecipientType#CC. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.ccWithFixedName(@Nullable String name,
@NotNull Collection<String> oneOrMoreAddressesEach)
Delegates to
withRecipientsWithFixedName(String, Collection, Message.RecipientType) with recipientType=Message.RecipientType#CC. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.ccWithFixedName(@Nullable String name,
String... oneOrMoreAddressesEach)
Delegates to
withRecipientsWithFixedName(String, Collection, Message.RecipientType) with recipientType=Message.RecipientType#CC. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.clearAttachments()
Resets attachments to empty.
|
EmailPopulatingBuilder |
EmailPopulatingBuilder.clearBounceTo()
Resets bounceToRecipient to empty.
|
EmailPopulatingBuilder |
EmailPopulatingBuilder.clearCalendarText()
Resets calendarText to empty.
|
EmailPopulatingBuilder |
EmailPopulatingBuilder.clearContentTransferEncoding()
Resets contentTransferEncoding to
ContentTransferEncoding.QUOTED_PRINTABLE. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.clearDispositionNotificationTo()
Resets dispositionNotificationTo to empty.
|
EmailPopulatingBuilder |
EmailPopulatingBuilder.clearDkim()
Resets all dkim properties to empty.
|
EmailPopulatingBuilder |
EmailPopulatingBuilder.clearEmbeddedImageBaseClassPath()
Resets classpath base for embedded images to
null. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.clearEmbeddedImageBaseDir()
Resets base dir for embedded images to
null. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.clearEmbeddedImageBaseUrl()
Resets base URL for embedded images to
null. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.clearEmbeddedImages()
Resets embeddedImages to empty.
|
EmailPopulatingBuilder |
EmailPopulatingBuilder.clearFromRecipient()
Resets fromRecipient to empty.
|
EmailPopulatingBuilder |
EmailPopulatingBuilder.clearHeaders()
Resets headers to empty.
|
EmailPopulatingBuilder |
EmailPopulatingBuilder.clearHTMLText()
Resets textHTML to empty.
|
EmailPopulatingBuilder |
EmailPopulatingBuilder.clearId()
Resets id to empty.
|
EmailPopulatingBuilder |
EmailPopulatingBuilder.clearOverrideReceivers()
Resets overrideReceivers to empty.
|
EmailPopulatingBuilder |
EmailPopulatingBuilder.clearPlainText()
Resets text to empty.
|
EmailPopulatingBuilder |
EmailPopulatingBuilder.clearRecipients()
Resets recipients to empty.
|
EmailPopulatingBuilder |
EmailPopulatingBuilder.clearReplyTo()
Resets replyToRecipients to empty.
|
EmailPopulatingBuilder |
EmailPopulatingBuilder.clearReturnReceiptTo()
Resets returnReceiptTo to empty.
|
EmailPopulatingBuilder |
EmailPopulatingBuilder.clearSentDate()
Clears the fixed sent-date so that the current date is used again at the time of sending.
|
EmailPopulatingBuilder |
EmailPopulatingBuilder.clearSmime()
For signing and encrypting this email when sending, resets all S/MIME properties to empty.
|
EmailPopulatingBuilder |
EmailPopulatingBuilder.clearSMIMESignedAttachmentMergingBehavior()
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.
|
EmailPopulatingBuilder |
EmailPopulatingBuilder.clearSubject()
Resets subject to empty.
|
EmailPopulatingBuilder |
EmailStartingBuilder.copying(@NotNull Email email)
Preconfigures the builder with all the properties from the given email that are non-null.
|
EmailPopulatingBuilder |
EmailStartingBuilder.copying(@NotNull EmailPopulatingBuilder emailBuilder)
Delegates to
EmailStartingBuilder.copying(Email), by building the email first. |
EmailPopulatingBuilder |
EmailStartingBuilder.copying(@NotNull jakarta.mail.internet.MimeMessage message)
Delegates to
EmailStartingBuilder.copying(Email), by converting the provided message first. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.dontApplyDefaultValueFor(org.simplejavamail.internal.config.EmailProperty... configProperties)
Allows you to prevent a property to be configured with default values.
|
EmailPopulatingBuilder |
EmailPopulatingBuilder.dontApplyOverrideValueFor(org.simplejavamail.internal.config.EmailProperty... configProperties)
Allows you to prevent a property to be configured with override values.
|
EmailPopulatingBuilder |
EmailPopulatingBuilder.embeddedImageAutoResolutionMustBeSuccesful(boolean embeddedImageAutoResolutionMustBeSuccesful)
When embedded image auto resolution is enabled, this option will make sure unresolved images sources result in an exception.
|
EmailPopulatingBuilder |
EmailPopulatingBuilder.encryptWithSmime(@NotNull File pemFile,
@Nullable String keyEncapsulationAlgorithm,
@Nullable String cipherAlgorithm)
Delegates to
encryptWithSmime(SmimeEncryptionConfig) using the provided PEM file. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.encryptWithSmime(@NotNull SmimeEncryptionConfig smimeEncryptionConfig)
Encrypts this email with a X509 certificate according to the S/MIME spec
signature.
|
EmailPopulatingBuilder |
EmailPopulatingBuilder.fixingMessageId(@Nullable String id)
Sets optional ID to a fixed value, which is otherwise generated by the underlying JavaMail framework when sending the email.
|
EmailPopulatingBuilder |
EmailPopulatingBuilder.fixingSentDate(@NotNull Date sentDate)
When an email is sent it is converted to a MimeMessage at which time the sent-date is filled with the current date.
|
EmailPopulatingBuilder |
EmailStartingBuilder.forwarding(@NotNull Email email)
Delegates to
EmailStartingBuilder.forwarding(MimeMessage) with the provided Email converted to MimeMessage. |
EmailPopulatingBuilder |
EmailStartingBuilder.forwarding(@NotNull jakarta.mail.internet.MimeMessage message)
Primes the email to be build with proper subject and include the forwarded email as "message/rfc822" bodypart (valid RFC forward).
|
EmailPopulatingBuilder |
EmailPopulatingBuilder.from(@NotNull jakarta.mail.internet.InternetAddress fromAddress)
Delegates to
from(Recipient) with a new Recipient wrapped around the given email address. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.from(@NotNull Recipient recipient)
Sets the address of the sender of this email with given
Recipient (ignoring its Message.RecipientType if provided). |
EmailPopulatingBuilder |
EmailPopulatingBuilder.from(@NotNull String fromAddress)
Delegates to
from(String, String) with empty name. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.from(@Nullable String fixedName,
@NotNull jakarta.mail.internet.InternetAddress fromAddress)
Delegates to
from(Recipient) with a new Recipient wrapped around the given fixed name and email address. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.from(@Nullable String name,
@NotNull String fromAddress)
Delegates to
from(Recipient) with a new Recipient wrapped around the given name and email address. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.ignoringDefaults(boolean ignoreDefaults)
Indicates that when the email is sent, no default values whatsoever should be applied to the email.
|
EmailPopulatingBuilder |
EmailPopulatingBuilder.ignoringOverrides(boolean ignoreOverrides)
Indicates that when the email is sent, no override values whatsoever should be applied to the email.
|
EmailPopulatingBuilder |
EmailPopulatingBuilder.notMergingSingleSMIMESignedAttachment()
When the S/MIME module is loaded, S/MIME signed / encrypted attachments are decrypted and kept in a separate list.
|
EmailPopulatingBuilder |
EmailPopulatingBuilder.prependText(@NotNull File textFile)
Delegates to
prependText(String). |
EmailPopulatingBuilder |
EmailPopulatingBuilder.prependText(@NotNull String text)
Prepends text to the current plain text body (or starts it if plain text body is missing).
|
EmailPopulatingBuilder |
EmailPopulatingBuilder.prependTextHTML(@NotNull File textHTMLFile)
Delegates to
prependTextHTML(String). |
EmailPopulatingBuilder |
EmailPopulatingBuilder.prependTextHTML(@NotNull String textHTML)
Prepends HTML text to the current HTML text body (or starts it if HTML text body is missing).
|
EmailPopulatingBuilder |
EmailStartingBuilder.replyingTo(@NotNull Email email)
Delegates to
EmailStartingBuilder.replyingTo(MimeMessage, boolean, String) with replyToAll set to false and a default HTML quoting
template. |
EmailPopulatingBuilder |
EmailStartingBuilder.replyingTo(@NotNull Email email,
@NotNull String customQuotingTemplate)
Delegates to
EmailStartingBuilder.replyingTo(MimeMessage, boolean, String) with replyToAll set to false. |
EmailPopulatingBuilder |
EmailStartingBuilder.replyingTo(@NotNull jakarta.mail.internet.MimeMessage message)
Delegates to
EmailStartingBuilder.replyingTo(MimeMessage, boolean, String) with replyToAll set to false and a default HTML quoting
template. |
EmailPopulatingBuilder |
EmailStartingBuilder.replyingTo(@NotNull jakarta.mail.internet.MimeMessage emailMessage,
boolean repyToAll,
@NotNull String htmlTemplate)
Primes the email with subject, quoted content, headers, originally embedded images and recipients needed for a valid RFC reply.
|
EmailPopulatingBuilder |
EmailStartingBuilder.replyingTo(@NotNull jakarta.mail.internet.MimeMessage message,
@NotNull String customQuotingTemplate)
Delegates to
EmailStartingBuilder.replyingTo(MimeMessage, boolean, String) with replyToAll set to false. |
EmailPopulatingBuilder |
EmailStartingBuilder.replyingToAll(@NotNull Email email)
Delegates to
EmailStartingBuilder.replyingTo(MimeMessage, boolean, String) with replyToAll set to true and a default HTML quoting
template. |
EmailPopulatingBuilder |
EmailStartingBuilder.replyingToAll(@NotNull Email email,
@NotNull String customQuotingTemplate)
Delegates to
EmailStartingBuilder.replyingTo(MimeMessage, boolean, String) with replyToAll set to true. |
EmailPopulatingBuilder |
EmailStartingBuilder.replyingToAll(@NotNull jakarta.mail.internet.MimeMessage message)
Delegates to
EmailStartingBuilder.replyingTo(MimeMessage, boolean, String) with replyToAll set to true and a default HTML quoting
template. |
EmailPopulatingBuilder |
EmailStartingBuilder.replyingToAll(@NotNull jakarta.mail.internet.MimeMessage message,
@NotNull String customQuotingTemplate)
Delegates to
EmailStartingBuilder.replyingTo(MimeMessage, boolean, String) with replyToAll set to true. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.signWithDomainKey(byte[] dkimPrivateKey,
@NotNull String signingDomain,
@NotNull String dkimSelector,
@Nullable Set<String> excludedHeadersFromDkimDefaultSigningList)
Primes this email for signing with a DKIM domain key.
|
EmailPopulatingBuilder |
EmailPopulatingBuilder.signWithDomainKey(@NotNull DkimConfig dkimConfig)
Allows for more customization of the DKIM signing process by providing a
DkimConfig instance. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.signWithSmime(@NotNull File pkcs12StoreFile,
@NotNull String storePassword,
@NotNull String keyAlias,
@NotNull String keyPassword,
@Nullable String signatureAlgorithm)
Delegates to
signWithSmime(SmimeSigningConfig). |
EmailPopulatingBuilder |
EmailPopulatingBuilder.signWithSmime(@NotNull SmimeSigningConfig smimeSigningConfig)
Signs this email with an S/MIME signature, so the receiving client
can verify whether the email content was tampered with.
|
EmailPopulatingBuilder |
EmailStartingBuilder.startingBlank()
Most common use case for creating a new email.
|
EmailPopulatingBuilder |
EmailPopulatingBuilder.to(@NotNull Collection<Recipient> recipients)
Delegates to
withRecipients(Collection, Message.RecipientType) with recipientType=Message.RecipientType#TO. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.to(@NotNull jakarta.mail.internet.InternetAddress address)
Delegates to
withAddressesWithDefaultName(String, Collection, Message.RecipientType) with recipientType=Message.RecipientType#TO and empty default name. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.to(Recipient... recipients)
Delegates to
withRecipients(Collection, Message.RecipientType) with recipientType=Message.RecipientType#TO. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.to(@NotNull String oneOrMoreAddresses)
Delegates to
withRecipientsWithDefaultName(String, Collection, Message.RecipientType) with recipientType=Message.RecipientType#TO and empty default name. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.to(@Nullable String name,
@NotNull Collection<String> oneOrMoreAddressesEach)
Alias for
toWithFixedName(String, Collection). |
EmailPopulatingBuilder |
EmailPopulatingBuilder.to(@Nullable String name,
jakarta.mail.internet.InternetAddress... addresses)
|
EmailPopulatingBuilder |
EmailPopulatingBuilder.to(@Nullable String name,
jakarta.mail.internet.InternetAddress address)
|
EmailPopulatingBuilder |
EmailPopulatingBuilder.to(@Nullable String name,
String... oneOrMoreAddressesEach)
Alias for
toWithFixedName(String, String...). |
EmailPopulatingBuilder |
EmailPopulatingBuilder.to(@Nullable String name,
String oneOrMoreAddresses)
Delegates to
withRecipients(String, boolean, Collection, Message.RecipientType), with recipientType=Message.RecipientType#TO and
fixedName=true assigning or overwriting existing names with the provided name. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.toAddresses(@Nullable String name,
@NotNull Collection<jakarta.mail.internet.InternetAddress> addresses)
Alias for
toAddressesWithFixedName(String, Collection). |
EmailPopulatingBuilder |
EmailPopulatingBuilder.toAddressesWithDefaultName(@NotNull String name,
@NotNull Collection<jakarta.mail.internet.InternetAddress> addresses)
Delegates to
withAddressesWithDefaultName(String, Collection, Message.RecipientType) with recipientType=Message.RecipientType#TO. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.toAddressesWithDefaultName(@NotNull String name,
jakarta.mail.internet.InternetAddress... addresses)
Delegates to
withAddressesWithDefaultName(String, Collection, Message.RecipientType) with recipientType=Message.RecipientType#TO. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.toAddressesWithFixedName(@Nullable String name,
@NotNull Collection<jakarta.mail.internet.InternetAddress> addresses)
Delegates to
withAddressesWithFixedName(String, Collection, Message.RecipientType) with recipientType=Message.RecipientType#TO. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.toAddressesWithFixedName(@Nullable String name,
jakarta.mail.internet.InternetAddress... addresses)
Delegates to
withAddressesWithFixedName(String, Collection, Message.RecipientType) with recipientType=Message.RecipientType#TO. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.toMultiple(@NotNull Collection<String> oneOrMoreAddressesEach)
Delegates to
withRecipientsWithDefaultName(String, Collection, Message.RecipientType) with recipientType=Message.RecipientType#TO and empty default name. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.toMultiple(jakarta.mail.internet.InternetAddress... addresses)
Delegates to
withAddressesWithDefaultName(String, Collection, Message.RecipientType) with recipientType=Message.RecipientType#TO and empty default name. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.toMultiple(String... oneOrMoreAddressesEach)
Delegates to
withRecipientsWithDefaultName(String, Collection, Message.RecipientType) with recipientType=Message.RecipientType#TO and empty default name. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.toMultipleAddresses(@NotNull Collection<jakarta.mail.internet.InternetAddress> addresses)
Delegates to
withAddressesWithDefaultName(String, Collection, Message.RecipientType) with recipientType=Message.RecipientType#TO and empty default name. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.toWithDefaultName(@NotNull String name,
@NotNull Collection<String> oneOrMoreAddressesEach)
Delegates to
withRecipientsWithDefaultName(String, Collection, Message.RecipientType) with recipientType=Message.RecipientType#TO. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.toWithDefaultName(@NotNull String name,
String... oneOrMoreAddressesEach)
Delegates to
withRecipientsWithDefaultName(String, Collection, Message.RecipientType) with recipientType=Message.RecipientType#TO. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.toWithFixedName(@Nullable String name,
@NotNull Collection<String> oneOrMoreAddressesEach)
Delegates to
withRecipientsWithFixedName(String, Collection, Message.RecipientType) with recipientType=Message.RecipientType#TO. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.toWithFixedName(@Nullable String name,
String... oneOrMoreAddressesEach)
Delegates to
withRecipientsWithFixedName(String, Collection, Message.RecipientType) with recipientType=Message.RecipientType#TO. |
@NotNull EmailPopulatingBuilder |
EmailPopulatingBuilder.withAddresses(@Nullable String name,
boolean fixedName,
@NotNull Collection<jakarta.mail.internet.InternetAddress> addresses,
jakarta.mail.Message.RecipientType recipientType)
Delegates to
withRecipient(String, String, Message.RecipientType) for each address in the provided collection. |
@NotNull EmailPopulatingBuilder |
EmailPopulatingBuilder.withAddressesWithDefaultName(@Nullable String defaultName,
@NotNull Collection<jakarta.mail.internet.InternetAddress> addresses,
jakarta.mail.Message.RecipientType recipientType)
Delegates to
withAddresses(String, boolean, Collection, Message.RecipientType), leaving existing names intact and defaulting when missing. |
@NotNull EmailPopulatingBuilder |
EmailPopulatingBuilder.withAddressesWithFixedName(@Nullable String fixedName,
@NotNull Collection<jakarta.mail.internet.InternetAddress> addresses,
jakarta.mail.Message.RecipientType recipientType)
Delegates to
withAddresses(String, boolean, Collection, Message.RecipientType), with fixedName=true
assigning or overwriting existing names with the provided name. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.withAttachment(@Nullable String name,
byte[] data,
@NotNull String mimetype)
Delegates to
withAttachment(String, byte[], String, String, ContentTransferEncoding) with null-description and no forced content transfer encoding. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.withAttachment(@Nullable String name,
byte[] data,
@NotNull String mimetype,
@Nullable String description)
Delegates to
withAttachment(String, byte[], String, String, ContentTransferEncoding) with no forced content transfer encoding. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.withAttachment(@Nullable String name,
byte[] data,
@NotNull String mimetype,
@Nullable String description,
@Nullable ContentTransferEncoding contentTransferEncoding)
Delegates to
withAttachment(String, DataSource), with a named ByteArrayDataSource created using the provided name, data and mimetype. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.withAttachment(@Nullable String name,
@NotNull jakarta.activation.DataSource filedata)
Delegates to
withAttachment(String, DataSource, String, ContentTransferEncoding) with null-description and no forced content transfer encoding. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.withAttachment(@Nullable String name,
@NotNull jakarta.activation.DataSource filedata,
@Nullable String description)
Delegates to
withAttachment(String, DataSource, String, ContentTransferEncoding) with no forced content transfer encoding. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.withAttachment(@Nullable String name,
@NotNull jakarta.activation.DataSource filedata,
@Nullable String description,
@Nullable ContentTransferEncoding contentTransferEncoding)
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).
|
EmailPopulatingBuilder |
EmailPopulatingBuilder.withAttachments(@NotNull List<AttachmentResource> attachments)
Delegates to
withAttachment(String, DataSource) for each attachment. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.withBounceTo(@NotNull jakarta.mail.internet.InternetAddress bounceToAddress)
Delegates to
withBounceTo(Recipient) with a new Recipient wrapped around the given address. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.withBounceTo(@Nullable Recipient recipient)
Sets the bounceTo address of this email with given
Recipient (ignoring its Message.RecipientType if provided). |
EmailPopulatingBuilder |
EmailPopulatingBuilder.withBounceTo(@Nullable String bounceToAddress)
Delegates to
withBounceTo(Recipient) with a new Recipient wrapped around the email address (or null if missing). |
EmailPopulatingBuilder |
EmailPopulatingBuilder.withBounceTo(@Nullable String name,
@NotNull jakarta.mail.internet.InternetAddress bounceToAddress)
Delegates to
withBounceTo(Recipient) with a new Recipient wrapped around the given fixed name and address. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.withBounceTo(@Nullable String name,
@NotNull String bounceToAddress)
Delegates to
withBounceTo(Recipient) with a new Recipient wrapped around the given name and email address. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.withCalendarText(@NotNull CalendarMethod calendarMethod,
@NotNull String textCalendar)
Sets the optional calendar details that clients such as Outlook might be able to handle.
|
EmailPopulatingBuilder |
EmailPopulatingBuilder.withContentTransferEncoding(@NotNull ContentTransferEncoding contentTransferEncoding)
Determines what encoding is applied to the text/html/iCalendar encoding in the MimeMessage/EML.
|
EmailPopulatingBuilder |
EmailPopulatingBuilder.withDispositionNotificationTo()
Indicates that we want to use the NPM flag
dispositionNotificationTo. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.withDispositionNotificationTo(@NotNull jakarta.mail.internet.InternetAddress address)
Delegates to
withDispositionNotificationTo(Recipient) with a new Recipient wrapped around the provided address. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.withDispositionNotificationTo(@NotNull Recipient recipient)
Indicates this email should use the NPM flag "Disposition-Notification-To" with the given
preconfigred
Recipient. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.withDispositionNotificationTo(@NotNull String address)
Delegates to
withDispositionNotificationTo(Recipient) with a new Recipient wrapped around the provided address. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.withDispositionNotificationTo(@Nullable String fixedName,
@NotNull jakarta.mail.internet.InternetAddress address)
Delegates to
withDispositionNotificationTo(Recipient) with a new Recipient wrapped around the provided fixed name and address. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.withDispositionNotificationTo(@Nullable String name,
@NotNull String address)
Delegates to
withDispositionNotificationTo(Recipient) with a new Recipient wrapped around the provided name and address. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.withEmbeddedImage(@NotNull String name,
byte[] data,
@NotNull String mimetype)
Delegates to
withEmbeddedImage(String, DataSource), with a named ByteArrayDataSource created using the provided name, data and
mimetype. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.withEmbeddedImage(@Nullable String name,
@NotNull jakarta.activation.DataSource imagedata)
Adds image data to this email that can be referred to from the email HTML body.
|
EmailPopulatingBuilder |
EmailPopulatingBuilder.withEmbeddedImageAutoResolutionForClassPathResources(boolean embeddedImageAutoResolutionForClassPathResources)
Enables auto resolution of classpath datasources for embedded images.
|
EmailPopulatingBuilder |
EmailPopulatingBuilder.withEmbeddedImageAutoResolutionForFiles(boolean embeddedImageAutoResolutionForFiles)
Enables auto resolution of file datasources for embedded images.
|
EmailPopulatingBuilder |
EmailPopulatingBuilder.withEmbeddedImageAutoResolutionForURLs(boolean embeddedImageAutoResolutionForURLs)
Enables auto resolution of URL's for embedded images.
|
EmailPopulatingBuilder |
EmailPopulatingBuilder.withEmbeddedImageBaseClassPath(@NotNull String embeddedImageBaseClassPath)
Sets the classpath base used when resolving images sources in HTML text.
|
EmailPopulatingBuilder |
EmailPopulatingBuilder.withEmbeddedImageBaseDir(@NotNull String embeddedImageBaseDir)
Sets the base folder used when resolving images sources in HTML text.
|
EmailPopulatingBuilder |
EmailPopulatingBuilder.withEmbeddedImageBaseUrl(@NotNull String embeddedImageBaseUrl)
Delegates to
withEmbeddedImageBaseUrl(URL). |
EmailPopulatingBuilder |
EmailPopulatingBuilder.withEmbeddedImageBaseUrl(@NotNull URL embeddedImageBaseUrl)
Sets the base URL used when resolving images sources in HTML text.
|
EmailPopulatingBuilder |
EmailPopulatingBuilder.withEmbeddedImages(@NotNull List<AttachmentResource> embeddedImages)
Delegates to
withEmbeddedImage(String, DataSource) for each embedded image. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.withHeader(@NotNull String name,
@Nullable Object value)
Delegates to
withHeader(String, Object, boolean) with replaceHeader set to false. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.withHeader(@NotNull String name,
@Nullable Object value,
boolean replaceHeader)
Adds a header which will be included in the email.
|
<T> EmailPopulatingBuilder |
EmailPopulatingBuilder.withHeaders(@NotNull Map<String,Collection<T>> headers)
Delegates to
withHeader(String, Object) for each header in the provided Map. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.withHTMLText(@NotNull File textHTMLFile)
Delegates to
withHTMLText(String). |
EmailPopulatingBuilder |
EmailPopulatingBuilder.withHTMLText(@Nullable String textHTML)
Sets the optional email message body in HTML text.
|
EmailPopulatingBuilder |
EmailPopulatingBuilder.withOverrideReceivers(@NotNull List<Recipient> recipients)
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[])). |
EmailPopulatingBuilder |
EmailPopulatingBuilder.withOverrideReceivers(Recipient... recipients)
Delegates to
withOverrideReceivers(List) |
EmailPopulatingBuilder |
EmailPopulatingBuilder.withPlainText(@NotNull File textFile)
Delegates to
withPlainText(String). |
EmailPopulatingBuilder |
EmailPopulatingBuilder.withPlainText(@Nullable String text)
Sets the optional email message body in plain text.
|
EmailPopulatingBuilder |
EmailPopulatingBuilder.withRecipient(@NotNull Recipient recipient)
Adds a new
Recipient instance as copy of the provided recipient (copying name, address and Message.RecipientType). |
EmailPopulatingBuilder |
EmailPopulatingBuilder.withRecipient(@Nullable String name,
boolean fixedName,
@NotNull String singleAddress,
jakarta.mail.Message.RecipientType recipientType)
Adds a new
Recipient instance with the given name, address and Message.RecipientType. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.withRecipient(@NotNull String singleAddress,
jakarta.mail.Message.RecipientType recipientType)
Delegates to
withRecipient(String, String, Message.RecipientType) with the name omitted. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.withRecipient(@Nullable String name,
@NotNull String singleAddress,
jakarta.mail.Message.RecipientType recipientType)
Delegates to
withRecipient(String, boolean, String, Message.RecipientType) with the name omitted and fixedName = true. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.withRecipients(@NotNull Collection<Recipient> recipients)
Delegates to
withRecipients(Collection, Message.RecipientType) with Message.RecipientType left empty (so it will use the original values). |
@NotNull EmailPopulatingBuilder |
EmailPopulatingBuilder.withRecipients(@NotNull Collection<Recipient> recipients,
jakarta.mail.Message.RecipientType fixedRecipientType)
Delegates to
withRecipient(String, String, Message.RecipientType) for each recipient in the provided collection, optionally fixing the
recipientType for all recipients to the provided type. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.withRecipients(Recipient... recipients)
Delegates to
withRecipients(Collection, Message.RecipientType) with Message.RecipientType left empty (so it will use the original values). |
@NotNull EmailPopulatingBuilder |
EmailPopulatingBuilder.withRecipients(@Nullable String name,
boolean fixedName,
@NotNull Collection<String> oneOrMoreAddressesEach,
jakarta.mail.Message.RecipientType recipientType)
Delegates to
withRecipient(Recipient) for each address found in not just the collection, but also in every individual address string
that is in the collection. |
@NotNull EmailPopulatingBuilder |
EmailPopulatingBuilder.withRecipients(@Nullable String name,
boolean fixedName,
jakarta.mail.Message.RecipientType recipientType,
String... oneOrMoreAddressesEach)
|
@NotNull EmailPopulatingBuilder |
EmailPopulatingBuilder.withRecipientsWithDefaultName(@Nullable String defaultName,
@NotNull Collection<String> oneOrMoreAddressesEach,
jakarta.mail.Message.RecipientType recipientType)
Delegates to
withRecipients(String, boolean, Collection, Message.RecipientType), leaving existing names intact and defaulting when missing. |
@NotNull EmailPopulatingBuilder |
EmailPopulatingBuilder.withRecipientsWithDefaultName(@Nullable String name,
jakarta.mail.Message.RecipientType recipientType,
String... oneOrMoreAddressesEach)
|
@NotNull EmailPopulatingBuilder |
EmailPopulatingBuilder.withRecipientsWithFixedName(@Nullable String fixedName,
@NotNull Collection<String> oneOrMoreAddressesEach,
jakarta.mail.Message.RecipientType recipientType)
Delegates to
withRecipients(String, boolean, Collection, Message.RecipientType), with fixedName=true
assigning or overwriting existing names with the provided name. |
@NotNull EmailPopulatingBuilder |
EmailPopulatingBuilder.withRecipientsWithFixedName(@Nullable String name,
jakarta.mail.Message.RecipientType recipientType,
String... oneOrMoreAddressesEach)
|
EmailPopulatingBuilder |
EmailPopulatingBuilder.withReplyTo(@NotNull jakarta.mail.internet.InternetAddress replyToAddress)
Delegates to
withReplyTo(Recipient) with a new Recipient wrapped around the given address. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.withReplyTo(@NotNull List<Recipient> recipients)
Sets the replyTo address of this email with given
Recipient (ignoring its Message.RecipientType if provided). |
EmailPopulatingBuilder |
EmailPopulatingBuilder.withReplyTo(@NotNull Recipient recipient)
Delegates to #withReplyTo(Recipient...)
|
EmailPopulatingBuilder |
EmailPopulatingBuilder.withReplyTo(@NotNull String replyToAddress)
Delegates to
withReplyTo(Recipient) with a new Recipient wrapped around the given email address. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.withReplyTo(@Nullable String fixedName,
@NotNull jakarta.mail.internet.InternetAddress replyToAddress)
Delegates to
withReplyTo(Recipient) with a new Recipient wrapped around the given fixed name and address. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.withReplyTo(@Nullable String fixedName,
@NotNull String replyToAddress)
Delegates to
withReplyTo(Recipient) with a new Recipient wrapped around the given fixed name and email address. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.withReturnReceiptTo()
Indicates that we want to use the flag
returnReceiptTo. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.withReturnReceiptTo(@NotNull jakarta.mail.internet.InternetAddress address)
Delegates to
withReturnReceiptTo(Recipient) with a new Recipient wrapped around the provided address. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.withReturnReceiptTo(@NotNull Recipient recipient)
Indicates that this email should use the RRT flag "Return-Receipt-To" with the
preconfigured
Recipient. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.withReturnReceiptTo(@NotNull String address)
Delegates to
withReturnReceiptTo(Recipient) with a new Recipient wrapped around the provided address. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.withReturnReceiptTo(@Nullable String fixedName,
@NotNull jakarta.mail.internet.InternetAddress address)
Delegates to
withReturnReceiptTo(Recipient) with a new Recipient wrapped around the provided fixed name and address. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.withReturnReceiptTo(@Nullable String name,
@NotNull String address)
Delegates to
withReturnReceiptTo(Recipient) with a new Recipient wrapped around the provided name and address. |
EmailPopulatingBuilder |
EmailPopulatingBuilder.withSubject(@Nullable String subject)
Sets the optional subject of this email.
|
| Modifier and Type | Method and Description |
|---|---|
EmailPopulatingBuilder |
EmailStartingBuilder.copying(@NotNull EmailPopulatingBuilder emailBuilder)
Delegates to
EmailStartingBuilder.copying(Email), by building the email first. |
| Constructor and Description |
|---|
Email(@NotNull EmailPopulatingBuilder builder)
Simply transfers everything from
EmailPopulatingBuilder to this Email instance. |
Copyright © 2009–2025. All rights reserved.