SMTPServer (subethasmtp 7.1.1 API)

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

All Implemented Interfaces:

SSLSocketCreator
```
public final class SMTPServer
extends Object
implements SSLSocketCreator
```
Main SMTPServer class. Construct this object, set the hostName, port, and bind address if you wish to override the defaults, and call start(). This class starts a ServerSocket and creates a new instance of the ConnectionHandler class when a new connection comes in. The ConnectionHandler then parses the incoming SMTP stream and hands off the processing to the CommandHandler which will execute the appropriate SMTP command class. To use this class, construct a server with your implementation of the MessageHandlerFactory. This provides low-level callbacks at various phases of the SMTP exchange. For a higher-level but more limited interface, you can pass in a org.subethamail.smtp.helper.SimpleMessageListenerAdapter. By default, no authentication methods are offered. To use authentication, set an AuthenticationHandlerFactory.

Author:

Jon Stevens, Ian McFarland <ian@neo.com>, Jeff Schnitzer

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SMTPServer.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`SMTPServer.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SSLSocket`	`createSSLSocket(Socket socket)` Create an SSL socket that wraps the existing socket.
`Optional<AuthenticationHandlerFactory>`	`getAuthenticationHandlerFactory()` Returns the factor for authentication handling.
`int`	`getBacklog()` The backlog is the Socket backlog.
`Optional<InetAddress>`	`getBindAddress()` empty means all interfaces
`CommandHandler`	`getCommandHandler()` The CommandHandler manages handling the SMTP commands such as QUIT, MAIL, RCPT, DATA, etc.
`int`	`getConnectionTimeout()`
`boolean`	`getDisableReceivedHeaders()`
`String`	`getDisplayableLocalSocketAddress()`
`boolean`	`getEnableTLS()`
`ExecutorService`	`getExecutorService()`
`boolean`	`getHideTLS()`
`String`	`getHostName()`
`int`	`getMaxConnections()`
`int`	`getMaxMessageSize()`
`int`	`getMaxRecipients()`
`MessageHandlerFactory`	`getMessageHandlerFactory()`
`int`	`getPort()`
`int`	`getPortAllocated()`
`boolean`	`getRequireAuth()`
`boolean`	`getRequireTLS()`
`String`	`getServerThreadName()`
`SessionHandler`	`getSessionHandler()`
`SessionIdFactory`	`getSessionIdFactory()`
`boolean`	`getShowAuthCapabilitiesBeforeSTARTTLS()`
`String`	`getSoftwareName()` The string reported to the public as the software running here.
`boolean`	`isRunning()` Is the server running after start() has been called?
`static SMTPServer.Builder`	`port(int port)`
`void`	`start()` Starts the server listening for connections.
`void`	`stop()` Shut things down gracefully.

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

- Method Detail
  - getHostName
```
public String getHostName()
```
    Returns:
    
    the host name that will be reported to SMTP clients
  - getBindAddress
```
public Optional<InetAddress> getBindAddress()
```
    empty means all interfaces
  - getPort
```
public int getPort()
```
  - getPortAllocated
```
public int getPortAllocated()
```
  - getSoftwareName
```
public String getSoftwareName()
```
    The string reported to the public as the software running here. Defaults to SubEthaSTP and the version number.
  - getExecutorService
```
public ExecutorService getExecutorService()
```
    Returns:
    
    the ExecutorService handling client connections
  - isRunning
```
public boolean isRunning()
```
    Is the server running after start() has been called?
  - getBacklog
```
public int getBacklog()
```
    The backlog is the Socket backlog. The backlog argument must be a positive value greater than 0. If the value passed if equal or less than 0, then the default value will be assumed.
    
    Returns:
    
    the backlog
  - start
```
public void start()
```
    Starts the server listening for connections. When this method returns the server socket will have been established and will accept connections though the thread that processes accepted connections (queued) may not have started yet (it runs asynchronously).
    An SMTPServer which has been shut down, must not be reused.
  - stop
```
public void stop()
```
    Shut things down gracefully.
  - createSSLSocket
```
public SSLSocket createSSLSocket(Socket socket)
                          throws IOException
```
    Create an SSL socket that wraps the existing socket. This method is called after the client issued the STARTTLS command.
    Subclasses may override this method to configure the key stores, enabled protocols/ cipher suites, enforce client authentication, etc.
    
    Specified by:
    
    createSSLSocket in interface SSLSocketCreator
    
    Parameters:
    
    socket - the existing socket as created by createServerSocket() (not null)
    
    Returns:
    
    an SSLSocket
    
    Throws:
    
    IOException - when creating the socket failed
  - getDisplayableLocalSocketAddress
```
public String getDisplayableLocalSocketAddress()
```
  - getMessageHandlerFactory
```
public MessageHandlerFactory getMessageHandlerFactory()
```
  - getAuthenticationHandlerFactory
```
public Optional<AuthenticationHandlerFactory> getAuthenticationHandlerFactory()
```
    Returns the factor for authentication handling.
    
    Returns:
    
    the factory for auth handlers, or empty if no factory has been set.
  - getCommandHandler
```
public CommandHandler getCommandHandler()
```
    The CommandHandler manages handling the SMTP commands such as QUIT, MAIL, RCPT, DATA, etc.
    
    Returns:
    
    An instance of CommandHandler
  - getMaxConnections
```
public int getMaxConnections()
```
  - getConnectionTimeout
```
public int getConnectionTimeout()
```
  - getMaxRecipients
```
public int getMaxRecipients()
```
  - getEnableTLS
```
public boolean getEnableTLS()
```
  - getHideTLS
```
public boolean getHideTLS()
```
  - getRequireTLS
```
public boolean getRequireTLS()
```
  - getRequireAuth
```
public boolean getRequireAuth()
```
  - getShowAuthCapabilitiesBeforeSTARTTLS
```
public boolean getShowAuthCapabilitiesBeforeSTARTTLS()
```
  - getMaxMessageSize
```
public int getMaxMessageSize()
```
  - getDisableReceivedHeaders
```
public boolean getDisableReceivedHeaders()
```
  - getSessionIdFactory
```
public SessionIdFactory getSessionIdFactory()
```
  - getSessionHandler
```
public SessionHandler getSessionHandler()
```
  - port
```
public static SMTPServer.Builder port(int port)
```
  - getServerThreadName
```
public String getServerThreadName()
```

Class SMTPServer

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getHostName

getBindAddress

getPort

getPortAllocated

getSoftwareName

getExecutorService

isRunning

getBacklog

start

stop

createSSLSocket

getDisplayableLocalSocketAddress

getMessageHandlerFactory

getAuthenticationHandlerFactory

getCommandHandler

getMaxConnections

getConnectionTimeout

getMaxRecipients

getEnableTLS

getHideTLS

getRequireTLS

getRequireAuth

getShowAuthCapabilitiesBeforeSTARTTLS

getMaxMessageSize

getDisableReceivedHeaders

getSessionIdFactory

getSessionHandler

port

getServerThreadName