org.simplejavamail.mailer

Class MailerGenericBuilder<T extends MailerGenericBuilder>

java.lang.Object

org.simplejavamail.mailer.MailerGenericBuilder<T>

Direct Known Subclasses:

MailerBuilder.MailerRegularBuilder, MailerFromSessionBuilder

public abstract class MailerGenericBuilder<T extends MailerGenericBuilder>
extends Object

Builder superclass which contains API to take care of all generic Mailer properties unrelated to the SMTP server (host, port, username, password and transport strategy).

To start a new Mailer builder, refer to MailerBuilder.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_POOL_SIZE For multi-threaded scenario's where a batch of emails sent asynchronously, the default maximum number of threads is 10.
static int	DEFAULT_PROXY_BRIDGE_PORT The temporary intermediary SOCKS5 relay server bridge is a server that sits in between JavaMail and the remote proxy.
static int	DEFAULT_SESSION_TIMEOUT_MILLIS The default maximum timeout value for the transport socket is 60000 milliseconds (affects socket connect-, read- and write timeouts).
static boolean	DEFAULT_TRANSPORT_MODE_LOGGING_ONLY Defaults to false, sending mails rather than just only logging the mails.

Method Summary

Modifier and Type	Method and Description
T	clearEmailAddressCriteria() Removes all email address criteria, meaning validation won't take place.
T	clearProperties() Removes all properties.
T	clearProxy() Empties all proxy configuration.
T	clearTrustedSSLHosts() Removes all trusted hosts from the list.
Boolean	getDebugLogging()
EnumSet<org.hazlewood.connor.bottema.emailaddress.EmailAddressCriteria>	getEmailAddressCriteria()
Properties	getProperties()
Integer	getProxyBridgePort()
String	getProxyHost()
String	getProxyPassword()
Integer	getProxyPort()
String	getProxyUsername()
Integer	getSessionTimeout()
List<String>	getSslHostsToTrust()
Integer	getThreadPoolSize()
boolean	getTransportModeLoggingOnly()
Boolean	getTrustAllSSLHost()
T	resetEmailAddressCriteria() Resets emailAddressCriteria to EmailAddressCriteria.RFC_COMPLIANT.
T	resetSessionTimeout() Resets session time to its default (60000).
T	resetThreadpoolSize() Resets threadPoolSize to its default (10).
T	resetTransportModeLoggingOnly() Resets transportModeLoggingOnly to false.
T	trustingAllHosts(Boolean trustAllHosts) Configures the current session to trust all hosts and don't validate any SSL keys.
T	trustingSSLHosts(String... sslHostsToTrust) Configures the new session to only accept server certificates issued to one of the provided hostnames, and disables certificate issuer validation.
T	withDebugLogging(Boolean debugLogging) This flag is set on the Session instance through Session.setDebug(boolean) so that it generates debug information.
T	withEmailAddressCriteria(EnumSet<org.hazlewood.connor.bottema.emailaddress.EmailAddressCriteria> emailAddressCriteria) Sets the email address validation restrictions when validating and sending emails using the current Mailer instance.
T	withProperties(Map<String,String> properties)
T	withProperties(Properties properties) Adds the given properties to the total list applied to the Session when building a mailer.
T	withProperty(String propertyName, String propertyValue)
T	withProxy(String proxyHost, Integer proxyPort) Delegates to withProxyHost(String) and withProxyPort(Integer).
T	withProxy(String proxyHost, Integer proxyPort, String proxyUsername, String proxyPassword) Delegates to: withProxyHost(String) withProxyPort(Integer) withProxyUsername(String) withProxyPassword(String)
T	withProxyBridgePort(Integer proxyBridgePort) Relevant only when using username authentication with a proxy.
T	withProxyHost(String proxyHost) Sets the optional proxy host, which will override any default that might have been set (through properties file or programmatically).
T	withProxyPassword(String proxyPassword) Sets the optional password to authenticate with the proxy.
T	withProxyPort(Integer proxyPort) Sets the proxy port, which will override any default that might have been set (through properties file or programmatically).
T	withProxyUsername(String proxyUsername) Sets the optional username to authenticate with the proxy.
T	withSessionTimeout(Integer sessionTimeout) Controls the timeout to use when sending emails (affects socket connect-, read- and write timeouts).
T	withThreadPoolSize(Integer defaultPoolSize) Controls the maximum number of threads when sending emails in async fashion.
T	withTransportModeLoggingOnly(Boolean transportModeLoggingOnly) Determines whether at the very last moment an email is sent out using JavaMail's native API or whether the email is simply only logged.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_SESSION_TIMEOUT_MILLIS

public static final int DEFAULT_SESSION_TIMEOUT_MILLIS

The default maximum timeout value for the transport socket is 60000 milliseconds (affects socket connect-, read- and write timeouts). Can be overridden from a config file or through System variable.

See Also:

Constant Field Values

DEFAULT_POOL_SIZE

public static final int DEFAULT_POOL_SIZE

For multi-threaded scenario's where a batch of emails sent asynchronously, the default maximum number of threads is 10. Can be overridden from a config file or through System variable.

See Also:

Constant Field Values

DEFAULT_PROXY_BRIDGE_PORT

public static final int DEFAULT_PROXY_BRIDGE_PORT

The temporary intermediary SOCKS5 relay server bridge is a server that sits in between JavaMail and the remote proxy. Default port is 1081.

See Also:

Constant Field Values

DEFAULT_TRANSPORT_MODE_LOGGING_ONLY

public static final boolean DEFAULT_TRANSPORT_MODE_LOGGING_ONLY

Defaults to false, sending mails rather than just only logging the mails.

See Also:

Constant Field Values

Method Detail

withProxy

public T withProxy(@Nullable
                   String proxyHost,
                   @Nullable
                   Integer proxyPort)

Delegates to withProxyHost(String) and withProxyPort(Integer).

withProxy

public T withProxy(@Nullable
                   String proxyHost,
                   @Nullable
                   Integer proxyPort,
                   @Nullable
                   String proxyUsername,
                   @Nullable
                   String proxyPassword)

Delegates to:

1. withProxyHost(String)
2. withProxyPort(Integer)
3. withProxyUsername(String)
4. withProxyPassword(String)

withProxyHost

public T withProxyHost(@Nullable
                       String proxyHost)

Sets the optional proxy host, which will override any default that might have been set (through properties file or programmatically).

withProxyPort

public T withProxyPort(@Nullable
                       Integer proxyPort)

Sets the proxy port, which will override any default that might have been set (through properties file or programmatically).

Proxy port is required if a proxyHost has been configured.

withProxyUsername

public T withProxyUsername(@Nullable
                           String proxyUsername)

Sets the optional username to authenticate with the proxy.

If set, Simple Java Mail will use its built in proxy bridge to perform the SOCKS authentication, as the underlying JavaMail framework doesn't support this directly.

The path will be:
Simple Java Mail -> JavaMail -> anonymous authentication with local proxy bridge -> full authentication with remote SOCKS proxy.

withProxyPassword

public T withProxyPassword(@Nullable
                           String proxyPassword)

Sets the optional password to authenticate with the proxy.

See Also:

withProxyUsername(String)

withProxyBridgePort

public T withProxyBridgePort(@Nullable
                             Integer proxyBridgePort)

Relevant only when using username authentication with a proxy.

Overrides the default for the intermediary SOCKS5 relay server bridge, which is a server that sits in between JavaMail and the remote proxy. Defaults to 1081 if no custom default property was configured.

See Also:

withProxyUsername(String)

withDebugLogging

public T withDebugLogging(@Nullable
                          Boolean debugLogging)

This flag is set on the Session instance through Session.setDebug(boolean) so that it generates debug information. To get more information out of the underlying JavaMail framework or out of Simple Java Mail, increase logging config of your chosen logging framework.

withSessionTimeout

public T withSessionTimeout(@Nullable
                            Integer sessionTimeout)

Controls the timeout to use when sending emails (affects socket connect-, read- and write timeouts).

withEmailAddressCriteria

public T withEmailAddressCriteria(@Nonnull
                                  EnumSet<org.hazlewood.connor.bottema.emailaddress.EmailAddressCriteria> emailAddressCriteria)

Sets the email address validation restrictions when validating and sending emails using the current Mailer instance.

Defaults to EmailAddressCriteria.RFC_COMPLIANT if not overridden with a (null) value.

See Also:

EmailAddressCriteria, clearEmailAddressCriteria(), resetEmailAddressCriteria()

withThreadPoolSize

public T withThreadPoolSize(@Nonnull
                            Integer defaultPoolSize)

Controls the maximum number of threads when sending emails in async fashion. Defaults to DEFAULT_POOL_SIZE.

See Also:

resetThreadpoolSize()

withTransportModeLoggingOnly

public T withTransportModeLoggingOnly(@Nonnull
                                      Boolean transportModeLoggingOnly)

Determines whether at the very last moment an email is sent out using JavaMail's native API or whether the email is simply only logged.

See Also:

resetTransportModeLoggingOnly()

trustingSSLHosts

public T trustingSSLHosts(String... sslHostsToTrust)

Configures the new session to only accept server certificates issued to one of the provided hostnames, and disables certificate issuer validation.

Passing an empty list resets the current session's trust behavior to the default, and is equivalent to never calling this method in the first place.

Security warning: Any certificate matching any of the provided host names will be accepted, regardless of the certificate issuer; attackers can abuse this behavior by serving a matching self-signed certificate during a man-in-the-middle attack.

This method sets the property mail.smtp.ssl.trust to a space-separated list of the provided hosts. If the provided list is empty, mail.smtp.ssl.trust is unset.

See Also:

mail.smtp.ssl.trust, trustingAllHosts(Boolean)

trustingAllHosts

public T trustingAllHosts(@Nonnull
                          Boolean trustAllHosts)

Configures the current session to trust all hosts and don't validate any SSL keys. The property "mail.smtp(s).ssl.trust" is set to "*".

Refer to https://javamail.java.net/nonav/docs/api/com/sun/mail/smtp/package-summary.html#mail.smtp.ssl.trust

See Also:

trustingSSLHosts(String...)

withProperties

public T withProperties(@Nonnull
                        Properties properties)

Adds the given properties to the total list applied to the Session when building a mailer.

See Also:

withProperties(Map), withProperty(String, String), clearProperties()

withProperties

public T withProperties(@Nonnull
                        Map<String,String> properties)

See Also:

withProperties(Properties), clearProperties()

withProperty

public T withProperty(@Nonnull
                      String propertyName,
                      @Nullable
                      String propertyValue)

See Also:

withProperties(Properties), clearProperties()

resetSessionTimeout

public T resetSessionTimeout()

Resets session time to its default (60000).

See Also:

withSessionTimeout(Integer)

resetEmailAddressCriteria

public T resetEmailAddressCriteria()

Resets emailAddressCriteria to EmailAddressCriteria.RFC_COMPLIANT.

See Also:

withEmailAddressCriteria(EnumSet), clearEmailAddressCriteria()

resetThreadpoolSize

public T resetThreadpoolSize()

Resets threadPoolSize to its default (10).

See Also:

withThreadPoolSize(Integer)

resetTransportModeLoggingOnly

public T resetTransportModeLoggingOnly()

Resets transportModeLoggingOnly to false.

See Also:

withTransportModeLoggingOnly(Boolean)

clearProxy

public T clearProxy()

Empties all proxy configuration.

clearEmailAddressCriteria

public T clearEmailAddressCriteria()

Removes all email address criteria, meaning validation won't take place.

See Also:

withEmailAddressCriteria(EnumSet), resetEmailAddressCriteria()

clearTrustedSSLHosts

public T clearTrustedSSLHosts()

Removes all trusted hosts from the list.

See Also:

trustingSSLHosts(String...)

clearProperties

public T clearProperties()

Removes all properties.

See Also:

withProperties(Properties)

getProxyHost

public String getProxyHost()

See Also:

withProxyHost(String)

getProxyPort

public Integer getProxyPort()

See Also:

withProxyPort(Integer)

getProxyUsername

public String getProxyUsername()

See Also:

withProxyUsername(String)

getProxyPassword

public String getProxyPassword()

See Also:

withProxyPassword(String)

getProxyBridgePort

public Integer getProxyBridgePort()

See Also:

withProxyBridgePort(Integer)

getDebugLogging

public Boolean getDebugLogging()

See Also:

withDebugLogging(Boolean)

getSessionTimeout

public Integer getSessionTimeout()

See Also:

withSessionTimeout(Integer)

getEmailAddressCriteria

public EnumSet<org.hazlewood.connor.bottema.emailaddress.EmailAddressCriteria> getEmailAddressCriteria()

See Also:

withEmailAddressCriteria(EnumSet)

getThreadPoolSize

public Integer getThreadPoolSize()

See Also:

withThreadPoolSize(Integer)

getSslHostsToTrust

public List<String> getSslHostsToTrust()

See Also:

trustingSSLHosts(String...)

getTrustAllSSLHost

public Boolean getTrustAllSSLHost()

See Also:

trustingAllHosts(Boolean)

getTransportModeLoggingOnly

public boolean getTransportModeLoggingOnly()

See Also:

withTransportModeLoggingOnly(Boolean)

getProperties

public Properties getProperties()

See Also:

withProperties(Properties)