org.subethamail.smtp.client

Class SmartClient

java.lang.Object

org.subethamail.smtp.client.SmartClient

public class SmartClient
extends Object

A somewhat smarter abstraction of an SMTP client which doesn't require knowing anything about the nitty gritty of SMTP.

Author:

Jeff Schnitzer

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SmartClient(SMTPClient client, String clientHeloHost, Optional<Authenticator> authenticator) Constructor.

Method Summary

Modifier and Type	Method and Description
void	bdat(String text)
void	bdat(String text, boolean isLast)
void	bdatLast(String text)
void	connect(String host, int port) Connects to the specified server and issues the initial HELO command.
static SmartClient	createAndConnect(String host, int port, Optional<SocketAddress> bindpoint, String clientHeloHost, Optional<Authenticator> authenticator)
static SmartClient	createAndConnect(String host, int port, String clientHeloHost)
void	dataEnd() Last step after writing data
void	dataStart() Prelude to writing data
void	dataWrite(byte[] data)
void	dataWrite(byte[] data, int numBytes) Actually write some data
void	from(String from)
Optional<Authenticator>	getAuthenticator() Returns the Authenticator object, which is used to authenticate this client to the server, or null, if no authentication is required.
Map<String,String>	getExtensions() Returns the SMTP extensions supported by the server.
String	getHeloHost() Returns the HELO name of this system.
int	getRecipientCount()
void	quit() Quit and close down the connection.
protected SMTPClient.Response	receive() Returns the server response.
void	sendAndCheck(String msg)
protected void	sendHeloOrEhlo() Sends the EHLO command, or HELO if EHLO is not supported, and saves the list of SMTP extensions which are supported by the server.
void	to(String to)

Methods inherited from class java.lang.Object

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

Constructor Detail

SmartClient

protected SmartClient(SMTPClient client,
                      String clientHeloHost,
                      Optional<Authenticator> authenticator)

Constructor.

Parameters:

client -

clientHeloHost -

authenticator - the Authenticator object which will be called after the EHLO command to authenticate this client to the server. If is null then no authentication will happen.

Method Detail

createAndConnect

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

Throws:

UnknownHostException

SMTPException

IOException

createAndConnect

public static final SmartClient createAndConnect(String host,
                                                 int port,
                                                 Optional<SocketAddress> bindpoint,
                                                 String clientHeloHost,
                                                 Optional<Authenticator> authenticator)
                                          throws UnknownHostException,
                                                 SMTPException,
                                                 IOException

Throws:

UnknownHostException

SMTPException

IOException

connect

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

Connects to the specified server and issues the initial HELO command. It gracefully closes the connection if it could be established but subsequently it fails or if the server does not accept messages.

Throws:

SMTPException

AuthenticationNotSupportedException

IOException

sendHeloOrEhlo

protected void sendHeloOrEhlo()
                       throws IOException,
                              SMTPException

Sends the EHLO command, or HELO if EHLO is not supported, and saves the list of SMTP extensions which are supported by the server.

Throws:

IOException

SMTPException

receive

protected SMTPClient.Response receive()
                               throws IOException

Returns the server response. It takes note of a 421 response code, so QUIT will not be issued unnecessarily.

Throws:

IOException

from

public void from(String from)
          throws IOException,
                 SMTPException

Throws:

IOException

SMTPException

to

public void to(String to)
        throws IOException,
               SMTPException

Throws:

IOException

SMTPException

dataStart

public void dataStart()
               throws IOException,
                      SMTPException

Prelude to writing data

Throws:

IOException

SMTPException

bdat

public void bdat(String text,
                 boolean isLast)
          throws IOException

Throws:

IOException

bdat

public void bdat(String text)
          throws IOException

Throws:

IOException

bdatLast

public void bdatLast(String text)
              throws IOException

Throws:

IOException

dataWrite

public void dataWrite(byte[] data,
                      int numBytes)
               throws IOException

Actually write some data

Throws:

IOException

dataWrite

public void dataWrite(byte[] data)
               throws IOException

Throws:

IOException

dataEnd

public void dataEnd()
             throws IOException,
                    SMTPException

Last step after writing data

Throws:

IOException

SMTPException

quit

public void quit()

Quit and close down the connection. Ignore any errors.

It still closes the connection, but it does not send the QUIT command if a 421 Service closing transmission channel is received previously. In these cases QUIT would fail anyway.

See Also:

RFC 5321 Terminating Sessions and Connections

getRecipientCount

public int getRecipientCount()

Returns:

the number of recipients that have been accepted by the server

getExtensions

public Map<String,String> getExtensions()

Returns the SMTP extensions supported by the server.

Returns:

the extension map. Key is the extension keyword in upper case, value is the unparsed string of extension parameters.

getHeloHost

public String getHeloHost()

Returns the HELO name of this system.

getAuthenticator

public Optional<Authenticator> getAuthenticator()

Returns the Authenticator object, which is used to authenticate this client to the server, or null, if no authentication is required.

sendAndCheck

public void sendAndCheck(String msg)
                  throws SMTPException,
                         IOException

Throws:

SMTPException

IOException