SMTPServer.Builder (subethasmtp 7.1.1 API)

java.lang.Object
- org.subethamail.smtp.server.SMTPServer.Builder

Enclosing class:: SMTPServer

public static final class SMTPServer.Builder
extends Object

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SMTPServer.Builder`	`authenticationHandlerFactory(AuthenticationHandlerFactory factory)` Sets authenticationHandlerFactory.
`SMTPServer.Builder`	`backlog(int backlogSize)` Sets the Socket backlog which is the requested maximum number of pending connections on the socket.
`SMTPServer.Builder`	`bindAddress(InetAddress bindAddress)`
`SMTPServer.Builder`	`bindAddress(Optional<InetAddress> bindAddress)`
`SMTPServer`	`build()`
`SMTPServer.Builder`	`connectionTimeout(int connectionTimeout, TimeUnit unit)`
`SMTPServer.Builder`	`connectionTimeoutMs(int connectionTimeoutMs)`
`SMTPServer.Builder`	`enableTLS()` If set to true, TLS will be supported.
`SMTPServer.Builder`	`enableTLS(boolean value)`
`SMTPServer.Builder`	`executorService(ExecutorService executor)` Sets the executor service that will handle client connections.
`SMTPServer.Builder`	`fromAddressValidator(Predicate<String> fromAddressValidator)` Adds a validator that will be applied to the MAIL FROM email address.
`SMTPServer.Builder`	`hideTLS()` If set to true, TLS will not be advertised in the EHLO string.
`SMTPServer.Builder`	`hideTLS(boolean value)` If set to true, TLS will not be advertised in the EHLO string.
`SMTPServer.Builder`	`hostName(String hostName)`
`SMTPServer.Builder`	`insertReceivedHeaders()`
`SMTPServer.Builder`	`insertReceivedHeaders(boolean value)`
`SMTPServer.Builder`	`maxConnections(int maxConnections)`
`SMTPServer.Builder`	`maxMessageSize(int maxMessageSize)` Sets the maximum messages size (does not enforce though!).
`SMTPServer.Builder`	`maxRecipients(int maxRecipients)` Sets the maximum number of recipients per message delivery request.
`SMTPServer.Builder`	`messageHandler(BasicMessageListener listener)`
`SMTPServer.Builder`	`messageHandlerFactory(MessageHandlerFactory factory)`
`SMTPServer.Builder`	`port(int port)`
`SMTPServer.Builder`	`proxyHandler(ProxyHandler proxyHandler)` Sets the `ProxyHandler` which will handle proxy packets before SMTP protocol.
`SMTPServer.Builder`	`requireAuth()`
`SMTPServer.Builder`	`requireAuth(boolean value)` Sets whether authentication is required.
`SMTPServer.Builder`	`requireTLS()`
`SMTPServer.Builder`	`requireTLS(boolean value)`
`SMTPServer.Builder`	`serverSocketFactory(ServerSocketCreator serverSocketCreator)`
`SMTPServer.Builder`	`serverSocketFactory(SSLContext context)`
`SMTPServer.Builder`	`serverSocketFactory(SSLServerSocketFactory factory)`
`SMTPServer.Builder`	`serverThreadName(String name)` Sets the server thead name.
`SMTPServer.Builder`	`serverThreadNameProvider(Function<SMTPServer,String> provider)`
`SMTPServer.Builder`	`sessionHandler(SessionHandler sessionHandler)` Sets the `SessionHandler` which will track allocated session and connections.
`SMTPServer.Builder`	`sessionIdFactory(SessionIdFactory factory)` Sets the `SessionIdFactory` which will allocate a unique identifier for each mail sessions.
`SMTPServer.Builder`	`showAuthCapabilitiesBeforeSTARTTLS(boolean value)` Sets whether AUTH capabilities are shown before STARTTLS is received.
`SMTPServer.Builder`	`simpleMessageListener(SimpleMessageListener listener)`
`SMTPServer.Builder`	`softwareName(String name)`
`SMTPServer.Builder`	`startTlsSocketFactory(SSLContext context)`
`SMTPServer.Builder`	`startTlsSocketFactory(SSLContext context, boolean requireClientCertificate)`
`SMTPServer.Builder`	`startTlsSocketFactory(SSLSocketCreator creator)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - bindAddress
```
public SMTPServer.Builder bindAddress(InetAddress bindAddress)
```
  - bindAddress
```
public SMTPServer.Builder bindAddress(Optional<InetAddress> bindAddress)
```
  - hostName
```
public SMTPServer.Builder hostName(String hostName)
```
  - port
```
public SMTPServer.Builder port(int port)
```
  - backlog
```
public SMTPServer.Builder backlog(int backlogSize)
```
    Sets the Socket backlog which is the requested maximum number of pending connections on the socket.
    
    Parameters:
    
    backlogSize - The backlog argument must be a >= 0. If the value passed is 0, then the default value (50) will be assumed.
    
    Returns:
    
    this
  - softwareName
```
public SMTPServer.Builder softwareName(String name)
```
  - messageHandler
```
public SMTPServer.Builder messageHandler(BasicMessageListener listener)
```
  - messageHandlerFactory
```
public SMTPServer.Builder messageHandlerFactory(MessageHandlerFactory factory)
```
  - simpleMessageListener
```
public SMTPServer.Builder simpleMessageListener(SimpleMessageListener listener)
```
  - authenticationHandlerFactory
```
public SMTPServer.Builder authenticationHandlerFactory(AuthenticationHandlerFactory factory)
```
    Sets authenticationHandlerFactory.
    
    Parameters:
    
    factory - the AuthenticationHandlerFactory which performs authentication in the SMTP AUTH command. If empty, authentication is not supported. Note that setting an authentication handler does not enforce authentication, it only makes authentication possible. Enforcing authentication is the responsibility of the client application, which usually enforces it only selectively. Use Session.isAuthenticated() to check whether the client was authenticated in the session.
    
    Returns:
    
    this
  - executorService
```
public SMTPServer.Builder executorService(ExecutorService executor)
```
    Sets the executor service that will handle client connections.
    
    Parameters:
    
    executor - the ExecutorService that will handle client connections, one task per connection. The SMTPServer will shut down this ExecutorService when the SMTPServer itself stops. If not specified, a default one is created by Executors.newCachedThreadPool().
    
    Returns:
    
    this
  - enableTLS
```
public SMTPServer.Builder enableTLS(boolean value)
```
  - fromAddressValidator
```
public SMTPServer.Builder fromAddressValidator(Predicate<String> fromAddressValidator)
```
    Adds a validator that will be applied to the MAIL FROM email address. If returns false then email address is invalid and a 553 response will be returned to the client.
    
    Parameters:
    
    fromAddressValidator - the validator that will be applied to the address in MAIL FROM command
    
    Returns:
    
    this
  - enableTLS
```
public SMTPServer.Builder enableTLS()
```
    If set to true, TLS will be supported.
    The minimal JSSE configuration necessary for a working TLS support on Oracle JRE 6:
    - javax.net.ssl.keyStore system property must refer to a file containing a JKS keystore with the private key.
    - javax.net.ssl.keyStorePassword system property must specify the keystore password.
    Up to SubEthaSMTP 3.1.5 the default was true, i.e. TLS was enabled.
    See Also:
    
    Securing Connections with TLS
  - hideTLS
```
public SMTPServer.Builder hideTLS(boolean value)
```
    If set to true, TLS will not be advertised in the EHLO string. Default is false; true implied when disableTLS=true.
  - hideTLS
```
public SMTPServer.Builder hideTLS()
```
    If set to true, TLS will not be advertised in the EHLO string. Default is false; true implied when disableTLS=true.
  - requireTLS
```
public SMTPServer.Builder requireTLS(boolean value)
```
    Parameters:
    
    value - true to require a TLS handshake, false to allow operation with or without TLS. Default is false; ignored when disableTLS=true.
  - requireTLS
```
public SMTPServer.Builder requireTLS()
```
  - requireAuth
```
public SMTPServer.Builder requireAuth(boolean value)
```
    Sets whether authentication is required. If set to true then no mail will be accepted till authentication succeeds.
    
    Parameters:
    
    value - true for mandatory smtp authentication, i.e. no mail mail be accepted until authentication succeeds. Don't forget to set authenticationHandlerFactory to allow client authentication. Defaults to false.
  - requireAuth
```
public SMTPServer.Builder requireAuth()
```
  - showAuthCapabilitiesBeforeSTARTTLS
```
public SMTPServer.Builder showAuthCapabilitiesBeforeSTARTTLS(boolean value)
```
    Sets whether AUTH capabilities are shown before STARTTLS is received. Default value is false.
    Normally you would not want to advertise AUTH related capabilities before a STARTTLS is sent so that credentials do not go in the clear. However, the use of implicit STARTTLS (the property `mail.smtp.starttls.enable` is not set) by a jakarta.mail client (e.g. 1.6.4) prevents AUTH happening. See issue #21. To resolve this issue with jakarta.mail and implicit STARTTLS we provide explicit control over if AUTH capabilities are shown before STARTTLS.
    
    Parameters:
    
    value - boolean value, default is false
    
    Returns:
    
    this
  - insertReceivedHeaders
```
public SMTPServer.Builder insertReceivedHeaders(boolean value)
```
  - insertReceivedHeaders
```
public SMTPServer.Builder insertReceivedHeaders()
```
  - maxConnections
```
public SMTPServer.Builder maxConnections(int maxConnections)
```
  - connectionTimeoutMs
```
public SMTPServer.Builder connectionTimeoutMs(int connectionTimeoutMs)
```
  - connectionTimeout
```
public SMTPServer.Builder connectionTimeout(int connectionTimeout,
                                            TimeUnit unit)
```
  - maxRecipients
```
public SMTPServer.Builder maxRecipients(int maxRecipients)
```
    Sets the maximum number of recipients per message delivery request.
    
    Parameters:
    
    maxRecipients - The maximum number of recipients that this server accepts per message delivery request.
    
    Returns:
    
    this
  - maxMessageSize
```
public SMTPServer.Builder maxMessageSize(int maxMessageSize)
```
    Sets the maximum messages size (does not enforce though!).
    
    Parameters:
    
    maxMessageSize - The maximum size of a message that the server will accept. This value is advertised during the EHLO phase if it is larger than 0. If the message size specified by the client during the MAIL phase, the message will be rejected at that time. (RFC 1870) Default is 0. Note this doesn't actually enforce any limits on the message being read; you must do that yourself when reading data.
    
    Returns:
    
    this
  - sessionIdFactory
```
public SMTPServer.Builder sessionIdFactory(SessionIdFactory factory)
```
    Sets the SessionIdFactory which will allocate a unique identifier for each mail sessions. If not set, a reasonable default will be used.
  - sessionHandler
```
public SMTPServer.Builder sessionHandler(SessionHandler sessionHandler)
```
    Sets the SessionHandler which will track allocated session and connections.
  - proxyHandler
```
public SMTPServer.Builder proxyHandler(ProxyHandler proxyHandler)
```
    Sets the ProxyHandler which will handle proxy packets before SMTP protocol.
  - serverSocketFactory
```
public SMTPServer.Builder serverSocketFactory(ServerSocketCreator serverSocketCreator)
```
  - serverSocketFactory
```
public SMTPServer.Builder serverSocketFactory(SSLServerSocketFactory factory)
```
  - serverSocketFactory
```
public SMTPServer.Builder serverSocketFactory(SSLContext context)
```
  - startTlsSocketFactory
```
public SMTPServer.Builder startTlsSocketFactory(SSLSocketCreator creator)
```
  - startTlsSocketFactory
```
public SMTPServer.Builder startTlsSocketFactory(SSLContext context)
```
  - startTlsSocketFactory
```
public SMTPServer.Builder startTlsSocketFactory(SSLContext context,
                                                boolean requireClientCertificate)
```
  - serverThreadName
```
public SMTPServer.Builder serverThreadName(String name)
```
    Sets the server thead name. The default value is org.subethamail.smtp.server.ServerThread {bindAddress}:{port}
    
    Parameters:
    
    name - - thread name
  - serverThreadNameProvider
```
public SMTPServer.Builder serverThreadNameProvider(Function<SMTPServer,String> provider)
```
  - build
```
public SMTPServer build()
```

Class SMTPServer.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

bindAddress

bindAddress

hostName

port

backlog

softwareName

messageHandler

messageHandlerFactory

simpleMessageListener

authenticationHandlerFactory

executorService

enableTLS

fromAddressValidator

enableTLS

hideTLS

hideTLS

requireTLS

requireTLS

requireAuth

requireAuth

showAuthCapabilitiesBeforeSTARTTLS

insertReceivedHeaders

insertReceivedHeaders

maxConnections

connectionTimeoutMs

connectionTimeout

maxRecipients

maxMessageSize

sessionIdFactory

sessionHandler

proxyHandler

serverSocketFactory

serverSocketFactory

serverSocketFactory

startTlsSocketFactory

startTlsSocketFactory

startTlsSocketFactory

serverThreadName

serverThreadNameProvider

build