Class SMTPConnection

protected static final int AMBIGUOUS

Field Value:

553

protected static final String AUTH

Field Value:

""

protected static final String DATA

Field Value:

""

public static final int DEFAULT_PORT

The default SMTP port.

Field Value:

25

protected static final String EHLO

Field Value:

""

protected static final String EXPN

Field Value:

""

protected static final String FINISH_DATA

Field Value:

"\n"

protected static final String HELO

Field Value:

""

protected static final String HELP

Field Value:

""

protected static final int INFO

Field Value:

214

protected static final String MAIL_FROM

Field Value:

""

protected static final String NOOP

Field Value:

""

protected static final int OK

Field Value:

250

protected static final int OK_NOT_LOCAL

Field Value:

251

protected static final int OK_UNVERIFIED

Field Value:

252

protected static final String QUIT

Field Value:

""

protected static final String RCPT_TO

Field Value:

""

protected static final int READY

Field Value:

220

protected static final String RSET

Field Value:

""

protected static final int SEND_DATA

Field Value:

354

protected static final String SP

Field Value:

""

protected static final String STARTTLS

Field Value:

""

protected static final String VRFY

Field Value:

""

protected boolean continuation

If true, there are more responses to read.

protected boolean debug

If true, log events.

protected final String greeting

The greeting message given by the server.

protected LineInputStream in

The input stream used to read responses from the server.

protected CRLFOutputStream out

The output stream used to send commands to the server.

protected String response

The last response message received from the server.

protected Socket socket

The underlying socket used for communicating with the server.

public SMTPConnection(String host)
            throws IOException

Creates a new connection to the specified host, using the default SMTP port.

Parameters:

host - the server hostname

public SMTPConnection(String host,
                      int port)
            throws IOException

Creates a new connection to the specified host, using the specified port.

Parameters:

host - the server hostname

port - the port to connect to

public SMTPConnection(String host,
                      int port,
                      int connectionTimeout,
                      int timeout,
                      boolean debug)
            throws IOException

Creates a new connection to the specified host, using the specified port.

Parameters:

host - the server hostname

port - the port to connect to

connectionTimeout - the connection timeout in milliseconds

timeout - the I/O timeout in milliseconds

debug - whether to log progress

public boolean authenticate(String mechanism,
                            String username,
                            String password)
            throws IOException

Authenticates the connection using the specified SASL mechanism, username, and password.

Parameters:

mechanism - a SASL authentication mechanism, e.g. LOGIN, PLAIN, CRAM-MD5, GSSAPI

username - the authentication principal

password - the authentication credentials

Returns:

true if authentication was successful, false otherwise

public OutputStream data()
            throws IOException

Requests an output stream to write message data to. When the entire message has been written to the stream, the flush method must be called on the stream. Until then no further methods should be called on the connection. Immediately after this procedure is complete, finishData must be called to complete the transfer and determine its success.

Returns:

a stream for writing messages to

public List ehlo(String hostname)
            throws IOException

Issues an EHLO command. If successful, returns a list of the SMTP extensions supported by the server. Otherwise returns null, and HELO should be called.

Parameters:

hostname - the local host name

public List expn(String address)
            throws IOException

Returns a list of valid possibilities for the specified mailing list, or null on failure.

Parameters:

address - a mailing list name

public boolean finishData()
            throws IOException

Completes the DATA procedure.

Returns:

true id transfer was successful, false otherwise

See Also:

data()

protected int getAllResponses()
            throws IOException

Returns the next response from the server. If the response is a continuation, continues to read responses until continuation ceases. If a different response code from the first is encountered, this causes a protocol exception.

public String getGreeting()

Returns the server greeting message.

public String getLastResponse()

Returns the text of the last response received from the server.

protected int getResponse()
            throws IOException

Returns the next response from the server.

public boolean helo(String hostname)
            throws IOException

Issues a HELO command.

Parameters:

hostname - the local host name

public List help(String arg)
            throws IOException

Returns some useful information about the specified parameter. Typically this is a command.

Parameters:

arg - the context of the query, or null for general information

Returns:

a list of possibly useful information, or null if the command failed.

public boolean mailFrom(String reversePath,
                        ParameterList parameters)
            throws IOException

Execute a MAIL command.

Parameters:

reversePath - the source mailbox(from address)

parameters - optional ESMTP parameters

Returns:

true if accepted, false otherwise

public void noop()
            throws IOException

Issues a NOOP command. This does nothing, but can be used to keep the connection alive.

public void quit()
            throws IOException

Close the connection to the server.

public boolean rcptTo(String forwardPath,
                      ParameterList parameters)
            throws IOException

Execute a RCPT command.

Parameters:

forwardPath - the forward-path(recipient address)

parameters - optional ESMTP parameters

Returns:

true if successful, false otherwise

public void rset()
            throws IOException

Aborts the current mail transaction.

protected void send(String command)
            throws IOException

Send the specified command string to the server.

Parameters:

command - the command to send

public boolean starttls()
            throws IOException

Negotiate TLS over the current connection. This depends on many features, such as the JSSE classes being in the classpath. Returns true if successful, false otherwise.

public boolean starttls(TrustManager tm)
            throws IOException

Negotiate TLS over the current connection. This depends on many features, such as the JSSE classes being in the classpath. Returns true if successful, false otherwise.

Parameters:

tm - the custom trust manager to use

public List vrfy(String address)
            throws IOException

Returns a list of valid possibilities for the specified address, or null on failure.

Parameters:

address - a mailbox, or real name and mailbox