ome.smuggler.core.types

Interface MailConfigSource

All Known Implementing Classes:

DevMailConfigSource, MailConfigReader

public interface MailConfigSource

Provides read-only, type-safe access to mail configuration.

See Also:

MailConfig

Method Summary

Modifier and Type	Method and Description
java.nio.file.Path	deadMailDir()
Email	fromAddress()
java.net.URI	mailServer()
java.util.Optional<java.lang.String>	password()
MailProtocol	protocol()
java.util.List<java.time.Duration>	retryIntervals()
boolean	skipServerCertificateValidation()
java.util.Optional<Email>	sysAdminAddress()
java.util.Optional<java.lang.String>	username()

Method Detail

fromAddress

Email fromAddress()

Returns:

the "from" address of each and every mail we send.

mailServer

java.net.URI mailServer()

Returns:

the host and port of the mail server.

protocol

MailProtocol protocol()

Returns:

the protocol to use to communicate with the mail server.

skipServerCertificateValidation

boolean skipServerCertificateValidation()

Returns:

whether to skip certificate validation when SMTPS is in use; always returns false if the protocol is not SMTPS.

username

java.util.Optional<java.lang.String> username()

Returns:

the username for logging into the mail server, if configured.

password

java.util.Optional<java.lang.String> password()

Returns:

the password for logging into the mail server, if configured.

retryIntervals

java.util.List<java.time.Duration> retryIntervals()

Returns:

intervals at which to retry failed mail relays.

deadMailDir

java.nio.file.Path deadMailDir()

Returns:

path to the directory where to keep email messages that could not be relayed to the mail server.

sysAdminAddress

java.util.Optional<Email> sysAdminAddress()

Returns:

the email address of the system administrator, if configured or empty otherwise.