org.simplejavamail.api.mailer

Interface MailerRegularBuilder<T extends MailerRegularBuilder<?>>

All Superinterfaces:

MailerGenericBuilder<T>

public interface MailerRegularBuilder<T extends MailerRegularBuilder<?>>
extends MailerGenericBuilder<T>

Default builder for generating Mailer instances. Sets defaults configured for SMTP host, SMTP port, SMTP username, SMTP password and transport strategy.

Note: To start creating a new Mailer, you use MailerBuilder directly instead.

Note: Any builder methods invoked after this will override the default value.

In addition on generic Mailer setting, this builder is used to configure SMTP server details and transport strategy needed to produce a valid Session instance.

See Also:

TransportStrategy

Field Summary

Fields inherited from interface org.simplejavamail.api.mailer.MailerGenericBuilder

DEFAULT_CONNECTIONPOOL_CLAIMTIMEOUT_MILLIS, DEFAULT_CONNECTIONPOOL_CORE_SIZE, DEFAULT_CONNECTIONPOOL_EXPIREAFTER_MILLIS, DEFAULT_CONNECTIONPOOL_LOADBALANCING_STRATEGY, DEFAULT_CONNECTIONPOOL_MAX_SIZE, DEFAULT_JAVAXMAIL_DEBUG, DEFAULT_POOL_KEEP_ALIVE_TIME, DEFAULT_POOL_SIZE, DEFAULT_PROXY_BRIDGE_PORT, DEFAULT_PROXY_PORT, DEFAULT_SESSION_TIMEOUT_MILLIS, DEFAULT_TRANSPORT_MODE_LOGGING_ONLY, DEFAULT_TRUST_ALL_HOSTS, DEFAULT_VERIFY_SERVER_IDENTITY

Method Summary

Modifier and Type	Method and Description
Mailer	buildMailer() Builds the actual Mailer instance with everything configured on this builder instance.
@Nullable String	getCustomSSLFactory()
@Nullable String	getHost()
@Nullable String	getPassword()
@Nullable Integer	getPort()
@Nullable TransportStrategy	getTransportStrategy()
@Nullable String	getUsername()
T	withCustomSSLFactoryClass(@Nullable String factoryClass) Configures the session with the right property to use your own factory for obtaining SSL connections.
T	withCustomSSLFactoryInstance(@Nullable SSLSocketFactory sslSocketFactoryInstance) Configures the session with the right property to use your own factory for obtaining SSL connections.
T	withSMTPServer(@Nullable String host, @Nullable Integer port) Delegates to withSMTPServerHost(String) and withSMTPServerPort(Integer).
T	withSMTPServer(@Nullable String host, @Nullable Integer port, @Nullable String username) Delegates to withSMTPServerHost(String), withSMTPServerPort(Integer) and withSMTPServerUsername(String).
T	withSMTPServer(@Nullable String host, @Nullable Integer port, @Nullable String username, @Nullable String password) Delegates to withSMTPServerHost(String), withSMTPServerPort(Integer), withSMTPServerUsername(String) and withSMTPServerPassword(String).
T	withSMTPServerHost(@Nullable String host) Sets the optional SMTP host.
T	withSMTPServerPassword(@Nullable String password) Sets the optional SMTP password.
T	withSMTPServerPort(@Nullable Integer port) Sets the optional SMTP port.
T	withSMTPServerUsername(@Nullable String username) Sets the optional SMTP username.
T	withTransportStrategy(@NotNull TransportStrategy transportStrategy) To learn more about the various transport modes, the properties they set and the security implications, please refer to the full TransportStrategy javadoc.

Methods inherited from interface org.simplejavamail.api.mailer.MailerGenericBuilder

async, clearEmailValidator, clearProperties, clearProxy, clearSignByDefaultWithSmime, clearTrustedSSLHosts, getClusterKey, getConnectionPoolClaimTimeoutMillis, getConnectionPoolCoreSize, getConnectionPoolExpireAfterMillis, getConnectionPoolLoadBalancingStrategy, getConnectionPoolMaxSize, getCustomMailer, getEmailValidator, getExecutorService, getPkcs12ConfigForSmimeSigning, getProperties, getProxyBridgePort, getProxyHost, getProxyPassword, getProxyPort, getProxyUsername, getSessionTimeout, getSslHostsToTrust, getThreadPoolKeepAliveTime, getThreadPoolSize, isAsync, isDebugLogging, isTransportModeLoggingOnly, isTrustAllSSLHost, isVerifyingServerIdentity, resetClusterKey, resetConnectionPoolClaimTimeoutMillis, resetConnectionPoolCoreSize, resetConnectionPoolExpireAfterMillis, resetConnectionPoolLoadBalancingStrategy, resetConnectionPoolMaxSize, resetEmailValidator, resetExecutorService, resetSessionTimeout, resetThreadPoolKeepAliveTime, resetThreadPoolSize, resetTransportModeLoggingOnly, resetTrustingAllHosts, resetVerifyingServerIdentity, signByDefaultWithSmime, signByDefaultWithSmime, signByDefaultWithSmime, signByDefaultWithSmime, trustingAllHosts, trustingSSLHosts, verifyingServerIdentity, withClusterKey, withConnectionPoolClaimTimeoutMillis, withConnectionPoolCoreSize, withConnectionPoolExpireAfterMillis, withConnectionPoolLoadBalancingStrategy, withConnectionPoolMaxSize, withCustomMailer, withDebugLogging, withEmailValidator, withExecutorService, withProperties, withProperties, withProperty, withProxy, withProxy, withProxyBridgePort, withProxyHost, withProxyPassword, withProxyPort, withProxyUsername, withSessionTimeout, withThreadPoolKeepAliveTime, withThreadPoolSize, withTransportModeLoggingOnly

Method Detail

withTransportStrategy

T withTransportStrategy(@NotNull
                        @NotNull TransportStrategy transportStrategy)

To learn more about the various transport modes, the properties they set and the security implications, please refer to the full TransportStrategy
javadoc.

Note: if no server port has been set, a default will be taken based on the transport strategy, since every different connection type uses a different default port.

Parameters:

transportStrategy - The name of the transport strategy to use: TransportStrategy.SMTP, TransportStrategy.SMTPS or TransportStrategy.SMTP_TLS. Defaults to TransportStrategy.SMTP.

withSMTPServer

T withSMTPServer(@Nullable
                 @Nullable String host,
                 @Nullable
                 @Nullable Integer port,
                 @Nullable
                 @Nullable String username,
                 @Nullable
                 @Nullable String password)

Delegates to withSMTPServerHost(String), withSMTPServerPort(Integer), withSMTPServerUsername(String) and withSMTPServerPassword(String).

Parameters:

host - Optional host that defaults to pre-configured property if left empty.

port - Optional port number that defaults to pre-configured property if left empty.

username - Optional username that defaults to pre-configured property if left empty.

password - Optional password that defaults to pre-configured property if left empty.

withSMTPServer

T withSMTPServer(@Nullable
                 @Nullable String host,
                 @Nullable
                 @Nullable Integer port,
                 @Nullable
                 @Nullable String username)

Delegates to withSMTPServerHost(String), withSMTPServerPort(Integer) and withSMTPServerUsername(String).

Parameters:

host - Optional host that defaults to pre-configured property if left empty.

port - Optional port number that defaults to pre-configured property if left empty.

username - Optional username that defaults to pre-configured property if left empty.

withSMTPServer

T withSMTPServer(@Nullable
                 @Nullable String host,
                 @Nullable
                 @Nullable Integer port)

Delegates to withSMTPServerHost(String) and withSMTPServerPort(Integer).

Parameters:

host - Optional host that defaults to pre-configured property if left empty.

port - Optional port number that defaults to pre-configured property if left empty.

withSMTPServerHost

T withSMTPServerHost(@Nullable
                     @Nullable String host)

Sets the optional SMTP host. Will default to pre-configured property if left empty.

Parameters:

host - Optional host that defaults to pre-configured property if left empty.

withSMTPServerPort

T withSMTPServerPort(@Nullable
                     @Nullable Integer port)

Sets the optional SMTP port. Will default to pre-configured property if not overridden. If left empty, the default will be determined based on the transport strategy.

Parameters:

port - Optional port number that defaults to pre-configured property if left empty.

withSMTPServerUsername

T withSMTPServerUsername(@Nullable
                         @Nullable String username)

Sets the optional SMTP username. Will default to pre-configured property if left empty.

Parameters:

username - Optional username that defaults to pre-configured property if left empty.

withSMTPServerPassword

T withSMTPServerPassword(@Nullable
                         @Nullable String password)

Sets the optional SMTP password. Will default to pre-configured property if left empty.

Parameters:

password - Optional password that defaults to pre-configured property if left empty.

withCustomSSLFactoryClass

T withCustomSSLFactoryClass(@Nullable
                            @Nullable String factoryClass)

Configures the session with the right property to use your own factory for obtaining SSL connections.

Note 1: Is overridden by custom factory instance if set.

Note 2: Sets the property mail.smtp.ssl.socketFactory.class on the Session.
Note 3: This breaks your setup if you also use authenticated proxy.

Parameters:

factoryClass - The fully qualified name of the factory class. Example: javax.net.ssl.SSLSocketFactory

See Also:

Java / Jakarta Mail properties, withCustomSSLFactoryInstance(SSLSocketFactory)

withCustomSSLFactoryInstance

T withCustomSSLFactoryInstance(@Nullable
                               @Nullable SSLSocketFactory sslSocketFactoryInstance)

Configures the session with the right property to use your own factory for obtaining SSL connections.

Note 1: Overrides custom factory class if set.

Note 2: Sets the property mail.smtp.ssl.socketFactory on the Session.
Note 3: This breaks your setup if you also use authenticated proxy.

Parameters:

sslSocketFactoryInstance - An instance of the SSLSocketFactory class.

See Also:

Java / Jakarta Mail properties, withCustomSSLFactoryClass(String)

buildMailer

Mailer buildMailer()

Builds the actual Mailer instance with everything configured on this builder instance.

For all configurable values: if omitted, a default value will be attempted by looking at property files or manually defined defauls.

Specified by:

buildMailer in interface MailerGenericBuilder<T extends MailerRegularBuilder<?>>

getHost

@Nullable
@Nullable String getHost()

See Also:

withSMTPServerHost(String)

getPort

@Nullable
@Nullable Integer getPort()

See Also:

withSMTPServerPort(Integer)

getUsername

@Nullable
@Nullable String getUsername()

See Also:

withSMTPServerUsername(String)

getPassword

@Nullable
@Nullable String getPassword()

See Also:

withSMTPServerPassword(String)

getTransportStrategy

@Nullable
@Nullable TransportStrategy getTransportStrategy()

See Also:

withTransportStrategy(TransportStrategy)

getCustomSSLFactory

@Nullable
@Nullable String getCustomSSLFactory()

See Also:

withCustomSSLFactoryClass(String)