org.simplejavamail.api.mailer

Interface CustomMailer

public interface CustomMailer

By default, Simple Java Mail handles the ultimate connection and sending of emails. However, it is possible to replace this last step with a custom implementation. Note this is not meant to 'override' the default behavior, but to provide a custom implementation for specific use cases (for example sending using MailChimp or SendGrid, or logging to your own database).

The benefit of this is that Simple Java Mail acts as an accelerator, providing thread pool, applying email content-validation, address validations, configuring a Session instance, producing a MimeMessage, all with full S/MIME, DKIM support and everything else.

Note: in this mode, proxy support is turned off assuming it is handled by the custom mailer as well.
Note: in this mode, the batch-module (SMTP cluster(s) / smtp connection pooling) won't be used either.

See Also:

MailerGenericBuilder.withCustomMailer(CustomMailer), Plug your own sending logic with a Custom Mailer

Method Summary

Modifier and Type	Method and Description
void	sendMessage(@NotNull OperationalConfig operationalConfig, @NotNull jakarta.mail.Session session, @NotNull Email email, @NotNull jakarta.mail.internet.MimeMessage message)
void	testConnection(@NotNull OperationalConfig operationalConfig, @NotNull jakarta.mail.Session session)

Method Detail

testConnection

void testConnection(@NotNull
                    @NotNull OperationalConfig operationalConfig,
                    @NotNull
                    @NotNull jakarta.mail.Session session)

sendMessage

void sendMessage(@NotNull
                 @NotNull OperationalConfig operationalConfig,
                 @NotNull
                 @NotNull jakarta.mail.Session session,
                 @NotNull
                 @NotNull Email email,
                 @NotNull
                 @NotNull jakarta.mail.internet.MimeMessage message)