Package ch.astorm.smtp4j

Class SmtpServerBuilder

java.lang.Object

ch.astorm.smtp4j.SmtpServerBuilder

public class SmtpServerBuilder
extends Object

Helper to build a new SmtpServer.

Constructor Summary

Constructors

Constructor	Description
SmtpServerBuilder()

Method Summary

Modifier and Type	Method	Description
SmtpServer	build()	Builds the SmtpServer.
SmtpServer	start()	Builds the SmtpServer and starts it.
SmtpServerBuilder	withAuthenticator(SmtpAuthenticatorHandler handler)	Adds the given handler to authenticate a client.
SmtpServerBuilder	withConnectionListener(ConnectionListener connectionListener)	Sets the specified connectionListener.
SmtpServerBuilder	withConnectionString(String str)	Defines a custom connection string when a new client connects.
SmtpServerBuilder	withDebugStream(PrintStream stream)	Defines the PrintStream to use for debugging.
SmtpServerBuilder	withEHLOResponseFunction(Function<String,String> func)	Defines a custom function to generate the SmtpCommand.Type.EHLO response.
SmtpServerBuilder	withExecutorService(Supplier<ExecutorService> executorSupplier)	Defines the ExecutorService supplier to use to handle the SMTP messages.
SmtpServerBuilder	withListener(SmtpServerListener listener)	Adds the specified listener once de server is built.
SmtpServerBuilder	withMaxMessageSize(int limit)	Defines the maximum message size (in bytes).
SmtpServerBuilder	withMessageHandler(SmtpMessageHandler messageHandler)	Defines the SmtpMessageHandler to be applied for the received messages.
SmtpServerBuilder	withOptions(SmtpServerOptions options)	Defines the SMTP server options..
SmtpServerBuilder	withPort(int port)	Defines the port on which the SmtpServer will listen to.
SmtpServerBuilder	withProtocol(SmtpServerOptions.Protocol protocol)	Defines the protocol to used.
SmtpServerBuilder	withSmtpTransactionHandlerFactory(SmtpTransactionHandlerFactory factory)	Defines the SmtpTransactionHandlerFactory to use to handle SMTP transactions.
SmtpServerBuilder	withSocketTimeout(int timeout)	Defines the specified timeout (in milliseconds) for the read() operations on socket input.
SmtpServerBuilder	withSSLContextProvider(SSLContextProvider provider)	Defines the SSLContextProvider to use when negotiating SSL.
SmtpServerBuilder	withStartTLSRequired(boolean tlsRequired)	Defines if secure transport layer is required (false by default).
SmtpServerBuilder	withStartTLSSupport(boolean startTlsSupport)	Defines if the STARTTLS support is enabled (false by default).
SmtpServerBuilder	withUser(String user, String password)	Adds the given user to the repository.

Methods inherited from class java.lang.Object

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

Constructor Details

SmtpServerBuilder

public SmtpServerBuilder()

Method Details

withPort

public SmtpServerBuilder withPort(int port)

Defines the port on which the SmtpServer will listen to. If the port is less or equal to zero, the server will make a dynamic lookup when it is started. By default, the port is undefined.

Parameters:

port - The port.

Returns:

This builder.

See Also:

• SmtpServer(int)

withOptions

public SmtpServerBuilder withOptions(SmtpServerOptions options)

Defines the SMTP server options..

Parameters:

options - The options.

Returns:

This builder.

See Also:

• SmtpServer.setOptions(ch.astorm.smtp4j.SmtpServerOptions)

withStartTLSSupport

public SmtpServerBuilder withStartTLSSupport(boolean startTlsSupport)

Defines if the STARTTLS support is enabled (false by default). If true, then a SSL context provider must be set.

Parameters:

startTlsSupport - True if the STARTTLS support must be enabled.

Returns:

This builder.

See Also:

• SmtpServerOptions.startTLS

withStartTLSRequired

public SmtpServerBuilder withStartTLSRequired(boolean tlsRequired)

Defines if secure transport layer is required (false by default). This value is used only when TLS support is enabled.

Parameters:

tlsRequired - True if STARTTLS is required once connected.

Returns:

This builder.

See Also:

• SmtpServerOptions.requireTLS

withProtocol

public SmtpServerBuilder withProtocol(SmtpServerOptions.Protocol protocol)

Defines the protocol to used. If the SmtpServerOptions.Protocol.SMTPS is used, then a SSL context provider must be set.

Parameters:

protocol - The protocol (by default SmtpServerOptions.Protocol.SMTP.)

Returns:

This builder.

See Also:

• SmtpServerOptions.protocol

withSSLContextProvider

public SmtpServerBuilder withSSLContextProvider(SSLContextProvider provider)

Defines the SSLContextProvider to use when negotiating SSL. By default, the SSL context provider is undefined.

Parameters:

provider - The provider.

Returns:

This builder.

See Also:

• DefaultSSLContextProvider.selfSigned()

withMaxMessageSize

public SmtpServerBuilder withMaxMessageSize(int limit)

Defines the maximum message size (in bytes). A value less or equal than zero disables the size limit. By default, there is no message limit.

Parameters:

limit - The size limit in bytes.

Returns:

This builder.

See Also:

• SmtpServerOptions.maxMessageSize

withDebugStream

public SmtpServerBuilder withDebugStream(PrintStream stream)

Defines the PrintStream to use for debugging. If null, then no debug output will be printed.

Parameters:

stream - The debug stream.

Returns:

This builder.

See Also:

• SmtpServerOptions.debugStream

withConnectionString

public SmtpServerBuilder withConnectionString(String str)

Defines a custom connection string when a new client connects.

Parameters:

str - A simple connection answer or null.

Returns:

This builder.

See Also:

• SmtpServerOptions.connectionString

withEHLOResponseFunction

public SmtpServerBuilder withEHLOResponseFunction(Function<String,String> func)

Defines a custom function to generate the SmtpCommand.Type.EHLO response. The function input is the parameter sent by the client in the protocol and might be null.

Parameters:

func - The function to apply.

Returns:

This builder.

See Also:

• SmtpServerOptions.ehloResponseFunction

withAuthenticator

public SmtpServerBuilder withAuthenticator(SmtpAuthenticatorHandler handler)

Adds the given handler to authenticate a client. This method can be called multiple times to allow many authentication schemes. Since the authentication will be required, you'll need to declare some users otherwise all the connections will be rejected.

Parameters:

handler - The authentication handler.

Returns:

This builder.

See Also:

• PlainAuthenticationHandler.INSTANCE
• LoginAuthenticationHandler.INSTANCE
• CramMD5AuthenticationHandler.INSTANCE
• SmtpServerOptions.authenticators

withUser

public SmtpServerBuilder withUser(String user,
 String password)

Adds the given user to the repository. This method can be called multiple times to add users. Users are not linked to mailboxes. They are only used in the context of the authentication. It is useless to register users if there is no authentication scheme registered.

Parameters:

user - The username.

password - The associated password.

Returns:

This builder.

See Also:

• SimpleUserRepository
• SmtpServerOptions.usersRepository

withMessageHandler

public SmtpServerBuilder withMessageHandler(SmtpMessageHandler messageHandler)

Defines the SmtpMessageHandler to be applied for the received messages.

Parameters:

messageHandler - The message handler.

Returns:

This builder.

See Also:

• SmtpServer(int, ch.astorm.smtp4j.core.SmtpMessageHandler, java.util.function.Supplier, ch.astorm.smtp4j.protocol.SmtpTransactionHandlerFactory, ch.astorm.smtp4j.connection.ConnectionListener)

withExecutorService

public SmtpServerBuilder withExecutorService(Supplier<ExecutorService> executorSupplier)

Defines the ExecutorService supplier to use to handle the SMTP messages.

Parameters:

executorSupplier - The ExecutorService to use or null (will default to Executors.newWorkStealingPool()).

Returns:

This builder.

See Also:

• SmtpServer(int, ch.astorm.smtp4j.core.SmtpMessageHandler, java.util.function.Supplier, ch.astorm.smtp4j.protocol.SmtpTransactionHandlerFactory, ch.astorm.smtp4j.connection.ConnectionListener)

withSmtpTransactionHandlerFactory

public SmtpServerBuilder withSmtpTransactionHandlerFactory(SmtpTransactionHandlerFactory factory)

Defines the SmtpTransactionHandlerFactory to use to handle SMTP transactions.

Parameters:

factory - The SmtpTransactionHandlerFactory to use or null (will default to DefaultSmtpTransactionHandler).

Returns:

This builder.

See Also:

• SmtpServer(int, ch.astorm.smtp4j.core.SmtpMessageHandler, java.util.function.Supplier, ch.astorm.smtp4j.protocol.SmtpTransactionHandlerFactory, ch.astorm.smtp4j.connection.ConnectionListener)

withListener

public SmtpServerBuilder withListener(SmtpServerListener listener)

Adds the specified listener once de server is built.

Parameters:

listener - The listener to add.

Returns:

This builder.

See Also:

• SmtpServer.addListener(ch.astorm.smtp4j.core.SmtpServerListener)

withSocketTimeout

public SmtpServerBuilder withSocketTimeout(int timeout)

Defines the specified timeout (in milliseconds) for the read() operations on socket input. By default, this value is set to 10000.

Parameters:

timeout - The socket timeout or zero to disable timeout.

Returns:

This builder.

See Also:

• SmtpServerOptions.socketTimeout
• Socket.setSoTimeout(int)

withConnectionListener

public SmtpServerBuilder withConnectionListener(ConnectionListener connectionListener)

Sets the specified connectionListener.

Parameters:

connectionListener - The connection listener or null.

Returns:

This builder.

See Also:

• SmtpServer(int, ch.astorm.smtp4j.core.SmtpMessageHandler, java.util.function.Supplier, ch.astorm.smtp4j.protocol.SmtpTransactionHandlerFactory, ch.astorm.smtp4j.connection.ConnectionListener)

build

public SmtpServer build()

Builds the SmtpServer.

Returns:

A new SmtpServer instance (not started).

start

public SmtpServer start()
                 throws IOException

Builds the SmtpServer and starts it. This is equivalent to call build() and then SmtpServer.start().

Returns:

A new SmtpServer instance (started).

Throws:

IOException