public interface EmailStartingBuilder
Note: To start creating a new Email, you use EmailBuilder
directly instead.
Modifier and Type | Field and Description |
---|---|
static String |
DEFAULT_QUOTING_MARKUP
Default simple quoting markup for email replies:
|
static Pattern |
LINE_START_PATTERN
Used for replying to email, when quoting the original email.
|
Modifier and Type | Method and Description |
---|---|
EmailPopulatingBuilder |
copying(@NotNull Email email)
Preconfigures the builder with all the properties from the given email that are non-null.
|
EmailPopulatingBuilder |
copying(@NotNull EmailPopulatingBuilder emailBuilder)
Delegates to
copying(Email) , by building the email first. |
EmailPopulatingBuilder |
copying(@NotNull jakarta.mail.internet.MimeMessage message)
Delegates to
copying(Email) , by converting the provided message first. |
EmailPopulatingBuilder |
forwarding(@NotNull Email email)
|
EmailPopulatingBuilder |
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).
|
EmailStartingBuilder |
ignoringDefaults()
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 . |
EmailStartingBuilder |
ignoringOverrides()
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 . |
EmailPopulatingBuilder |
replyingTo(@NotNull Email email)
Delegates to
replyingTo(MimeMessage, boolean, String) with replyToAll set to false and a default HTML quoting
template. |
EmailPopulatingBuilder |
replyingTo(@NotNull Email email,
@NotNull String customQuotingTemplate)
Delegates to
replyingTo(MimeMessage, boolean, String) with replyToAll set to false . |
EmailPopulatingBuilder |
replyingTo(@NotNull jakarta.mail.internet.MimeMessage message)
Delegates to
replyingTo(MimeMessage, boolean, String) with replyToAll set to false and a default HTML quoting
template. |
EmailPopulatingBuilder |
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 |
replyingTo(@NotNull jakarta.mail.internet.MimeMessage message,
@NotNull String customQuotingTemplate)
Delegates to
replyingTo(MimeMessage, boolean, String) with replyToAll set to false . |
EmailPopulatingBuilder |
replyingToAll(@NotNull Email email)
Delegates to
replyingTo(MimeMessage, boolean, String) with replyToAll set to true and a default HTML quoting
template. |
EmailPopulatingBuilder |
replyingToAll(@NotNull Email email,
@NotNull String customQuotingTemplate)
Delegates to
replyingTo(MimeMessage, boolean, String) with replyToAll set to true . |
EmailPopulatingBuilder |
replyingToAll(@NotNull jakarta.mail.internet.MimeMessage message)
Delegates to
replyingTo(MimeMessage, boolean, String) with replyToAll set to true and a default HTML quoting
template. |
EmailPopulatingBuilder |
replyingToAll(@NotNull jakarta.mail.internet.MimeMessage message,
@NotNull String customQuotingTemplate)
Delegates to
replyingTo(MimeMessage, boolean, String) with replyToAll set to true . |
EmailPopulatingBuilder |
startingBlank()
Most common use case for creating a new email.
|
static final Pattern LINE_START_PATTERN
Pattern used: "(?m)^"
replyingTo(MimeMessage, boolean, String)
static final String DEFAULT_QUOTING_MARKUP
"
%s
"
EmailStartingBuilder ignoringDefaults()
EmailGovernance
. You can make individual exceptions with
* EmailPopulatingBuilder.dontApplyDefaultValueFor(EmailProperty...)
EmailGovernance
as defaults or overrides reference.EmailStartingBuilder ignoringOverrides()
EmailGovernance
. You can make individual exceptions with
EmailPopulatingBuilder.dontApplyOverrideValueFor(EmailProperty...)
EmailGovernance
as defaults or overrides reference.EmailPopulatingBuilder startingBlank()
ignoringDefaults()
.
Note: Any builder method called after this will override the default value.
EmailStartingBuilder
to further populate the email with.EmailPopulatingBuilder replyingTo(@NotNull @NotNull Email email)
replyingTo(MimeMessage, boolean, String)
with replyToAll set to false
and a default HTML quoting
template.EmailPopulatingBuilder replyingToAll(@NotNull @NotNull Email email)
replyingTo(MimeMessage, boolean, String)
with replyToAll set to true
and a default HTML quoting
template.EmailPopulatingBuilder replyingToAll(@NotNull @NotNull Email email, @NotNull @NotNull String customQuotingTemplate)
replyingTo(MimeMessage, boolean, String)
with replyToAll set to true
.DEFAULT_QUOTING_MARKUP
EmailPopulatingBuilder replyingTo(@NotNull @NotNull Email email, @NotNull @NotNull String customQuotingTemplate)
replyingTo(MimeMessage, boolean, String)
with replyToAll set to false
.EmailPopulatingBuilder replyingTo(@NotNull @NotNull jakarta.mail.internet.MimeMessage message)
replyingTo(MimeMessage, boolean, String)
with replyToAll set to false
and a default HTML quoting
template.message
- MimeMessage to reply to with new email.EmailPopulatingBuilder replyingTo(@NotNull @NotNull jakarta.mail.internet.MimeMessage message, @NotNull @NotNull String customQuotingTemplate)
replyingTo(MimeMessage, boolean, String)
with replyToAll set to false
.message
- MimeMessage to reply to with new email.customQuotingTemplate
- HTML quoting template that should be used in the reply. Should include the substring "%s"
,
or else the original email is not embedded in the reply.EmailPopulatingBuilder replyingToAll(@NotNull @NotNull jakarta.mail.internet.MimeMessage message, @NotNull @NotNull String customQuotingTemplate)
replyingTo(MimeMessage, boolean, String)
with replyToAll set to true
.message
- The email to include as replied-to-email and who's receivers all will receive the new reply email.customQuotingTemplate
- HTML quoting template that should be used in the reply. Should include the substring "%s"
,
or else the original email is not embedded in the reply.DEFAULT_QUOTING_MARKUP
EmailPopulatingBuilder replyingToAll(@NotNull @NotNull jakarta.mail.internet.MimeMessage message)
replyingTo(MimeMessage, boolean, String)
with replyToAll set to true
and a default HTML quoting
template.message
- The email to include as replied-to-email and who's receivers all will receive the new reply email.DEFAULT_QUOTING_MARKUP
EmailPopulatingBuilder replyingTo(@NotNull @NotNull jakarta.mail.internet.MimeMessage emailMessage, boolean repyToAll, @NotNull @NotNull String htmlTemplate)
Note 1: replaces subject with "Re: <original subject>" (but never nested).
Note 2: always sets both plain text and HTML text, so if you update the content body, be sure to update HTML as well.
Note 3: sets body content: text is replaced with "> text"
and HTML is replaced with the provided (or default) quoting markup
(add your own content with EmailPopulatingBuilder.prependText(String)
and EmailPopulatingBuilder.prependTextHTML(String)
).
emailMessage
- The message from which we harvest recipients, original content to quote (including embedded images), message ID to
include.repyToAll
- Indicates whether all original receivers should be included in this new reply. Also see MimeMessage.reply(boolean)
.htmlTemplate
- HTML quoting template that should be used in the reply. Should contain the substring "%s"
. Be advised that HTML is very limited in emails.replyingTo(Email)
,
replyingTo(Email, String)
,
replyingTo(MimeMessage)
,
replyingTo(MimeMessage, String)
,
replyingToAll(Email)
,
replyingToAll(Email, String)
,
replyingToAll(MimeMessage)
,
replyingToAll(MimeMessage, String)
,
Official JavaMail FAQ on replying,
MimeMessage.reply(boolean)
EmailPopulatingBuilder forwarding(@NotNull @NotNull Email email)
EmailPopulatingBuilder forwarding(@NotNull @NotNull jakarta.mail.internet.MimeMessage message)
Note 1: replaces subject with "Fwd: <original subject>" (nesting enabled).
Note 2: Content-Disposition
will be left empty so the receiving email client can decide how to handle display
(most will show inline, some will show as attachment instead).
message
- The message to be included in the new forwarding email.forwarding(Email)
EmailPopulatingBuilder copying(@NotNull @NotNull jakarta.mail.internet.MimeMessage message)
copying(Email)
, by converting the provided message first.message
- The MimeMessage email to convert and copy to new Email
.EmailPopulatingBuilder copying(@NotNull @NotNull EmailPopulatingBuilder emailBuilder)
copying(Email)
, by building the email first.EmailPopulatingBuilder.buildEmail()
EmailPopulatingBuilder copying(@NotNull @NotNull Email email)
Copyright © 2009–2024. All rights reserved.