MailerGenericBuilder (Simple Java Mail - Maven master project 7.3.0 API)

All Known Subinterfaces:

MailerFromSessionBuilder<T>, MailerRegularBuilder<T>
```
public interface MailerGenericBuilder<T extends MailerGenericBuilder<?>>
```
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).
Note: To start creating a new Mailer, you use MailerBuilder directly instead.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_CONNECTIONPOOL_CLAIMTIMEOUT_MILLIS` 2147483647 (`Integer.MAX_VALUE`), effectively indefinately.
`static int`	`DEFAULT_CONNECTIONPOOL_CORE_SIZE` 0
`static int`	`DEFAULT_CONNECTIONPOOL_EXPIREAFTER_MILLIS` 5000
`static String`	`DEFAULT_CONNECTIONPOOL_LOADBALANCING_STRATEGY` "ROUND_ROBIN"
`static int`	`DEFAULT_CONNECTIONPOOL_MAX_SIZE` 4
`static boolean`	`DEFAULT_JAVAXMAIL_DEBUG` Defaults to `false`, sending mails rather than just only logging the mails.
`static int`	`DEFAULT_POOL_KEEP_ALIVE_TIME` 1
`static int`	`DEFAULT_POOL_SIZE` 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_PROXY_PORT` Default port is `1080`.
`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.
`static boolean`	`DEFAULT_TRUST_ALL_HOSTS` true
`static boolean`	`DEFAULT_VERIFY_SERVER_IDENTITY` true

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`T`	`async()` Changes the default for sending emails and testing server connections to asynchronous (batch mode).
`Mailer`	`buildMailer()`
`T`	`clearEmailValidator()` Makes the email validator `null`, meaning validation won't take place.
`T`	`clearProperties()` Removes all properties.
`T`	`clearProxy()` Empties all proxy configuration.
`T`	`clearSignByDefaultWithSmime()` Removes S/MIME signing, so emails won't be signed by default.
`T`	`clearTrustedSSLHosts()` Removes all trusted hosts from the list.
`@Nullable UUID`	`getClusterKey()`
`@NotNull Integer`	`getConnectionPoolClaimTimeoutMillis()`
`@NotNull Integer`	`getConnectionPoolCoreSize()`
`@NotNull Integer`	`getConnectionPoolExpireAfterMillis()`
`@NotNull LoadBalancingStrategy`	`getConnectionPoolLoadBalancingStrategy()`
`@NotNull Integer`	`getConnectionPoolMaxSize()`
`@Nullable CustomMailer`	`getCustomMailer()`
`@Nullable com.sanctionco.jmail.EmailValidator`	`getEmailValidator()`
`@Nullable ExecutorService`	`getExecutorService()` Returns the user set ExecutorService or else null as the default ExecutorService is not created until the `OperationalConfig` is created for the new `Mailer` instance.
`@Nullable Pkcs12Config`	`getPkcs12ConfigForSmimeSigning()`
`@Nullable Properties`	`getProperties()`
`@Nullable Integer`	`getProxyBridgePort()`
`@Nullable String`	`getProxyHost()`
`@Nullable String`	`getProxyPassword()`
`@Nullable Integer`	`getProxyPort()`
`@Nullable String`	`getProxyUsername()`
`@Nullable Integer`	`getSessionTimeout()`
`@Nullable List<String>`	`getSslHostsToTrust()`
`@NotNull Integer`	`getThreadPoolKeepAliveTime()`
`@NotNull Integer`	`getThreadPoolSize()`
`boolean`	`isAsync()`
`boolean`	`isDebugLogging()`
`boolean`	`isTransportModeLoggingOnly()`
`boolean`	`isTrustAllSSLHost()`
`boolean`	`isVerifyingServerIdentity()`
`T`	`resetClusterKey()` Reset the cluster key to empty, so it will be generated uniquely, avoiding clustering with any other `Mailer`.
`T`	`resetConnectionPoolClaimTimeoutMillis()` Resets connection pool connection claim timeout back to indefinately.
`T`	`resetConnectionPoolCoreSize()` Resets connection pool core size to its default (0).
`T`	`resetConnectionPoolExpireAfterMillis()` Resets connection pool expire-after-milliseconds property to its default (5000).
`T`	`resetConnectionPoolLoadBalancingStrategy()` Resets connection pool load balancing strategy to its default ("ROUND_ROBIN").
`T`	`resetConnectionPoolMaxSize()` Resets connection pool max size to its default (4).
`T`	`resetEmailValidator()` Resets the email validator to `JMail.strictValidator()`.
`T`	`resetExecutorService()` Resets the executor services to be used back to the default, created by the Batch module if loaded, or else `Executors.newSingleThreadExecutor()`.
`T`	`resetSessionTimeout()` Resets session time to its default (60000).
`T`	`resetThreadPoolKeepAliveTime()` Resets thread pool keepAliveTime to its default (1).
`T`	`resetThreadPoolSize()` Resets max thread pool size to its default of 10.
`T`	`resetTransportModeLoggingOnly()` Resets transportModeLoggingOnly to false.
`T`	`resetTrustingAllHosts()` Reset trusting any host; trust all hosts is set to true.
`T`	`resetVerifyingServerIdentity()` Reset verifying the server's identity to true.
`T`	`signByDefaultWithSmime(@NotNull byte[] pkcs12StoreData, @NotNull String storePassword, @NotNull String keyAlias, @NotNull String keyPassword)` Delegates to `signByDefaultWithSmime(Pkcs12Config)`.
`T`	`signByDefaultWithSmime(@NotNull File pkcs12StoreFile, @NotNull String storePassword, @NotNull String keyAlias, @NotNull String keyPassword)` Delegates to `signByDefaultWithSmime(InputStream, String, String, String)`.
`T`	`signByDefaultWithSmime(@NotNull InputStream pkcs12StoreStream, @NotNull String storePassword, @NotNull String keyAlias, @NotNull String keyPassword)` Delegates to `signByDefaultWithSmime(byte[], String, String, String)`.
`T`	`signByDefaultWithSmime(@NotNull Pkcs12Config pkcs12Config)` Signs this all emails by default with an S/MIME signature, so the receiving client can verify whether the email content was tampered with.
`T`	`trustingAllHosts(boolean trustAllHosts)` Configures the current session to trust all hosts.
`T`	`trustingSSLHosts(String... sslHostsToTrust)` Configures the new session to only accept server certificates issued to one of the provided hostnames.
`T`	`verifyingServerIdentity(boolean verifyingServerIdentity)` Configures the current session to not verify the server's identity on an SSL connection.
`T`	`withClusterKey(@NotNull UUID clusterKey)` By defining a clusterKey, you can form clusters where other `Mailer` instances represent individual connection pools within the same cluster.
`T`	`withConnectionPoolClaimTimeoutMillis(@NotNull Integer connectionPoolClaimTimeoutMillis)` If `>0`, configures the connection pool to wait for a limited time after which the attempt to claim a Transport connection errors out.
`T`	`withConnectionPoolCoreSize(@NotNull Integer connectionPoolCoreSize)` Configures the connection pool's core size (default 0), which means the SMTP connection pool will keep X connections open at all times until shut down.
`T`	`withConnectionPoolExpireAfterMillis(@NotNull Integer connectionPoolExpireAfterMillis)` If `>0`, configures the connection pool to automatically close connections after some milliseconds (default 5000) since last usage.
`T`	`withConnectionPoolLoadBalancingStrategy(@NotNull LoadBalancingStrategy loadBalancingStrategy)` Defines the various types of load balancing modes supported by the connection pool ion the batch-module.
`T`	`withConnectionPoolMaxSize(@NotNull Integer connectionPoolMaxSize)` Configures the connection pool's max size (default 4) in case of high thread contention.
`T`	`withCustomMailer(@NotNull CustomMailer customMailer)`
`T`	`withDebugLogging(@NotNull Boolean debugLogging)` This flag is set on the Session instance through `Session.setDebug(boolean)` so that it generates debug information.
`T`	`withEmailValidator(@NotNull com.sanctionco.jmail.EmailValidator emailValidator)` Sets the email address validator used when validating and sending emails using the current `Mailer` instance.
`T`	`withExecutorService(@NotNull ExecutorService executorService)` For advanced use cases.
`T`	`withProperties(@NotNull Map<String,String> properties)`
`T`	`withProperties(@NotNull Properties properties)` Adds the given properties to the total list applied to the `Session` when building a mailer.
`T`	`withProperty(@NotNull String propertyName, @Nullable Object propertyValue)` Sets property or removes it if the provided value is `null`.
`T`	`withProxy(@Nullable String proxyHost, @Nullable Integer proxyPort)` Delegates to `withProxyHost(String)` and `withProxyPort(Integer)`.
`T`	`withProxy(@Nullable String proxyHost, @Nullable Integer proxyPort, @Nullable String proxyUsername, @Nullable String proxyPassword)` Sets proxy server settings, by delegating to: `withProxyHost(String)` `withProxyPort(Integer)` `withProxyUsername(String)` `withProxyPassword(String)`
`T`	`withProxyBridgePort(@NotNull Integer proxyBridgePort)` Relevant only when using username authentication with a proxy.
`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).
`T`	`withProxyPassword(@Nullable String proxyPassword)` Sets the optional password to authenticate with the proxy.
`T`	`withProxyPort(@Nullable Integer proxyPort)` Sets the proxy port, which will override any default that might have been set (through properties file or programmatically).
`T`	`withProxyUsername(@Nullable String proxyUsername)` Sets the optional username to authenticate with the proxy.
`T`	`withSessionTimeout(@NotNull Integer sessionTimeout)` Controls the timeout to use when sending emails (affects socket connect-, read- and write timeouts).
`T`	`withThreadPoolKeepAliveTime(@NotNull Integer threadPoolKeepAliveTime)` When set to a non-zero value (milliseconds), this keepAlivetime is applied to both core and extra threads.
`T`	`withThreadPoolSize(@NotNull Integer threadPoolSize)` Sets max thread pool size to the given size (default is 10).
`T`	`withTransportModeLoggingOnly(@NotNull 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.

- Field Detail
  - DEFAULT_TRUST_ALL_HOSTS
```
static final boolean DEFAULT_TRUST_ALL_HOSTS
```
    true
    
    See Also:
    
    trustingAllHosts(boolean), Constant Field Values
  - DEFAULT_VERIFY_SERVER_IDENTITY
```
static final boolean DEFAULT_VERIFY_SERVER_IDENTITY
```
    true
    
    See Also:
    
    verifyingServerIdentity(boolean), Constant Field Values
  - DEFAULT_SESSION_TIMEOUT_MILLIS
```
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
```
static final int DEFAULT_POOL_SIZE
```
    10
    
    See Also:
    
    withThreadPoolSize(Integer), Constant Field Values
  - DEFAULT_POOL_KEEP_ALIVE_TIME
```
static final int DEFAULT_POOL_KEEP_ALIVE_TIME
```
    1
    
    See Also:
    
    withThreadPoolKeepAliveTime(Integer), Constant Field Values
  - DEFAULT_CONNECTIONPOOL_CORE_SIZE
```
static final int DEFAULT_CONNECTIONPOOL_CORE_SIZE
```
    0
    
    See Also:
    
    withConnectionPoolCoreSize(Integer), Constant Field Values
  - DEFAULT_CONNECTIONPOOL_MAX_SIZE
```
static final int DEFAULT_CONNECTIONPOOL_MAX_SIZE
```
    4
    
    See Also:
    
    withConnectionPoolMaxSize(Integer), Constant Field Values
  - DEFAULT_CONNECTIONPOOL_CLAIMTIMEOUT_MILLIS
```
static final int DEFAULT_CONNECTIONPOOL_CLAIMTIMEOUT_MILLIS
```
    2147483647 (Integer.MAX_VALUE), effectively indefinately.
    
    See Also:
    
    withConnectionPoolClaimTimeoutMillis(Integer), Constant Field Values
  - DEFAULT_CONNECTIONPOOL_EXPIREAFTER_MILLIS
```
static final int DEFAULT_CONNECTIONPOOL_EXPIREAFTER_MILLIS
```
    5000
    
    See Also:
    
    withConnectionPoolExpireAfterMillis(Integer), Constant Field Values
  - DEFAULT_CONNECTIONPOOL_LOADBALANCING_STRATEGY
```
static final String DEFAULT_CONNECTIONPOOL_LOADBALANCING_STRATEGY
```
    "ROUND_ROBIN"
    
    See Also:
    
    withConnectionPoolLoadBalancingStrategy(LoadBalancingStrategy), Constant Field Values
  - DEFAULT_PROXY_PORT
```
static final int DEFAULT_PROXY_PORT
```
    Default port is 1080.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_PROXY_BRIDGE_PORT
```
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
```
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
  - DEFAULT_JAVAXMAIL_DEBUG
```
static final boolean DEFAULT_JAVAXMAIL_DEBUG
```
    Defaults to false, sending mails rather than just only logging the mails.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - async
```
T async()
```
    Changes the default for sending emails and testing server connections to asynchronous (batch mode).
    In case of asynchronous mode, make sure you configure logging to file or inspect the returned CompletableFuture.
    Note that you can configure a couple of concurrency properties such as thread pool size, keepAlivetime, connection pool size (or even a cluster) etc.
    Note: without configuring a thread pool (see withExecutorService(ExecutorService) or
    
    See Also:
    
    withExecutorService(ExecutorService), withThreadPoolSize(Integer), withThreadPoolKeepAliveTime(Integer), withConnectionPoolCoreSize(Integer), withConnectionPoolMaxSize(Integer), withConnectionPoolExpireAfterMillis(Integer)
  - withProxy
```
T withProxy(@Nullable
            @Nullable String proxyHost,
            @Nullable
            @Nullable Integer proxyPort)
```
    Delegates to withProxyHost(String) and withProxyPort(Integer).
  - withProxy
```
T withProxy(@Nullable
            @Nullable String proxyHost,
            @Nullable
            @Nullable Integer proxyPort,
            @Nullable
            @Nullable String proxyUsername,
            @Nullable
            @Nullable String proxyPassword)
```
    Sets proxy server settings, by delegating to:
    Parameters:
    
    proxyHost - See linked documentation above.
    
    proxyPort - See linked documentation above.
    
    proxyUsername - See linked documentation above.
    
    proxyPassword - See linked documentation above.
  - withProxyHost
```
T withProxyHost(@Nullable
                @Nullable String proxyHost)
```
    Sets the optional proxy host, which will override any default that might have been set (through properties file or programmatically).
  - withProxyPort
```
T withProxyPort(@Nullable
                @Nullable Integer proxyPort)
```
    Sets the proxy port, which will override any default that might have been set (through properties file or programmatically).
    Defaults to 1080 if no custom default property was configured.
  - withProxyUsername
```
T withProxyUsername(@Nullable
                    @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 execution path then will be:
    Simple Java Mail client -> JavaMail -> anonymous authentication with local proxy bridge -> full authentication with remote SOCKS proxy -> SMTP server.
  - withProxyPassword
```
T withProxyPassword(@Nullable
                    @Nullable String proxyPassword)
```
    Sets the optional password to authenticate with the proxy.
    Note: this is only works in combination with the "Authenticated socks module".
    
    See Also:
    
    withProxyUsername(String)
  - withProxyBridgePort
```
T withProxyBridgePort(@NotNull
                      @NotNull 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.
    Note: this is only works in combination with the "Authenticated socks module".
    
    Parameters:
    
    proxyBridgePort - The port to use for the proxy bridging server.
    
    See Also:
    
    withProxyUsername(String)
  - withDebugLogging
```
T withDebugLogging(@NotNull
                   @NotNull 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.
    
    Parameters:
    
    debugLogging - Enables or disables debug logging with true or false.
  - withSessionTimeout
```
T withSessionTimeout(@NotNull
                     @NotNull Integer sessionTimeout)
```
    Controls the timeout to use when sending emails (affects socket connect-, read- and write timeouts).
    Will configure a set of properties on the Session instance with the given value, of which the names depend on the transport strategy:
    Parameters:
    
    sessionTimeout - Duration to use for session timeout.
  - withEmailValidator
```
T withEmailValidator(@NotNull
                     @NotNull com.sanctionco.jmail.EmailValidator emailValidator)
```
    Sets the email address validator used when validating and sending emails using the current Mailer instance.
    Defaults to JMail.strictValidator().
    
    See Also:
    
    EmailValidator, clearEmailValidator(), resetEmailValidator()
  - signByDefaultWithSmime
```
T signByDefaultWithSmime(@NotNull
                         @NotNull Pkcs12Config pkcs12Config)
```
    Signs this all emails by default with an S/MIME signature, so the receiving client can verify whether the email content was tampered with.
    Note: this only works in combination with the "S/MIME module".
    
    See Also:
    
    S/MIME on Wikipedia, Primer on S/MIME, EmailPopulatingBuilder.signWithSmime(Pkcs12Config), clearSignByDefaultWithSmime()
  - signByDefaultWithSmime
```
T signByDefaultWithSmime(@NotNull
                         @NotNull File pkcs12StoreFile,
                         @NotNull
                         @NotNull String storePassword,
                         @NotNull
                         @NotNull String keyAlias,
                         @NotNull
                         @NotNull String keyPassword)
```
    Delegates to signByDefaultWithSmime(InputStream, String, String, String).
    Note: this only works in combination with the "S/MIME module".
    
    Parameters:
    
    pkcs12StoreFile - The key store file to use to find the indicated key
    
    storePassword - The store's password
    
    keyAlias - The name of the certificate in the key store to use
    
    keyPassword - The password of the certificate
  - signByDefaultWithSmime
```
T signByDefaultWithSmime(@NotNull
                         @NotNull InputStream pkcs12StoreStream,
                         @NotNull
                         @NotNull String storePassword,
                         @NotNull
                         @NotNull String keyAlias,
                         @NotNull
                         @NotNull String keyPassword)
```
    Delegates to signByDefaultWithSmime(byte[], String, String, String).
    Note: this only works in combination with the "S/MIME module".
  - signByDefaultWithSmime
```
T signByDefaultWithSmime(@NotNull
                         @NotNull byte[] pkcs12StoreData,
                         @NotNull
                         @NotNull String storePassword,
                         @NotNull
                         @NotNull String keyAlias,
                         @NotNull
                         @NotNull String keyPassword)
```
    Delegates to signByDefaultWithSmime(Pkcs12Config).
    Note: this only works in combination with the "S/MIME module".
    
    Parameters:
    
    pkcs12StoreData - The key store file to use to find the indicated key
    
    storePassword - The store's password
    
    keyAlias - The name of the certificate in the key store to use
    
    keyPassword - The password of the certificate
  - withExecutorService
```
T withExecutorService(@NotNull
                      @NotNull ExecutorService executorService)
```
    For advanced use cases.
    Allows you to fully customize and manage the thread pool, threads and concurrency characteristics when sending in batch mode.
    Without calling this, by default the NonJvmBlockingThreadPoolExecutor is used:
    - with max threads fixed to the given pool size (default is 10)
    - with keepAliveTime as specified (if greater than zero, core threads will also time out and die off), default is 1
    - A LinkedBlockingQueue
    - The NamedThreadFactory, which creates named non-daemon threads
    Note: What makes it NonJvm is that the default keepAliveTime is set to the lowest non-zero value (so 1), so that any threads will die off as soon as possible, as not to block the JVM from shutting down.
    Note: Simple Java Mail will not shut down the provided executor service, even if the connection pool is being shut down. This will block the JVM from shutting down. The user is responsible for managing the provided executor's life cycle.
    Note: this only works in combination with the "Advanced batch processing module".
    Parameters:
    
    executorService - A custom executor service (ThreadPoolExecutor), replacing the NonJvmBlockingThreadPoolExecutor.
  - withThreadPoolSize
```
T withThreadPoolSize(@NotNull
                     @NotNull Integer threadPoolSize)
```
    Sets max thread pool size to the given size (default is 10).
    Note: this is only used in combination with the "Advanced batch processing module".
    
    Parameters:
    
    threadPoolSize - See main description.
    
    See Also:
    
    resetThreadPoolSize(), withThreadPoolSize(Integer)
  - withThreadPoolKeepAliveTime
```
T withThreadPoolKeepAliveTime(@NotNull
                              @NotNull Integer threadPoolKeepAliveTime)
```
    When set to a non-zero value (milliseconds), this keepAlivetime is applied to both core and extra threads. This is so that these threads can never block the JVM from exiting once they finish their task. This is different from daemon threads, which are abandonded without waiting for them to finish the tasks.
    When set to zero, this keepAliveTime is applied only to extra threads, not core threads. This is the classic executor behavior, but this blocks the JVM from exiting.
    Defaults to 1ms.
    Note: this is only used in combination with the "Advanced batch processing module".
    
    Parameters:
    
    threadPoolKeepAliveTime - Value in milliseconds. See main description for details.
    
    See Also:
    
    resetThreadPoolKeepAliveTime()
  - withClusterKey
```
T withClusterKey(@NotNull
                 @NotNull UUID clusterKey)
```
    By defining a clusterKey, you can form clusters where other Mailer instances represent individual connection pools within the same cluster. Having multiple mailers using the same clusterKey means those mailes form a cluster where mail-send action are rotated over connection pools stemming from these mailer instances (this has implications for mailers defining connections differently from eachother, see documentation).
    By default, a cluster key is uniquely generated, so for a single new mailer a new cluster is always generated, thus effectively nothing is clustered.
    
    Parameters:
    
    clusterKey - See main description.
    
    See Also:
    
    Clustering with Simple Java Mail
  - withConnectionPoolCoreSize
```
T withConnectionPoolCoreSize(@NotNull
                             @NotNull Integer connectionPoolCoreSize)
```
    Configures the connection pool's core size (default 0), which means the SMTP connection pool will keep X connections open at all times until shut down. Note that this also means that if you configure an auto-expiry timeout, these connections die off and new ones are created immediately to maintain core size.
    Note: this is only used in combination with the "Advanced batch processing module".
    
    Parameters:
    
    connectionPoolCoreSize - See main description.
  - withConnectionPoolMaxSize
```
T withConnectionPoolMaxSize(@NotNull
                            @NotNull Integer connectionPoolMaxSize)
```
    Configures the connection pool's max size (default 4) in case of high thread contention. Note that this determines how many connections can be open at any one time to a single server. Make sure your server can handle the load coming from all connections. There's no point having a hundred concurrent connections if it degrades your server's performance because of CPU throttling and network congestion.
    In addition, if your server makes connections wait, it means threads will be waiting on the Transport instance to start their work load, instead of threads being blocked on a claim for an available Transport instance. In other words: by having an oversized connection pool, you inadvertently bypass the blocking claim mechanism of the connection pool and wait on the Transport directly instead.
    Note: this is only used in combination with the "Advanced batch processing module".
    
    Parameters:
    
    connectionPoolMaxSize - See main description.
  - withConnectionPoolClaimTimeoutMillis
```
T withConnectionPoolClaimTimeoutMillis(@NotNull
                                       @NotNull Integer connectionPoolClaimTimeoutMillis)
```
    If >0, configures the connection pool to wait for a limited time after which the attempt to claim a Transport connection errors out. The default is to wait indefinately until a connection becomes available in the pool.
    Note: this is only used in combination with the "Advanced batch processing module".
    
    Parameters:
    
    connectionPoolClaimTimeoutMillis - See main description.
  - withConnectionPoolExpireAfterMillis
```
T withConnectionPoolExpireAfterMillis(@NotNull
                                      @NotNull Integer connectionPoolExpireAfterMillis)
```
    If >0, configures the connection pool to automatically close connections after some milliseconds (default 5000) since last usage.
    Note that if you combine this with withConnectionPoolCoreSize(Integer) also >0 (default is 0), connections will keep closing and opening to keep core pool populated until shut down.
    Note: this is only used in combination with the "Advanced batch processing module".
    
    Parameters:
    
    connectionPoolExpireAfterMillis - See main description.
  - withConnectionPoolLoadBalancingStrategy
```
T withConnectionPoolLoadBalancingStrategy(@NotNull
                                          @NotNull LoadBalancingStrategy loadBalancingStrategy)
```
    Defines the various types of load balancing modes supported by the connection pool ion the batch-module.
    This is only relevant if you have multiple mail servers in one or more clusters. Currently, it is impossible to define different load balancing strategies for different clusters.
    Note: this is only used in combination with the "Advanced batch processing module".
    
    Parameters:
    
    loadBalancingStrategy - See main description.
  - withTransportModeLoggingOnly
```
T withTransportModeLoggingOnly(@NotNull
                               @NotNull 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.
    
    Parameters:
    
    transportModeLoggingOnly - Flag true or false that enables or disables logging only mode when sending emails.
    
    See Also:
    
    resetTransportModeLoggingOnly()
  - trustingSSLHosts
```
T trustingSSLHosts(String... sslHostsToTrust)
```
    Configures the new session to only accept server certificates issued to one of the provided hostnames. Note that verifying server identity can be turned on and off with verifyingServerIdentity(boolean).
    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.
    
    Parameters:
    
    sslHostsToTrust - See main description.
    
    See Also:
    
    mail.smtp.ssl.trust, trustingAllHosts(boolean), Notes for use of SSL with JavaMail
  - trustingAllHosts
```
T trustingAllHosts(boolean trustAllHosts)
```
    Configures the current session to trust all hosts. Defaults to true, but this allows you to white list only certain hosts.
    Note that this is not the same as server identity verification, which is enabled through verifyingServerIdentity(boolean). It would be prudent to have at least one of these features turned on, lest you be vulnerable to man-in-the-middle attacks.
    
    Parameters:
    
    trustAllHosts - See main description.
    
    See Also:
    
    mail.smtp.ssl.trust, trustingSSLHosts(String...), Notes for use of SSL with JavaMail
  - verifyingServerIdentity
```
T verifyingServerIdentity(boolean verifyingServerIdentity)
```
    Configures the current session to not verify the server's identity on an SSL connection. Defaults to true.
    Note that this is not the same as trustingAllHosts(boolean) or trustingSSLHosts(String...).
    It would be prudent to have at least one of these features turned on, lest you be vulnerable to man-in-the-middle attacks.
    
    Parameters:
    
    verifyingServerIdentity - See main description.
    
    See Also:
    
    mail.smtp.ssl.checkserveridentity, trustingAllHosts(boolean), trustingSSLHosts(String...), Notes for use of SSL with JavaMail
  - withProperties
```
T withProperties(@NotNull
                 @NotNull Properties properties)
```
    Adds the given properties to the total list applied to the Session when building a mailer.
    
    See Also:
    
    withProperties(Map), withProperty(String, Object), clearProperties()
  - withProperties
```
T withProperties(@NotNull
                 @NotNull Map<String,String> properties)
```
    See Also:
    
    withProperties(Properties), clearProperties()
  - withProperty
```
T withProperty(@NotNull
               @NotNull String propertyName,
               @Nullable
               @Nullable Object propertyValue)
```
    Sets property or removes it if the provided value is null. If provided, the value is always converted toString().
    
    Parameters:
    
    propertyName - The name of the property that wil be set on the internal Session object.
    
    propertyValue - The text value of the property that wil be set on the internal Session object.
    
    See Also:
    
    withProperties(Properties), clearProperties()
  - withCustomMailer
```
T withCustomMailer(@NotNull
                   @NotNull CustomMailer customMailer)
```
    See Also:
    
    CustomMailer
  - resetSessionTimeout
```
T resetSessionTimeout()
```
    Resets session time to its default (60000).
    
    See Also:
    
    withSessionTimeout(Integer)
  - resetEmailValidator
```
T resetEmailValidator()
```
    Resets the email validator to JMail.strictValidator().
    
    See Also:
    
    withEmailValidator(EmailValidator), clearEmailValidator()
  - resetExecutorService
```
T resetExecutorService()
```
    Resets the executor services to be used back to the default, created by the Batch module if loaded, or else Executors.newSingleThreadExecutor().
    Note: this is only used in combination with the "Advanced batch processing module".
    
    See Also:
    
    withExecutorService(ExecutorService), Batch module's NonJvmBlockingThreadPoolExecutor
  - resetThreadPoolSize
```
T resetThreadPoolSize()
```
    Resets max thread pool size to its default of 10.
    Note: this is only used in combination with the "Advanced batch processing module".
    
    See Also:
    
    withThreadPoolSize(Integer)
  - resetThreadPoolKeepAliveTime
```
T resetThreadPoolKeepAliveTime()
```
    Resets thread pool keepAliveTime to its default (1).
    Note: this is only used in combination with the "Advanced batch processing module".
    
    See Also:
    
    withThreadPoolKeepAliveTime(Integer)
  - resetTrustingAllHosts
```
T resetTrustingAllHosts()
```
    Reset trusting any host; trust all hosts is set to true.
    
    See Also:
    
    trustingAllHosts(boolean), trustingSSLHosts(String...), verifyingServerIdentity(boolean)
  - resetVerifyingServerIdentity
```
T resetVerifyingServerIdentity()
```
    Reset verifying the server's identity to true.
    
    See Also:
    
    verifyingServerIdentity(boolean), trustingSSLHosts(String...), trustingAllHosts(boolean)
  - resetClusterKey
```
T resetClusterKey()
```
    Reset the cluster key to empty, so it will be generated uniquely, avoiding clustering with any other Mailer.
    
    See Also:
    
    withClusterKey(UUID)
  - resetConnectionPoolCoreSize
```
T resetConnectionPoolCoreSize()
```
    Resets connection pool core size to its default (0).
    Note: this is only used in combination with the "Advanced batch processing module".
    
    See Also:
    
    withConnectionPoolCoreSize(Integer)
  - resetConnectionPoolMaxSize
```
T resetConnectionPoolMaxSize()
```
    Resets connection pool max size to its default (4).
    Note: this is only used in combination with the "Advanced batch processing module".
    
    See Also:
    
    withConnectionPoolMaxSize(Integer)
  - resetConnectionPoolClaimTimeoutMillis
```
T resetConnectionPoolClaimTimeoutMillis()
```
    Resets connection pool connection claim timeout back to indefinately.
    Note: this is only used in combination with the "Advanced batch processing module".
    
    See Also:
    
    withConnectionPoolClaimTimeoutMillis(Integer)
  - resetConnectionPoolExpireAfterMillis
```
T resetConnectionPoolExpireAfterMillis()
```
    Resets connection pool expire-after-milliseconds property to its default (5000).
    Note: this is only used in combination with the "Advanced batch processing module".
    
    See Also:
    
    withConnectionPoolExpireAfterMillis(Integer)
  - resetConnectionPoolLoadBalancingStrategy
```
T resetConnectionPoolLoadBalancingStrategy()
```
    Resets connection pool load balancing strategy to its default ("ROUND_ROBIN").
    Note: this is only used in combination with the "Advanced batch processing module".
    
    See Also:
    
    withConnectionPoolLoadBalancingStrategy(LoadBalancingStrategy)
  - resetTransportModeLoggingOnly
```
T resetTransportModeLoggingOnly()
```
    Resets transportModeLoggingOnly to false.
    
    See Also:
    
    withTransportModeLoggingOnly(Boolean)
  - clearProxy
```
T clearProxy()
```
    Empties all proxy configuration.
  - clearEmailValidator
```
T clearEmailValidator()
```
    Makes the email validator null, meaning validation won't take place.
    
    See Also:
    
    withEmailValidator(EmailValidator), resetEmailValidator()
  - clearSignByDefaultWithSmime
```
T clearSignByDefaultWithSmime()
```
    Removes S/MIME signing, so emails won't be signed by default.
    
    See Also:
    
    signByDefaultWithSmime(Pkcs12Config)
  - clearTrustedSSLHosts
```
T clearTrustedSSLHosts()
```
    Removes all trusted hosts from the list.
    
    See Also:
    
    trustingSSLHosts(String...), trustingAllHosts(boolean), verifyingServerIdentity(boolean)
  - clearProperties
```
T clearProperties()
```
    Removes all properties.
    
    See Also:
    
    withProperties(Properties)
  - buildMailer
```
Mailer buildMailer()
```
  - isAsync
```
boolean isAsync()
```
    See Also:
    
    async()
  - getProxyHost
```
@Nullable
@Nullable String getProxyHost()
```
    See Also:
    
    withProxyHost(String)
  - getProxyPort
```
@Nullable
@Nullable Integer getProxyPort()
```
    See Also:
    
    withProxyPort(Integer)
  - getProxyUsername
```
@Nullable
@Nullable String getProxyUsername()
```
    See Also:
    
    withProxyUsername(String)
  - getProxyPassword
```
@Nullable
@Nullable String getProxyPassword()
```
    See Also:
    
    withProxyPassword(String)
  - getProxyBridgePort
```
@Nullable
@Nullable Integer getProxyBridgePort()
```
    See Also:
    
    withProxyBridgePort(Integer)
  - isDebugLogging
```
boolean isDebugLogging()
```
    See Also:
    
    withDebugLogging(Boolean)
  - getSessionTimeout
```
@Nullable
@Nullable Integer getSessionTimeout()
```
    See Also:
    
    withSessionTimeout(Integer)
  - getEmailValidator
```
@Nullable
@Nullable com.sanctionco.jmail.EmailValidator getEmailValidator()
```
    See Also:
    
    withEmailValidator(EmailValidator)
  - getPkcs12ConfigForSmimeSigning
```
@Nullable
@Nullable Pkcs12Config getPkcs12ConfigForSmimeSigning()
```
    See Also:
    
    signByDefaultWithSmime(Pkcs12Config), signByDefaultWithSmime(InputStream, String, String, String)
  - getExecutorService
```
@Nullable
@Nullable ExecutorService getExecutorService()
```
    Returns the user set ExecutorService or else null as the default ExecutorService is not created until the OperationalConfig is created for the new Mailer instance.
    
    See Also:
    
    withExecutorService(ExecutorService)
  - getThreadPoolSize
```
@NotNull
@NotNull Integer getThreadPoolSize()
```
    See Also:
    
    withThreadPoolSize(Integer)
  - getThreadPoolKeepAliveTime
```
@NotNull
@NotNull Integer getThreadPoolKeepAliveTime()
```
    See Also:
    
    withThreadPoolKeepAliveTime(Integer)
  - getClusterKey
```
@Nullable
@Nullable UUID getClusterKey()
```
    See Also:
    
    withClusterKey(UUID)
  - getConnectionPoolCoreSize
```
@NotNull
@NotNull Integer getConnectionPoolCoreSize()
```
    See Also:
    
    withConnectionPoolCoreSize(Integer)
  - getConnectionPoolMaxSize
```
@NotNull
@NotNull Integer getConnectionPoolMaxSize()
```
    See Also:
    
    withConnectionPoolMaxSize(Integer)
  - getConnectionPoolClaimTimeoutMillis
```
@NotNull
@NotNull Integer getConnectionPoolClaimTimeoutMillis()
```
    See Also:
    
    withConnectionPoolClaimTimeoutMillis(Integer)
  - getConnectionPoolExpireAfterMillis
```
@NotNull
@NotNull Integer getConnectionPoolExpireAfterMillis()
```
    See Also:
    
    withConnectionPoolExpireAfterMillis(Integer)
  - getConnectionPoolLoadBalancingStrategy
```
@NotNull
@NotNull LoadBalancingStrategy getConnectionPoolLoadBalancingStrategy()
```
    See Also:
    
    withConnectionPoolLoadBalancingStrategy(LoadBalancingStrategy)
  - getSslHostsToTrust
```
@Nullable
@Nullable List<String> getSslHostsToTrust()
```
    See Also:
    
    trustingSSLHosts(String...)
  - isTrustAllSSLHost
```
boolean isTrustAllSSLHost()
```
    See Also:
    
    trustingAllHosts(boolean)
  - isVerifyingServerIdentity
```
boolean isVerifyingServerIdentity()
```
    See Also:
    
    verifyingServerIdentity(boolean)
  - isTransportModeLoggingOnly
```
boolean isTransportModeLoggingOnly()
```
    See Also:
    
    withTransportModeLoggingOnly(Boolean)
  - getProperties
```
@Nullable
@Nullable Properties getProperties()
```
    See Also:
    
    withProperties(Properties)
  - getCustomMailer
```
@Nullable
@Nullable CustomMailer getCustomMailer()
```
    See Also:
    
    withCustomMailer(CustomMailer)

Interface MailerGenericBuilder<T extends MailerGenericBuilder<?>>

Field Summary

Method Summary

Field Detail

DEFAULT_TRUST_ALL_HOSTS

DEFAULT_VERIFY_SERVER_IDENTITY

DEFAULT_SESSION_TIMEOUT_MILLIS

DEFAULT_POOL_SIZE

DEFAULT_POOL_KEEP_ALIVE_TIME

DEFAULT_CONNECTIONPOOL_CORE_SIZE

DEFAULT_CONNECTIONPOOL_MAX_SIZE

DEFAULT_CONNECTIONPOOL_CLAIMTIMEOUT_MILLIS

DEFAULT_CONNECTIONPOOL_EXPIREAFTER_MILLIS

DEFAULT_CONNECTIONPOOL_LOADBALANCING_STRATEGY

DEFAULT_PROXY_PORT

DEFAULT_PROXY_BRIDGE_PORT

DEFAULT_TRANSPORT_MODE_LOGGING_ONLY

DEFAULT_JAVAXMAIL_DEBUG

Method Detail

async

withProxy

withProxy

withProxyHost

withProxyPort

withProxyUsername

withProxyPassword

withProxyBridgePort

withDebugLogging

withSessionTimeout

withEmailValidator

signByDefaultWithSmime

signByDefaultWithSmime

signByDefaultWithSmime

signByDefaultWithSmime

withExecutorService

withThreadPoolSize

withThreadPoolKeepAliveTime

withClusterKey

withConnectionPoolCoreSize

withConnectionPoolMaxSize

withConnectionPoolClaimTimeoutMillis

withConnectionPoolExpireAfterMillis

withConnectionPoolLoadBalancingStrategy

withTransportModeLoggingOnly

trustingSSLHosts

trustingAllHosts

verifyingServerIdentity

withProperties

withProperties

withProperty

withCustomMailer

resetSessionTimeout

resetEmailValidator

resetExecutorService

resetThreadPoolSize

resetThreadPoolKeepAliveTime

resetTrustingAllHosts

resetVerifyingServerIdentity

resetClusterKey

resetConnectionPoolCoreSize

resetConnectionPoolMaxSize

resetConnectionPoolClaimTimeoutMillis

resetConnectionPoolExpireAfterMillis

resetConnectionPoolLoadBalancingStrategy

resetTransportModeLoggingOnly

clearProxy

clearEmailValidator

clearSignByDefaultWithSmime

clearTrustedSSLHosts

clearProperties

buildMailer

isAsync

getProxyHost

getProxyPort

getProxyUsername

getProxyPassword

getProxyBridgePort

isDebugLogging

getSessionTimeout

getEmailValidator