public interface EmailGovernance
Mailer
instance. That is, this class represents actions
taken or configuration used by default for each individual email sent through the current mailer. For example, you might want to S/MIME sign all emails
by default. You can do it manually on each email of course, but then the keystore used for this is not reused.
Also, you can supply a custom email
instance which will be used for defaults or overrides. For example,
you can set a default from address or subject. Any fields that are not set on the email will be taken from the defaults (properties). Any fields that are set on the
email will be used instead of the defaults.
Modifier and Type | Method and Description |
---|---|
@Nullable com.sanctionco.jmail.EmailValidator |
getEmailValidator() |
@Nullable Integer |
getMaximumEmailSize() |
@NotNull Email |
produceEmailApplyingDefaultsAndOverrides(@Nullable Email provided)
This method will apply the defaults and overrides to the given email and return the result as a new instance.
|
@Nullable @Nullable com.sanctionco.jmail.EmailValidator getEmailValidator()
null
if no validation should be done.MailerGenericBuilder.withEmailValidator(EmailValidator)
,
EmailValidator
@Nullable @Nullable Integer getMaximumEmailSize()
MailerGenericBuilder.withMaximumEmailSize(int)
@NotNull @NotNull Email produceEmailApplyingDefaultsAndOverrides(@Nullable @Nullable Email provided)
Note that this is used automatically when sending or converting an email, so you don't need to call this yourself. This method might be useful
if you don't want to send the email, but just want to use a helper method or wish to inspect the email without sending (for the latter case
MailerGenericBuilder.withTransportModeLoggingOnly(Boolean)
might be of interest too).
Alternatively, you can also use EmailPopulatingBuilder.buildEmailCompletedWithDefaultsAndOverrides()
or
EmailPopulatingBuilder.buildEmailCompletedWithDefaultsAndOverrides(EmailGovernance)
.
provided
- The email to apply the defaults and overrides to. If null
, a new empty email will be created but will still be
populated with the defaults and overrides.Copyright © 2009–2024. All rights reserved.