SubEthaSmtp

https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/
Admin
SubEthaSmtp is a Java library for implementing custom SMTP servers with support for message...
Tokens:103,348
Snippets:1,509
Trust Score:9.5
Update:5 months ago
Show doc for...
Tokens:
Raw
### start

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/server/SMTPServer.html

Starts the server listening for connections. The server socket will be established and accept connections, though the thread processing accepted connections may start asynchronously.

```APIDOC
## start

### Description
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.

### Method
start

### Parameters
None

### Response
None
```

--------------------------------

### Start the SMTPServer

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/server/SMTPServer.html

Call the start() method to begin listening for incoming SMTP connections. Ensure the server is constructed with a MessageHandlerFactory.

```java
public void start()

```

--------------------------------

### main

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/wiser/Wiser.html

A main() method for the Wiser class. Starts up the server.

```APIDOC
## main

### Description
A main() method for the Wiser class. Starts up the server.

### Method Signature
```java
public static void main(String[] args)
```

### Throws
* `Exception`
```

--------------------------------

### Start Basic SMTP Server

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/examples/BasicSMTPServer.html

Starts an SMTP server on the specified port. This method is part of the BasicSMTPServer class.

```java
public SMTPServer start(int port)
```

--------------------------------

### getSocket()

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/index-all.html

This method is only used by the start tls command.

```APIDOC
## getSocket()

### Description
This method is only used by the start tls command.

### Method
Method

### Class
org.subethamail.smtp.server.Session
```

--------------------------------

### org.subethamail.smtp.examples.BasicSMTPServer Constants

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/constant-values.html

Specifies the default port for the basic SMTP server example.

```APIDOC
## Constants for org.subethamail.smtp.examples.BasicSMTPServer

### Description
Default network configuration for the example SMTP server.

### Constant Fields
- **DEFAULT_PORT** (int) - The default port number the basic SMTP server listens on.
```

--------------------------------

### Start Wiser SMTP Server

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/wiser/Wiser.html

Starts the Wiser SMTP server, making it ready to receive incoming email connections. This method should be called before sending emails to be tested.

```java
public void start()
```

--------------------------------

### StartTLSCommand Constructor

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/internal/command/StartTLSCommand.html

The default constructor for the StartTLSCommand class. No specific setup is required when instantiating this command.

```java
public
StartTLSCommand()
```

--------------------------------

### setTlsStarted(boolean tlsStarted)

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/server/Session.html

Sets the TLS started status.

```APIDOC
## setTlsStarted(boolean tlsStarted)

### Description
Sets the TLS started status.

### Method
public void setTlsStarted(boolean tlsStarted)

### Parameters
#### Path Parameters
- **tlsStarted** (boolean) - Required - true when the TLS handshake was completed, false otherwise

```

--------------------------------

### run()

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/internal/server/ServerThread.html

The main execution method for the ServerThread. It is called when the thread starts and is responsible for accepting connections and starting session threads. To safely exit this method, call the shutdown() method.

```APIDOC
## run()

### Description
This method is called by this thread when it starts up. It accepts incoming TCP connections and starts a new `Session` thread for each connection. To safely cause this to exit, call `shutdown()`.

### Method
`void run()`

### Overrides
`run` in class `Thread`

### Implements
`run` in interface `Runnable`
```

--------------------------------

### EhloCommand Constructor

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/internal/command/EhloCommand.html

Initializes a new instance of the EhloCommand class. No specific setup is required beyond instantiation.

```java
public	EhloCommand()

```

--------------------------------

### Create Default Wiser Instance

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/wiser/Wiser.html

Creates a Wiser instance with default settings. This is the simplest way to start Wiser for basic testing.

```java
public static Wiser create()
```

--------------------------------

### Get Host and Port

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/client/SMTPClient.html

Returns the host and port of the current connection.

```java
public String getHostPort()
```

--------------------------------

### VerifyCommand Constructor - SubEthaSMTP

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/internal/command/VerifyCommand.html

Default constructor for the VerifyCommand class. No specific setup is required.

```java
public	VerifyCommand()
```

--------------------------------

### StartTLSCommand Constructor

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/internal/command/StartTLSCommand.html

Initializes a new instance of the StartTLSCommand class.

```APIDOC
## StartTLSCommand()

### Description
Initializes a new instance of the `StartTLSCommand` class.

### Constructor
`public StartTLSCommand()`
```

--------------------------------

### Get Command Name Method

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/internal/server/Command.html

Abstract method to get the name of the command in uppercase. This is used for command identification.

```java
String getName()
```

--------------------------------

### Main Method for BasicSMTPServer

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/examples/BasicSMTPServer.html

The entry point for the BasicSMTPServer application. It is a static method within the BasicSMTPServer class.

```java
public static void main(String[] args)
```

--------------------------------

### Create a successful SessionAcceptance result

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/server/SessionHandler.SessionAcceptance.html

Use this static method to create a SessionAcceptance object representing a successful session start. It indicates no error code or message.

```java
public static SessionHandler.SessionAcceptance success()
```

--------------------------------

### HelpCommand Constructor

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/internal/command/HelpCommand.html

Initializes a new instance of the HelpCommand class.

```APIDOC
## HelpCommand()

### Description
Initializes a new instance of the HelpCommand class.

### Constructor
`HelpCommand()`
```

--------------------------------

### ServerThread run Method

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/internal/server/ServerThread.html

The main execution method for the ServerThread. This method is called when the thread starts and is responsible for accepting connections and starting session threads. To safely exit this thread, call the shutdown() method.

```java
public void run()
```

--------------------------------

### HelloCommand Constructor

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/internal/command/HelloCommand.html

Initializes a new instance of the HelloCommand class.

```APIDOC
## HelloCommand()

### Description
Initializes a new instance of the HelloCommand class.

### Constructor
`HelloCommand()`
```

--------------------------------

### getSpecification()

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/index-all.html

Gets the SMTP specification version.

```APIDOC
## getSpecification()

### Description
Gets the SMTP specification version.

### Method
Static method

### Class
org.subethamail.smtp.Version
```

--------------------------------

### SmartClient.createAndConnect(String, int, String)

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/index-all.html

Creates a SmartClient and connects to the specified server.

```APIDOC
## createAndConnect(String, int, String)

### Description
Creates a SmartClient and connects to the specified server.

### Method
`createAndConnect(String host, int port, String greeting)`

### Class
`org.subethamail.smtp.client.SmartClient`
```

--------------------------------

### getName() - RequireTLSCommandWrapper

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/index-all.html

Gets the name of the command.

```APIDOC
## getName()

### Description
Gets the name of the command.

### Method
Method

### Class
org.subethamail.smtp.internal.server.RequireTLSCommandWrapper
```

--------------------------------

### create() Method

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/auth/PlainAuthenticationHandlerFactory.html

Creates a fresh instance of the authentication handler.

```APIDOC
## create()

### Description
Creates a fresh instance of your handler. This method is part of the AuthenticationHandlerFactory interface.

### Returns
* AuthenticationHandler - A new authentication handler instance.
```

--------------------------------

### getName() - BaseCommand

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/index-all.html

Gets the name of the command.

```APIDOC
## getName()

### Description
Gets the name of the command.

### Method
Method

### Class
org.subethamail.smtp.internal.server.BaseCommand
```

--------------------------------

### create() Method

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/auth/LoginAuthenticationHandlerFactory.html

Creates a fresh instance of the authentication handler.

```APIDOC
## create() Method

### Description
Create a fresh instance of your handler.

### Returns
- AuthenticationHandler - a new authentication handler
```

--------------------------------

### Wiser Main Method

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/wiser/Wiser.html

The main method for the Wiser class. It is responsible for starting the server. It can throw a generic Exception.

```java
public static void main(String[] args)
                 throws Exception
```

--------------------------------

### SmartClient startTLS Method

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/client/SmartClient.html

Upgrades the current connection to use TLS via the STARTTLS command and reissues the EHLO command.

```java
void startTLS()
```

--------------------------------

### getName Method

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/internal/server/RequireTLSCommandWrapper.html

Gets the name of the command.

```APIDOC
## getName()

### Description
Returns the name of the command in upper case. For example, "QUIT".

### Method
public String getName()

### Returns
* **String** - The name of the command in upper case.
```

--------------------------------

### SmartClient dataStart Method

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/client/SmartClient.html

Initiates the data transfer phase of an email transaction.

```java
void dataStart()
```

--------------------------------

### getSessionIdFactory

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/server/SMTPServer.html

Gets the factory for creating session IDs.

```APIDOC
## getSessionIdFactory

### Description
Gets the factory for creating session IDs.

### Method
getSessionIdFactory

### Parameters
None

### Response
#### Success Response
- **SessionIdFactory** - The session ID factory
```

--------------------------------

### createAndConnect (overload 2)

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/client/SmartClient.html

Creates and connects a SmartClient with advanced options including bindpoint, HELO host, and SSL socket factory.

```APIDOC
## createAndConnect(String host, int port, Optional<SocketAddress> bindpoint, String clientHeloHost, Optional<Authenticator> authenticator, Optional<SSLSocketFactory> sslSocketFactory)

### Description
Creates and connects a SmartClient with advanced options including bindpoint, HELO host, and SSL socket factory.

### Method
static SmartClient

### Parameters
* **host** (String) - The hostname or IP address of the SMTP server.
* **port** (int) - The port number of the SMTP server.
* **bindpoint** (Optional<SocketAddress>) - An optional socket address to bind to.
* **clientHeloHost** (String) - The HELO host name for this client.
* **authenticator** (Optional<Authenticator>) - The Authenticator object for authentication.
* **sslSocketFactory** (Optional<SSLSocketFactory>) - An optional SSL socket factory for secure connections.
```

--------------------------------

### Get Supported Authentication Mechanisms

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/AuthenticationHandlerFactory.html

Abstract method to be implemented by subclasses. It should return a list of supported authentication mechanisms as defined by RFC 2554. The order of mechanisms in the list determines their order in the EHLO response.

```java
List<String>
getAuthenticationMechanisms()
```

--------------------------------

### getName() - HelpMessage

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/index-all.html

Gets the name of the help message.

```APIDOC
## getName()

### Description
Gets the name of the help message.

### Method
Method

### Class
org.subethamail.smtp.internal.server.HelpMessage
```

--------------------------------

### connect

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/client/SMTPClient.html

Establishes a connection to the specified host and port.

```APIDOC
## connect

### Description
Establishes a connection to the specified host and port.

### Method Signature
```java
public void connect(String host, int port)
```

### Parameters
* **host** (String) - The hostname or IP address of the SMTP server.
* **port** (int) - The port number to connect to on the SMTP server.

### Throws
* `IOException` - If there is a problem connecting to the port.
```

--------------------------------

### Get Help Message Method

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/internal/server/Command.html

Abstract method to retrieve the help message for a command. Implementations may throw CommandExceptions.

```java
HelpMessage getHelp()
             throws CommandException
```

--------------------------------

### getName Method

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/internal/server/RequireAuthCommandWrapper.html

Gets the name of the SMTP command.

```APIDOC
## getName Method

### Description
Returns the name of the command in upper case. For example, "QUIT".

### Method
`String getName()`

### Returns
* `String` - The name of the command in upper case.

### Example
```java
String commandName = wrapper.getName(); // e.g., "MAIL"
```
```

--------------------------------

### build()

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/server/SMTPServer.Builder.html

Builds and returns the configured SMTPServer instance.

```APIDOC
## build

### Description
Builds and returns the configured SMTPServer instance.

### Returns
* `SMTPServer` - The constructed SMTP server instance.
```

--------------------------------

### dataStart

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/client/SmartClient.html

Initiates the data transfer phase for sending an email.

```APIDOC
## dataStart

### Description
Initiates the data transfer phase for sending an email.

### Method
`public void dataStart()`

### Throws
* `IOException`
* `SMTPException`
```

--------------------------------

### Constructor

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/internal/io/DotTerminatedOutputStream.html

Initializes a new instance of the DotTerminatedOutputStream class.

```APIDOC
## DotTerminatedOutputStream(OutputStream out)

### Description
Initializes a new instance of the DotTerminatedOutputStream class with the specified output stream.

### Parameters
* **out** (OutputStream) - The underlying output stream to write to.
```

--------------------------------

### ready() Method

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/internal/io/CRLFTerminatedReader.html

Indicates whether a next available method is ready without the current thread blocking.

```APIDOC
## ready()

### Description
Indicates whether a next available method is ready without the current thread blocking.

### Returns
* `boolean` - true if the next invocation of the read() method is certain not to block for input, false otherwise. Of course, whether the next read() is going to block is a property of the stream that could change between the time the ready() method is invoked and the time the read() method is invoked.

### Throws
* `IOException` - if an I/O error occurs.
```

--------------------------------

### getSessionHandler

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/server/SMTPServer.html

Gets the handler responsible for managing SMTP sessions.

```APIDOC
## getSessionHandler

### Description
Gets the handler responsible for managing SMTP sessions.

### Method
getSessionHandler

### Parameters
None

### Response
#### Success Response
- **SessionHandler** - The session handler
```

--------------------------------

### getMessageHandlerFactory

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/server/SMTPServer.html

Gets the factory responsible for creating message handlers.

```APIDOC
## getMessageHandlerFactory

### Description
Gets the factory responsible for creating message handlers.

### Method
getMessageHandlerFactory

### Parameters
None

### Response
#### Success Response
- **MessageHandlerFactory** - The message handler factory
```

--------------------------------

### dataStart

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/client/SmartClient.html

Initiates the data transfer phase before sending email content.

```APIDOC
## dataStart()

### Description
Prelude to writing data.

### Method
void
```

--------------------------------

### getRecipientCount

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/client/SmartClient.html

Gets the number of recipients currently set for the transaction.

```APIDOC
## getRecipientCount()

### Description
Gets the number of recipients currently set for the transaction.

### Method
int
```

--------------------------------

### getMaxMessageSize

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/server/SMTPServer.html

Gets the maximum allowed size for an email message in bytes.

```APIDOC
## getMaxMessageSize

### Description
Gets the maximum allowed size for an email message in bytes.

### Method
getMaxMessageSize

### Parameters
None

### Response
#### Success Response
- **int** - The maximum message size in bytes
```

--------------------------------

### getEnvelopeSender

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/index-all.html

Get's the MAIL FROM: sender address from the message envelope.

```APIDOC
## getEnvelopeSender()

### Description
Retrieves the sender's email address from the message envelope.

### Method
GET

### Endpoint
/WiserMessage/getEnvelopeSender
```

--------------------------------

### SmartClient createAndConnect Method (Basic)

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/client/SmartClient.html

Static factory method to create and connect a SmartClient to a specified host and port. It uses a default HELO host.

```java
public static final SmartClient createAndConnect(String host,
                                                 int port,
                                                 String clientHeloHost)
                                          throws UnknownHostException,
                                                 SMTPException,
                                                 IOException
```

--------------------------------

### execute Method

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/internal/command/StartTLSCommand.html

Executes the STARTTLS command. This method is called when the STARTTLS command is received from the client.

```APIDOC
## execute(String commandString, Session sess)

### Description
This is the main method that you need to override in order to implement a command. It is called when the command is received from the client.

### Method
`public void execute(String commandString, Session sess) throws IOException`

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- None

### Request Example
(Not applicable for this method)

### Response
#### Success Response (void)
This method does not return a value.

#### Response Example
(Not applicable for this method)

### Throws
- `IOException`
```

--------------------------------

### getEnvelopeReceiver

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/index-all.html

Get's the RCPT TO: recipient address from the message envelope.

```APIDOC
## getEnvelopeReceiver()

### Description
Retrieves the recipient's email address from the message envelope.

### Method
GET

### Endpoint
/WiserMessage/getEnvelopeReceiver
```

--------------------------------

### SmartClient.connect(String, int)

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/index-all.html

Connects to the specified server and issues the initial HELO command.

```APIDOC
## connect(String, int)

### Description
Connects to the specified server and issues the initial HELO command.

### Method
`connect(String host, int port)`

### Class
`org.subethamail.smtp.client.SmartClient`
```

--------------------------------

### EasyAuthenticationHandlerFactory

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/auth/package-summary.html

A convenient factory that simplifies the setup of known authentication handlers.

```APIDOC
## Class EasyAuthenticationHandlerFactory

### Description
This is a convenient class that saves you setting up the factories that we know about; you can always add more afterwards.

### Methods
- `create()`: Creates an instance of the EasyAuthenticationHandlerFactory.
```

--------------------------------

### getShowAuthCapabilitiesBeforeSTARTTLS()

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/index-all.html

Indicates whether to show authentication capabilities before STARTTLS.

```APIDOC
## getShowAuthCapabilitiesBeforeSTARTTLS()

### Description
Indicates whether to show authentication capabilities before STARTTLS.

### Method
Method

### Class
org.subethamail.smtp.server.SMTPServer
```

--------------------------------

### Get SMTPServer Port

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/server/SMTPServer.html

Retrieves the configured port number for the SMTP server.

```java
public int getPort()

```

--------------------------------

### startTLS

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/client/SmartClient.html

Upgrades the current connection to use TLS encryption via the STARTTLS command and re-issues EHLO.

```APIDOC
## startTLS()

### Description
Upgrades the connection to use TLS with the STARTTLS command and reissues the EHLO to the server.

### Method
void
```

--------------------------------

### ResetCommand Constructor

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/internal/command/ResetCommand.html

The default constructor for the ResetCommand class. No specific setup is required.

```java
public
ResetCommand()
```

--------------------------------

### DataCommand Constructor

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/internal/command/DataCommand.html

The default constructor for the DataCommand class. No specific setup is required.

```java
public
DataCommand()
```

--------------------------------

### startTLS

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/client/SmartClient.html

Upgrades the connection to use TLS with the STARTTLS command and reissues the EHLO to the server.

```APIDOC
## startTLS

### Description
Upgrades the connection to use TLS with the STARTTLS command and reissues the EHLO to the server.

### Method
`public void startTLS()`

### Throws
* `IllegalStateException` - Thrown if a server did not indicate it supports STARTTLS in the original EHLO/HELO.
* `IOException`
* `SMTPException`
```

--------------------------------

### execute Method

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/internal/command/HelloCommand.html

Executes the Hello command during an SMTP session. This is the main method to override for command implementation.

```APIDOC
## execute(String commandString, Session sess)

### Description
This is the main method that you need to override in order to implement a command. It is called when the Hello command is received.

### Method Signature
`public void execute(String commandString, Session sess) throws IOException`

### Parameters
* **commandString** (String) - The full command string received from the client.
* **sess** (Session) - The current SMTP session object.

### Throws
* **IOException** - If an I/O error occurs during command execution.
```

--------------------------------

### BaseCommand Constructor

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/internal/server/BaseCommand.html

Protected constructor for initializing a command with its name and help text. An optional argument description can also be provided.

```java
protected BaseCommand(String name,
                      String help)
```

```java
protected BaseCommand(String name,
                      String help,
                      String argumentDescription)
```

--------------------------------

### Wiser Instance Control

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/wiser/Wiser.html

Methods to start, stop, and manage the Wiser SMTP server.

```APIDOC
## Wiser Instance Control

### Description
Methods to start, stop, and manage the Wiser SMTP server.

### Methods

#### `void start()`
Starts the SMTP Server.

#### `void stop()`
Stops the SMTP Server.
```

--------------------------------

### Get All Verbs

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/internal/server/CommandHandler.html

Returns a set of all command names (verbs) currently managed by the handler.

```java
public Set<String> getVerbs()
```

--------------------------------

### Get Local Socket Address

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/client/SMTPClient.html

Returns the local socket address from which the client is connected.

```java
public SocketAddress getLocalSocketAddress()
```

--------------------------------

### AuthCommand.AuthCommand

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/index-all.html

Creates a new instance of AuthCommand.

```APIDOC
## AuthCommand()

### Description
Creates a new instance of AuthCommand.

### Method
AuthCommand
```

--------------------------------

### startTlsSocketFactory(SSLContext context)

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/server/SMTPServer.Builder.html

Sets an SSLContext to be used for creating sockets with STARTTLS.

```APIDOC
## startTlsSocketFactory

### Description
Sets an SSLContext to be used for creating sockets with STARTTLS.

### Parameters
* `context` (SSLContext) - The SSL context.

### Returns
* `SMTPServer.Builder` - The builder instance for chaining.
```

--------------------------------

### Get Envelope Sender - WiserMessage

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/wiser/WiserMessage.html

Retrieves the sender's email address from the envelope (MAIL FROM:).

```java
public String getEnvelopeSender()
```

--------------------------------

### SmartClient createAndConnect Method (with Bindpoint)

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/client/SmartClient.html

Static factory method to create and connect a SmartClient, allowing specification of a local bindpoint for the socket.

```java
public static final SmartClient createAndConnect(String host,
                                                 int port,
                                                 Optional<SocketAddress> bindpoint,
                                                 String clientHeloHost,
```

--------------------------------

### createAndConnect (overload 1)

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/client/SmartClient.html

Creates and connects a SmartClient to the specified host and port, using a provided HELO host.

```APIDOC
## createAndConnect(String host, int port, String clientHeloHost)

### Description
Creates and connects a SmartClient to the specified host and port, using a provided HELO host.

### Method
static SmartClient

### Parameters
* **host** (String) - The hostname or IP address of the SMTP server.
* **port** (int) - The port number of the SMTP server.
* **clientHeloHost** (String) - The HELO host name for this client.

### Throws
* UnknownHostException
* SMTPException
* IOException
```

--------------------------------

### Get Envelope Receiver - WiserMessage

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/wiser/WiserMessage.html

Retrieves the recipient's email address from the envelope (RCPT TO:).

```java
public String getEnvelopeReceiver()
```

--------------------------------

### BaseCommand getArgPredicate Method

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/internal/server/BaseCommand.html

Protected method to get the argument predicate for a given command string.

```java
protected String getArgPredicate(String commandString)
```

--------------------------------

### SmartClient Constructor

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/client/class-use/SMTPClient.html

Demonstrates the use of an existing SMTPClient instance when constructing a SmartClient.

```APIDOC
## SmartClient(SMTPClient client, String clientHeloHost, Optional<Authenticator> authenticator)

### Description
Constructs a SmartClient using an existing SMTPClient, a client HELO host, and an optional authenticator.

### Method
Constructor

### Parameters
- **client** (SMTPClient) - The SMTPClient instance to be used.
- **clientHeloHost** (String) - The host name to use for the client HELO command.
- **authenticator** (Optional<Authenticator>) - An optional Authenticator for authentication.

### Endpoint
N/A (Constructor Call)
```

--------------------------------

### SMTPClient.connect(String, int)

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/index-all.html

Establishes a connection to the specified host and port.

```APIDOC
## connect(String, int)

### Description
Establishes a connection to host and port.

### Method
`connect(String host, int port)`

### Class
`org.subethamail.smtp.client.SMTPClient`
```

--------------------------------

### SMTPClient.createAndConnect(String, int)

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/index-all.html

Creates an SMTPClient and establishes a connection to the specified host and port.

```APIDOC
## createAndConnect(String, int)

### Description
Creates an SMTPClient and establishes a connection to the specified host and port.

### Method
`createAndConnect(String host, int port)`

### Class
`org.subethamail.smtp.client.SMTPClient`
```

--------------------------------

### BdatCommand Constructor

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/internal/command/BdatCommand.html

The default constructor for the BdatCommand class. No specific setup is required when instantiating this command.

```java
public
BdatCommand()
```

--------------------------------

### RequireAuthCommandWrapper getName Method

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/internal/server/RequireAuthCommandWrapper.html

Returns the name of the command in uppercase, for example, "QUIT".

```java
public
String
getName()
```

--------------------------------

### HelpMessage Constructor with Argument Description

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/internal/server/HelpMessage.html

Constructs a HelpMessage with command name, help message, and argument description. Use when the command has specific arguments to describe.

```java
public HelpMessage(String commandName,
                   String helpMessage,
                   String argumentDescription)
```

--------------------------------

### Check if SMTPServer is Running

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/server/SMTPServer.html

Use the isRunning() method to determine if the server has been started and is actively listening for connections.

```java
public boolean isRunning()

```

--------------------------------

### Create and Connect to SMTP Server

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/client/SMTPClient.html

Static factory method to create an SMTPClient and establish a connection to the specified host and port. Throws UnknownHostException or IOException on connection failure.

```java
public static SMTPClient createAndConnect(String host,
                                          int port)
                                   throws UnknownHostException,
                                          IOException
```

```java
public static SMTPClient createAndConnect(String host,
                                          int port,
                                          Optional<String> hostPortName)
                                   throws UnknownHostException,
                                          IOException
```

--------------------------------

### Get Executor Service

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/server/SMTPServer.html

Returns the ExecutorService responsible for managing client connections, allowing for asynchronous handling.

```java
public ExecutorService getExecutorService()

```

--------------------------------

### SmartClient Creation and Connection

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/client/class-use/SmartClient.html

These static methods are used to create and establish a connection with a SmartClient. They offer various options for specifying connection details, including host, port, bind point, client HELO host, authenticator, and SSL socket factory.

```APIDOC
## SmartClient.createAndConnect

### Description
Creates and connects a SmartClient with specified parameters.

### Method
`static SmartClient`

### Parameters
#### createAndConnect(String host, int port, Optional<SocketAddress> bindpoint, String clientHeloHost, Optional<Authenticator> authenticator)
- **host** (String) - The hostname or IP address to connect to.
- **port** (int) - The port number to connect to.
- **bindpoint** (Optional<SocketAddress>) - An optional socket address to bind to.
- **clientHeloHost** (String) - The hostname to use in the client's HELO command.
- **authenticator** (Optional<Authenticator>) - An optional authenticator for the connection.

#### createAndConnect(String host, int port, Optional<SocketAddress> bindpoint, String clientHeloHost, Optional<Authenticator> authenticator, Optional<SSLSocketFactory> sslSocketFactory)
- **host** (String) - The hostname or IP address to connect to.
- **port** (int) - The port number to connect to.
- **bindpoint** (Optional<SocketAddress>) - An optional socket address to bind to.
- **clientHeloHost** (String) - The hostname to use in the client's HELO command.
- **authenticator** (Optional<Authenticator>) - An optional authenticator for the connection.
- **sslSocketFactory** (Optional<SSLSocketFactory>) - An optional SSL socket factory for secure connections.

#### createAndConnect(String host, int port, String clientHeloHost)
- **host** (String) - The hostname or IP address to connect to.
- **port** (int) - The port number to connect to.
- **clientHeloHost** (String) - The hostname to use in the client's HELO command.
```

--------------------------------

### Get Raw Message Data - WiserMessage

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/wiser/WiserMessage.html

Retrieves the raw byte array data of the email message.

```java
public byte[] getData()
```

--------------------------------

### BaseCommand Constructors

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/internal/server/BaseCommand.html

Protected constructors for initializing a BaseCommand with its name, help text, and optionally, argument description.

```APIDOC
## BaseCommand Constructors

### protected BaseCommand(String name, String help)

Initializes a new instance of the `BaseCommand` class with the specified name and help text.

### protected BaseCommand(String name, String help, String argumentDescription)

Initializes a new instance of the `BaseCommand` class with the specified name, help text, and argument description.
```

--------------------------------

### BdatCommand Constructor

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/internal/command/BdatCommand.html

Initializes a new instance of the BdatCommand class.

```APIDOC
## BdatCommand()

### Description
Initializes a new instance of the BdatCommand class.

### Constructor
`public BdatCommand()`
```

--------------------------------

### getData

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/index-all.html

Get's the raw message DATA. This method is used to retrieve the complete message content.

```APIDOC
## getData()

### Description
Retrieves the raw message data.

### Method
GET

### Endpoint
/WiserMessage/getData
```

--------------------------------

### Connect to SMTP Server

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/client/SMTPClient.html

Establishes a connection to the specified host and port. Throws IOException if a problem occurs during connection.

```java
public void connect(String host,
                    int port)
             throws IOException
```

--------------------------------

### Get Implementation Version

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/Version.html

Retrieves the implementation version of the subethamail library. This method is static and requires no arguments.

```java
public static	String	getImplementation()
```

--------------------------------

### Get Specification Version

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/Version.html

Retrieves the specification version of the subethamail library. This method is static and requires no arguments.

```java
public static	String	getSpecification()
```

--------------------------------

### SmartClient.createAndConnect() with Authenticator

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/client/class-use/Authenticator.html

Creates and connects a SmartClient instance, optionally providing an Authenticator for server authentication.

```APIDOC
## SmartClient.createAndConnect(String host, int port, Optional<SocketAddress> bindpoint, String clientHeloHost, Optional<Authenticator> authenticator)

### Description
Creates and connects a SmartClient instance, optionally providing an Authenticator for server authentication.

### Method
`static SmartClient createAndConnect(String host, int port, Optional<SocketAddress> bindpoint, String clientHeloHost, Optional<Authenticator> authenticator)`

### Parameters
#### Path Parameters
- **host** (String) - Description not available
- **port** (int) - Description not available
- **bindpoint** (Optional<SocketAddress>) - Description not available
- **clientHeloHost** (String) - Description not available
- **authenticator** (Optional<Authenticator>) - Description not available
```

```APIDOC
## SmartClient.createAndConnect(String host, int port, Optional<SocketAddress> bindpoint, String clientHeloHost, Optional<Authenticator> authenticator, Optional<SSLSocketFactory> sslSocketFactory)

### Description
Creates and connects a SmartClient instance, optionally providing an Authenticator and SSLSocketFactory for server authentication.

### Method
`static SmartClient createAndConnect(String host, int port, Optional<SocketAddress> bindpoint, String clientHeloHost, Optional<Authenticator> authenticator, Optional<SSLSocketFactory> sslSocketFactory)`

### Parameters
#### Path Parameters
- **host** (String) - Description not available
- **port** (int) - Description not available
- **bindpoint** (Optional<SocketAddress>) - Description not available
- **clientHeloHost** (String) - Description not available
- **authenticator** (Optional<Authenticator>) - Description not available
- **sslSocketFactory** (Optional<SSLSocketFactory>) - Description not available
```

--------------------------------

### DotUnstuffingInputStream Constructor

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/internal/io/DotUnstuffingInputStream.html

Initializes a new DotUnstuffingInputStream with the provided underlying InputStream.

```APIDOC
## DotUnstuffingInputStream(InputStream in)

### Description
Initializes a new instance of the DotUnstuffingInputStream class.

### Parameters
* **in** (InputStream) - The underlying input stream to read from.
```

--------------------------------

### QuitCommand Constructor

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/internal/command/QuitCommand.html

The default constructor for the QuitCommand class. No specific setup is required when instantiating this command handler.

```java
public
QuitCommand()
```

--------------------------------

### BasicSMTPServer Class

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/examples/BasicSMTPServer.html

Provides a basic SMTP server implementation.

```APIDOC
## Class: BasicSMTPServer

### Description
A simple SMTP server implementation.

### Fields
- `DEFAULT_PORT` (int): The default port for the SMTP server.

### Constructors
- `BasicSMTPServer()`: Constructs a new BasicSMTPServer.

### Methods
- `main(String[] args)` (static void): The entry point of the application. It starts the SMTP server.
- `start(int port)` (SMTPServer): Starts the SMTP server on the specified port.
```

--------------------------------

### getHelp Method

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/internal/server/RequireAuthCommandWrapper.html

Retrieves the help message for the wrapped command.

```APIDOC
## getHelp Method

### Description
Returns the help message for the command. This is typically used when the client sends an 'HELP' command.

### Method
`HelpMessage getHelp()`

### Returns
* `HelpMessage` - The help message associated with the command.

### Throws
* `CommandException`

### Example
```java
HelpMessage help = wrapper.getHelp();
```
```

--------------------------------

### ExtraDotOutputStream.writeChunk

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/index-all.html

Overrides super writeChunk in order to add a '.' if the previous chunk ended with a newline and a new chunk starts with '.'

```APIDOC
## writeChunk(byte[], int, int) - Method in class org.subethamail.smtp.internal.io.ExtraDotOutputStream

### Description
Overrides super writeChunk in order to add a '.' if the previous chunk ended with a newline and a new chunk starts with '.'

### Method
Instance method

### Parameters
#### Path Parameters
- **chunk** (byte[]) - Required - The chunk of data to write.
- **off** (int) - Required - The start offset in the chunk.
- **len** (int) - Required - The number of bytes in the chunk.
```

--------------------------------

### BasicSMTPServer Constructor

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/examples/BasicSMTPServer.html

The default constructor for the BasicSMTPServer class.

```java
public BasicSMTPServer()
```

--------------------------------

### Initialize SmarterMessageListenerAdapter with listeners and data deferred size

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/helper/SmarterMessageListenerAdapter.html

Initializes the adapter with a collection of SmarterMessageListeners and specifies the data deferred size. The server will buffer incoming messages to disk when they reach this limit during DATA reception.

```java
public SmarterMessageListenerAdapter(Collection<SmarterMessageListener> listeners,
                                     int dataDeferredSize)
```

--------------------------------

### Get SMTPServer Host Name

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/server/SMTPServer.html

Retrieves the host name that will be reported to SMTP clients. This is configured during server construction.

```java
public String getHostName()

```

--------------------------------

### Get Command by Name

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/internal/server/CommandHandler.html

Retrieves a Command object based on its case-insensitive name. Returns null if the command is not found.

```java
public Command getCommand(String commandName)
```

--------------------------------

### StartTLSCommand Class Definition

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/internal/command/StartTLSCommand.html

Defines the StartTLSCommand class, which extends BaseCommand. This class is part of the internal server command implementation.

```java
public final class StartTLSCommand
extends BaseCommand
```

--------------------------------

### SMTPServer.Builder.server(SMTPServer.Builder)

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/index-all.html

Builds an SMTPServer instance using the provided builder.

```APIDOC
## SMTPServer.Builder.server(SMTPServer.Builder)

### Description
Builds the SMTPServer.

### Method
```
SMTPServer
```

### Parameters
* **SMTPServer.Builder** - The builder configuration for the SMTPServer.
```

--------------------------------

### Get Session ID

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/MessageContext.html

Returns a unique identifier for the current SMTP session. This is a default method provided by the interface.

```java
default String getSessionId()
```

--------------------------------

### Send Message to Server

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/client/SMTPClient.html

Sends a raw message string to the SMTP server. For example, sending a HELO command.

```java
protected void send(String msg)
```

--------------------------------

### execute Method

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/internal/server/RequireTLSCommandWrapper.html

Executes the wrapped command after verifying the TLS connection.

```APIDOC
## execute(String commandString, Session sess)

### Description
Executes the command. This method first checks if a TLS connection is required and present. If the check passes, the wrapped command's execute method is called.

### Method
public void execute(String commandString, Session sess) throws IOException, DropConnectionException

### Parameters
* **commandString** (String) - The command string received from the client.
* **sess** (Session) - The current SMTP session.

### Throws
* **IOException** - If an I/O error occurs during command execution.
* **DropConnectionException** - If the connection needs to be dropped due to an error or policy violation.
```

--------------------------------

### startTlsSocketFactory(SSLContext context, boolean requireClientCertificate)

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/server/SMTPServer.Builder.html

Sets an SSLContext and a flag to require client certificates for STARTTLS connections.

```APIDOC
## startTlsSocketFactory

### Description
Sets an SSLContext and a flag to require client certificates for STARTTLS connections.

### Parameters
* `context` (SSLContext) - The SSL context.
* `requireClientCertificate` (boolean) - Whether to require client certificates.

### Returns
* `SMTPServer.Builder` - The builder instance for chaining.
```

--------------------------------

### extractEmailAddress

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/internal/util/EmailUtils.html

Extracts the email address enclosed within angle brackets (<>) from a given string, starting the search after a specified offset.

```APIDOC
## extractEmailAddress

### Description
Extracts the email address within a <> after a specified offset.

### Method Signature
`public static String extractEmailAddress(String args, int offset)`

### Parameters
* `args` (String) - The string to search within.
* `offset` (int) - The position in the string after which to start searching for the email address.

### Returns
* `String` - The extracted email address, or null if not found.
```

--------------------------------

### Get Software Name

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/server/SMTPServer.html

Retrieves the software name reported to SMTP clients, typically including the server name and version.

```java
public String getSoftwareName()

```

--------------------------------

### Connect to SMTP Server

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/client/SMTPClient.html

Establishes a connection to the specified host and port. This method initiates the network connection.

```java
public void connect(String host,
        int port)
```

--------------------------------

### Get Help Message for Command

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/internal/server/CommandHandler.html

Retrieves the HelpMessage object for a specific command name. This operation may throw a CommandException.

```java
public HelpMessage getHelp(String command)
                    throws CommandException
```

--------------------------------

### Execute Method - HelpCommand

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/internal/command/HelpCommand.html

The main method to override for implementing a command. This method is executed when the command is received by the server.

```java
public
void	execute(String	commandString,
                    Session	context)
             throws IOException
```

--------------------------------

### Get Authentication Handler

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/MessageContext.html

Retrieves the authentication handler instance used for the current session, if authentication has occurred. Returns an Optional.

```java
Optional<AuthenticationHandler> getAuthenticationHandler()
```

--------------------------------

### Get SMTPServer Instance

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/MessageContext.html

Retrieves the SMTPServer object associated with the current message context. This can be used to interact with the server instance.

```java
SMTPServer getSMTPServer()
```

--------------------------------

### NoopCommand Constructor

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/internal/command/NoopCommand.html

Initializes a new instance of the NoopCommand class.

```APIDOC
## NoopCommand()

### Description
Initializes a new instance of the `NoopCommand` class.

### Constructor
`public NoopCommand()`
```

--------------------------------

### getHelp Method

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/internal/server/RequireTLSCommandWrapper.html

Retrieves the help message for the command.

```APIDOC
## getHelp()

### Description
Returns the help message associated with this command.

### Method
public HelpMessage getHelp() throws CommandException

### Returns
* **HelpMessage** - The help message for the command.

### Throws
* **CommandException** - If an error occurs while retrieving the help message.
```

--------------------------------

### Get SMTP Server Instance

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/wiser/Wiser.html

Returns the underlying SMTPServer instance used by Wiser. This can be useful for advanced inspection or manipulation of the server.

```java
public SMTPServer getServer()
```

--------------------------------

### execute Method

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/internal/command/HelpCommand.html

Executes the command with the given string and context. This is the main method to override for command implementation.

```APIDOC
## execute(String commandString, Session context)

### Description
This is the main method that you need to override in order to implement a command.

### Method Signature
`void execute(String commandString, Session context) throws IOException`

### Parameters
* **commandString** (String) - The command string received from the client.
* **context** (Session) - The current session context.
```

--------------------------------

### Get Messages

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/wiser/class-use/WiserMessage.html

Retrieves a list of all captured WiserMessage objects. This method is part of the Wiser class and allows access to the emails that have been processed.

```APIDOC
## Wiser.getMessages()

### Description
Returns the list of WiserMessages.

### Method
```java
List<WiserMessage>
```

### Returns
- **List<WiserMessage>** - A list containing all captured WiserMessage objects.
```

--------------------------------

### HelloCommand Constructor

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/internal/command/HelloCommand.html

The default constructor for the HelloCommand class. No arguments are needed to create an instance.

```java
public
HelloCommand()
```

--------------------------------

### SimpleMessageListenerAdapter.create

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/class-use/MessageContext.html

The create method in SimpleMessageListenerAdapter creates an adapter for simple message listeners, using the MessageContext.

```APIDOC
## SimpleMessageListenerAdapter.create

### Description
Creates an adapter for a simple message listener, utilizing the message context.

### Method Signature
`MessageHandler create(MessageContext ctx)`

### Parameters
- **ctx** (MessageContext) - The context of the message.
```

--------------------------------

### HelloCommand Class Definition

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/internal/command/HelloCommand.html

Defines the HelloCommand class, extending BaseCommand. This class is final and does not require any specific setup beyond its instantiation.

```java
public final class HelloCommand
extends BaseCommand
```

--------------------------------

### Get Allocated Port

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/server/SMTPServer.html

Returns the actual port number the server is listening on, which might differ from the configured port if port 0 was specified.

```java
public int getPortAllocated()

```

--------------------------------

### SmartClient createAndConnect Method (with SSL)

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/client/SmartClient.html

Static factory method to create and connect a SmartClient with support for SSL/TLS, allowing a custom SSLSocketFactory.

```java
public static final SmartClient createAndConnect(String host,
                                                 int port,
                                                 Optional<SocketAddress> bindpoint,
                                                 String clientHeloHost,
                                                 Optional<Authenticator> authenticator,
                                                 Optional<SSLSocketFactory> sslSocketFactory)
```

--------------------------------

### Get SMTPServer Bind Address

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/server/SMTPServer.html

Returns the network interface address the server is bound to. An empty Optional indicates binding to all available interfaces.

```java
public Optional<InetAddress> getBindAddress()

```

--------------------------------

### Get the error message for a failed session

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/server/SessionHandler.SessionAcceptance.html

If a session was not accepted, this method returns the message detailing the reason for the failure. Returns null if the session was accepted.

```java
public String errorMessage()
```

--------------------------------

### SmartClient Constructor with Authenticator

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/client/class-use/Authenticator.html

Constructs a SmartClient instance, optionally accepting an Authenticator for client authentication.

```APIDOC
## SmartClient(SMTPClient client, String clientHeloHost, Optional<Authenticator> authenticator)

### Description
Constructs a SmartClient instance, optionally accepting an Authenticator for client authentication.

### Constructor
`SmartClient(SMTPClient client, String clientHeloHost, Optional<Authenticator> authenticator)`

### Parameters
#### Path Parameters
- **client** (SMTPClient) - Description not available
- **clientHeloHost** (String) - Description not available
- **authenticator** (Optional<Authenticator>) - Description not available
```

--------------------------------

### ProxyProtocolV1V2Handler(ProxyProtocolV1Handler, ProxyProtocolV2Handler)

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/index-all.html

Constructor for ProxyProtocolV1V2Handler.

```APIDOC
## ProxyProtocolV1V2Handler(ProxyProtocolV1Handler, ProxyProtocolV2Handler)

### Description
Constructor for ProxyProtocolV1V2Handler.

### Constructor
Constructor for class org.subethamail.smtp.internal.proxy.ProxyProtocolV1V2Handler
```

--------------------------------

### Get HELO/EHLO Hostname

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/MessageContext.html

Fetches the hostname or address literal provided by the client in the HELO or EHLO command. Returns an empty Optional if these commands were not received.

```java
Optional<String> getHelo()
```

--------------------------------

### Authenticator Interface

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/client/package-summary.html

An Authenticator is called by SmartClient after the initial EHLO command and negotiates the authentication of the user, for example by issuing the SMTP AUTH command to the server.

```APIDOC
## Interface Authenticator

### Description
An Authenticator is called by SmartClient after the initial EHLO command and negotiates the authentication of the user for example by issuing the SMTP AUTH command to the server.

### Interface
`Authenticator`
```

--------------------------------

### MailCommand Constructors

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/internal/command/MailCommand.html

Provides information on how to create instances of the MailCommand class.

```APIDOC
## MailCommand()

### Description
Default constructor for MailCommand.

### Constructor
`public MailCommand()`
```

```APIDOC
## MailCommand(Predicate<String> fromAddressValidator)

### Description
Constructor for MailCommand that accepts a validator for the FROM address.

### Parameters
* **fromAddressValidator** (Predicate<String>) - Required - A predicate to check if the MAIL FROM: address is valid.
```

--------------------------------

### Get TLS Peer Certificates

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/MessageContext.html

Retrieves the peer certificates established during the TLS handshake. To obtain this information, the SMTPServer.createSSLSocket method must be overridden to setNeedClientAuth(true).

```java
Certificate[] getTlsPeerCertificates()
```

--------------------------------

### ExpandCommand Constructor

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/internal/command/ExpandCommand.html

Initializes a new instance of the ExpandCommand class.

```APIDOC
## ExpandCommand()

### Description
Constructs a new ExpandCommand.

### Constructor
`ExpandCommand()`
```

--------------------------------

### Get the error code for a failed session

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/server/SessionHandler.SessionAcceptance.html

If a session was not accepted, this method returns the SMTP response code representing the reason for the failure. Returns 0 if the session was accepted.

```java
public int errorCode()
```

--------------------------------

### VerifyCommand()

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/index-all.html

Constructs a new VerifyCommand.

```APIDOC
## VerifyCommand() - Constructor for class org.subethamail.smtp.internal.command.VerifyCommand

### Description
Constructs a new VerifyCommand.
```

--------------------------------

### ProxyProtocolV2Handler.Transport Enum Methods

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/internal/proxy/class-use/ProxyProtocolV2Handler.Transport.html

This section details the static methods available for the ProxyProtocolV2Handler.Transport enum, allowing users to retrieve enum constants by name or get all declared constants.

```APIDOC
## ProxyProtocolV2Handler.Transport.valueOf(String name)

### Description
Returns the enum constant of this type with the specified name.

### Method
`static ProxyProtocolV2Handler.Transport`

### Parameters
#### Path Parameters
- **name** (String) - The name of the enum constant to return.

### Response
#### Success Response (Enum Constant)
- Returns the enum constant matching the provided name.

## ProxyProtocolV2Handler.Transport.values()

### Description
Returns an array containing the constants of this enum type, in the order they are declared.

### Method
`static ProxyProtocolV2Handler.Transport[]`

### Response
#### Success Response (Array of Enum Constants)
- Returns an array of all enum constants in their declared order.
```

--------------------------------

### ProxyProtocolV1Handler.Family Enum Methods

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/internal/proxy/class-use/ProxyProtocolV1Handler.Family.html

This section details the static methods available for the ProxyProtocolV1Handler.Family enum, allowing users to retrieve enum constants by name or get all declared constants.

```APIDOC
## valueOf(String name)

### Description
Returns the enum constant of this type with the specified name.

### Method
`static ProxyProtocolV1Handler.Family`

### Parameters
#### Path Parameters
- **name** (String) - The name of the enum constant to return.
```

```APIDOC
## values()

### Description
Returns an array containing the constants of this enum type, in the order they are declared.

### Method
`static ProxyProtocolV1Handler.Family[]`
```

--------------------------------

### DeferredFileOutputStream Constructor

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/internal/io/DeferredFileOutputStream.html

Initializes DeferredFileOutputStream with a transition size. This is the number of bytes at which the stream switches from a byte array to a file.

```java
public DeferredFileOutputStream(int
transitionSize)
```

--------------------------------

### Get Remote Address

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/MessageContext.html

Obtains the IP address of the remote client. The returned object is an instance of SocketAddress, typically InetSocketAddress. Casting to InetSocketAddress provides more detailed information.

```java
SocketAddress getRemoteAddress()
```

--------------------------------

### BaseCommand getHelp Method

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/internal/server/BaseCommand.html

Retrieves the HelpMessage for the command. Implemented from the Command interface.

```java
public HelpMessage getHelp()
```

--------------------------------

### ExpandCommand.execute Method

Source: https://javadoc.io/doc/com.github.davidmoten/subethasmtp/7.2.2/org/subethamail/smtp/internal/command/ExpandCommand.html

Executes the EXPAND command. This is the main method that needs to be overridden to implement a command.

```APIDOC
## execute(String commandString, Session sess)

### Description
This is the main method that you need to override in order to implement a command.

### Method
`void execute(String commandString, Session sess)`

### Parameters
* **commandString** (String) - The full command string received.
* **sess** (Session) - The current SMTP session.

### Throws
* **IOException** - If an I/O error occurs during execution.
```
Tokens:
Raw