org.subethamail.smtp.client

Class SMTPClient

java.lang.Object

org.subethamail.smtp.client.SMTPClient

All Implemented Interfaces:

AutoCloseable

public class SMTPClient
extends Object
implements AutoCloseable

A very low level abstraction of the STMP stream which knows how to handle the raw protocol for lines, whitespace, etc.

Author:

Jeff Schnitzer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SMTPClient.Response Result of an SMTP exchange.

Field Summary

Fields

Modifier and Type	Field and Description
static long	RECEIVE_AND_CHECK_PAUSE_MS This field is temporary only till SmartClient builder is created.

Constructor Summary

Constructors

Constructor and Description
SMTPClient() Establishes a connection to host and port.
SMTPClient(Optional<SocketAddress> bindpoint, Optional<String> hostPortName) Constructor.

Method Summary

Modifier and Type	Method and Description
void	close() Logs but otherwise ignores errors
void	connect(String host, int port) Establishes a connection to host and port.
static SMTPClient	createAndConnect(String host, int port)
static SMTPClient	createAndConnect(String host, int port, Optional<String> hostPortName)
protected Socket	createSocket() Returns a new unconnected socket.
String	getHostPort()
SocketAddress	getLocalSocketAddress() Returns the local socket address.
boolean	isConnected() Returns true if the client is connected to the server.
protected SMTPClient.Response	receive() Note that the response text comes back without trailing newlines.
SMTPClient.Response	receiveAndCheck() If response is not success, throw an exception
protected void	send(String msg) Sends a message to the server, ie "HELO foo.example.com".
SMTPClient.Response	sendAndCheck(String msg) If response is not success, throw an exception
SMTPClient.Response	sendReceive(String msg) Sends a message to the server, ie "HELO foo.example.com".
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

RECEIVE_AND_CHECK_PAUSE_MS

public static final long RECEIVE_AND_CHECK_PAUSE_MS

This field is temporary only till SmartClient builder is created.

See Also:

Constant Field Values

Constructor Detail

SMTPClient

public SMTPClient()

Establishes a connection to host and port.

SMTPClient

public SMTPClient(Optional<SocketAddress> bindpoint,
                  Optional<String> hostPortName)

Constructor.

Parameters:

bindpoint - the local socket address. If empty, the system will pick up an ephemeral port and a valid local address.

hostPortName - Sets the name of the remote MTA for informative purposes. Default is host:port, where host and port are the values which were used to open the TCP connection to the server, as they were passed to the connect method.

Method Detail

createAndConnect

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

Throws:

UnknownHostException

IOException

createAndConnect

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

Throws:

UnknownHostException

IOException

connect

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

Establishes a connection to host and port.

Throws:

IOException - if there is a problem connecting to the port

createSocket

protected Socket createSocket()

Returns a new unconnected socket.

Implementation notice for subclasses: This function is called by the constructors which open the connection immediately. In these cases the subclass is not yet initialized, therefore subclasses overriding this function shouldn't use those constructors.

isConnected

public boolean isConnected()

Returns true if the client is connected to the server.

send

protected void send(String msg)
             throws IOException

Sends a message to the server, ie "HELO foo.example.com". A newline will be appended to the message.

Parameters:

msg - should not have any newlines

Throws:

IOException

receive

protected SMTPClient.Response receive()
                               throws IOException

Note that the response text comes back without trailing newlines.

Throws:

IOException

sendReceive

public SMTPClient.Response sendReceive(String msg)
                                throws IOException

Sends a message to the server, ie "HELO foo.example.com". A newline will be appended to the message.

Parameters:

msg - should not have any newlines

Returns:

the response from the server

Throws:

IOException

receiveAndCheck

public SMTPClient.Response receiveAndCheck()
                                    throws IOException,
                                           SMTPException

If response is not success, throw an exception

Throws:

IOException

SMTPException

sendAndCheck

public SMTPClient.Response sendAndCheck(String msg)
                                 throws IOException,
                                        SMTPException

If response is not success, throw an exception

Throws:

IOException

SMTPException

close

public void close()

Logs but otherwise ignores errors

Specified by:

close in interface AutoCloseable

toString

public String toString()

Overrides:

toString in class Object

getLocalSocketAddress

public SocketAddress getLocalSocketAddress()

Returns the local socket address.

getHostPort

public String getHostPort()

Returns:

a nice pretty description of who we are connected to