org.columba.ristretto.smtp

Class SMTPProtocol

java.lang.Object

org.columba.ristretto.smtp.SMTPProtocol

All Implemented Interfaces:

java.lang.AutoCloseable, AuthenticationServer

public class SMTPProtocol
extends java.lang.Object
implements AuthenticationServer, java.lang.AutoCloseable

Implementation of the client side SMTP protocol.

Author:

Timo Stich

Field Summary

Fields

Modifier and Type	Field and Description
static int	AUTHORIZED Protocol state.
static int	CC Address type.
protected SMTPInputStream	in
static int	NOT_CONNECTED Protocol state.
protected java.io.OutputStream	out
static int	PLAIN Protocol state.
static int	TO Address type.

Constructor Summary

Constructors

Constructor and Description
SMTPProtocol(java.lang.String host) Constructs the SMTPProtocol.
SMTPProtocol(java.lang.String host, int port) Constructs the SMTPProtocol.

Method Summary

Modifier and Type	Method and Description
void	auth(java.lang.String algorithm, java.lang.String user, char[] password) Authenticates a user.
byte[]	authReceive() Receives the reponse of the server.
void	authSend(byte[] call) Sends the specified call of the SASL client to the server.
void	close()
SMTPResponse	data(java.io.InputStream data) Sends a DATA command which sends the mail to the recipients specified by the RCPT command.
void	dropConnection() Drops the connection.
java.lang.String[]	ehlo(java.net.InetAddress domain) Sends the EHLO command to the server.
Address[]	expand(Address mailinglist) Expands a given mailinglist address to all members of that list.
java.lang.String	getHostName() Gets the hostname of the server.
java.lang.String	getService() Gets the service that is provided by the server.
int	getState()
void	helo(java.net.InetAddress domain) Sends the HELO command to the SMTP server.
void	mail(Address from) Sends a MAIL command which specifies the sender's email address and starts a new mail.
void	noop() Sends a NOOP command to the server.
java.lang.String	openPort() Opens the connection to the SMTP server.
void	quit() Sends the QUIT command and closes the socket.
void	rcpt(Address address) Sends a RCPT TO: command which specifies a recipient of the mail started by the MAIL command.
void	rcpt(int type, Address address) Sends a RCPT command which specifies a recipient of the mail started by the MAIL command.
void	rcptWithDeliveryReport(Address address) Sends a RCPT TO: NOTIFY=SUCCESS command which specifies a recipient of the mail started by the MAIL command.
protected SMTPResponse	readSingleLineResponse()
void	reset() Sends a RSET command which resets the current session.
protected void	sendCommand(java.lang.String command, java.lang.String[] parameters)
void	startTLS() Switches to a SSL connection using the TLS extension.
void	verify(java.lang.String address) Sends a VRFY command which verifies the given email address.

Methods inherited from class java.lang.Object

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

Field Detail

NOT_CONNECTED

public static final int NOT_CONNECTED

Protocol state.

See Also:

Constant Field Values

PLAIN

public static final int PLAIN

Protocol state.

See Also:

Constant Field Values

AUTHORIZED

public static final int AUTHORIZED

Protocol state.

See Also:

Constant Field Values

TO

public static final int TO

Address type.

See Also:

Constant Field Values

CC

public static final int CC

Address type.

See Also:

Constant Field Values

in

protected SMTPInputStream in

out

protected java.io.OutputStream out

Constructor Detail

SMTPProtocol

public SMTPProtocol(java.lang.String host,
                    int port)

Constructs the SMTPProtocol.

Parameters:

host - the sever name to connect to

port - the port to connect to

SMTPProtocol

public SMTPProtocol(java.lang.String host)

Constructs the SMTPProtocol. Uses the default port 25 to connect to the server.

Parameters:

host - the sever name to connect to

Method Detail

openPort

public java.lang.String openPort()
                          throws java.io.IOException,
                                 SMTPException

Opens the connection to the SMTP server.

Returns:

the domain name of the server

Throws:

java.io.IOException

SMTPException

startTLS

public void startTLS()
              throws java.io.IOException,
                     javax.net.ssl.SSLException,
                     SMTPException

Switches to a SSL connection using the TLS extension.

Throws:

java.io.IOException

javax.net.ssl.SSLException

SMTPException

sendCommand

protected void sendCommand(java.lang.String command,
                           java.lang.String[] parameters)
                    throws java.io.IOException

Throws:

java.io.IOException

ehlo

public java.lang.String[] ehlo(java.net.InetAddress domain)
                        throws java.io.IOException,
                               SMTPException

Sends the EHLO command to the server. This command can be used to fetch the capabilities of the server.
Note: Only ESMTP servers understand this comand.

Parameters:

domain - the domain name of the client

Returns:

the capabilities of the server

Throws:

java.io.IOException

SMTPException

See Also:

helo(InetAddress)

helo

public void helo(java.net.InetAddress domain)
          throws java.io.IOException,
                 SMTPException

Sends the HELO command to the SMTP server. Needed only for non ESMTP servers. Use #ehlo(InetAddress) instead.

Parameters:

domain -

Throws:

java.io.IOException

SMTPException

See Also:

ehlo(InetAddress)

auth

public void auth(java.lang.String algorithm,
                 java.lang.String user,
                 char[] password)
          throws java.io.IOException,
                 SMTPException,
                 AuthenticationException

Authenticates a user. This is done with the Authentication mechanisms provided by the

Parameters:

algorithm -

algorithm - the algorithm used to authenticate the user (e.g. PLAIN, DIGEST-MD5)

user - the user name

password - the password

Throws:

java.io.IOException

SMTPException

AuthenticationException

mail

public void mail(Address from)
          throws java.io.IOException,
                 SMTPException

Sends a MAIL command which specifies the sender's email address and starts a new mail.

Parameters:

from - the email address of the sender

Throws:

java.io.IOException

SMTPException

See Also:

rcpt(Address), data(InputStream)

rcpt

public void rcpt(Address address)
          throws java.io.IOException,
                 SMTPException

Sends a RCPT TO: command which specifies a recipient of the mail started by the MAIL command. This command can be called repeatedly to add more recipients.

Parameters:

address - the email address of a recipient.

Throws:

java.io.IOException

SMTPException

See Also:

mail(Address), data(InputStream)

rcptWithDeliveryReport

public void rcptWithDeliveryReport(Address address)
                            throws java.io.IOException,
                                   SMTPException

Sends a RCPT TO: NOTIFY=SUCCESS command which specifies a recipient of the mail started by the MAIL command. This command can be called repeatedly to add more recipients.

Parameters:

address - the email address of a recipient.

Throws:

java.io.IOException

SMTPException

See Also:

mail(Address), data(InputStream)

rcpt

public void rcpt(int type,
                 Address address)
          throws java.io.IOException,
                 SMTPException

Sends a RCPT command which specifies a recipient of the mail started by the MAIL command. This command can be called repeatedly to add more recipients. You can pass the type parameter to either send a RCPT TO or CC.

Parameters:

type -

address - the email address of a recipient.

Throws:

java.io.IOException

SMTPException

See Also:

mail(Address), data(InputStream), TO, CC

data

public SMTPResponse data(java.io.InputStream data)
                  throws java.io.IOException,
                         SMTPException

Sends a DATA command which sends the mail to the recipients specified by the RCPT command. Can be cancelled with #dropConnection().

Parameters:

data - the mail

Returns:

SMTP response on success

Throws:

java.io.IOException

SMTPException

See Also:

mail(Address), rcpt(Address)

quit

public void quit()
          throws java.lang.Exception

Sends the QUIT command and closes the socket.

Throws:

java.lang.Exception

reset

public void reset()
           throws java.io.IOException,
                  SMTPException

Sends a RSET command which resets the current session.

Throws:

java.io.IOException

SMTPException

verify

public void verify(java.lang.String address)
            throws java.io.IOException,
                   SMTPException

Sends a VRFY command which verifies the given email address.

Parameters:

address - email address to verify

Throws:

java.io.IOException

SMTPException

expand

public Address[] expand(Address mailinglist)
                 throws java.io.IOException,
                        SMTPException

Expands a given mailinglist address to all members of that list.

Parameters:

mailinglist - the mailinglist address

Returns:

the members of the mailinglist

Throws:

java.io.IOException

SMTPException

noop

public void noop()
          throws java.io.IOException,
                 SMTPException

Sends a NOOP command to the server.

Throws:

java.io.IOException

SMTPException

authReceive

public byte[] authReceive()
                   throws AuthenticationException,
                          java.io.IOException

Description copied from interface: AuthenticationServer

Receives the reponse of the server.

Specified by:

authReceive in interface AuthenticationServer

Returns:

the response of the server.

Throws:

AuthenticationException

java.io.IOException

See Also:

AuthenticationServer.authReceive()

authSend

public void authSend(byte[] call)
              throws java.io.IOException

Description copied from interface: AuthenticationServer

Sends the specified call of the SASL client to the server.

Specified by:

authSend in interface AuthenticationServer

Parameters:

call - the call of the client to the server

Throws:

java.io.IOException

See Also:

AuthenticationServer.authSend(byte[])

getState

public int getState()

Returns:

Returns the state.

getHostName

public java.lang.String getHostName()

Description copied from interface: AuthenticationServer

Gets the hostname of the server. This is for example sasl.example.com.

Specified by:

getHostName in interface AuthenticationServer

Returns:

the hostname of the server

See Also:

AuthenticationServer.getHostName()

getService

public java.lang.String getService()

Description copied from interface: AuthenticationServer

Gets the service that is provided by the server. An example is "pop3" or "imap".

Specified by:

getService in interface AuthenticationServer

Returns:

the service provided by the server

See Also:

AuthenticationServer.getService()

dropConnection

public void dropConnection()
                    throws java.lang.Exception

Drops the connection.

Throws:

java.lang.Exception

readSingleLineResponse

protected SMTPResponse readSingleLineResponse()
                                       throws java.io.IOException,
                                              SMTPException

Throws:

java.io.IOException

SMTPException

close

public void close()
           throws java.lang.Exception

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.lang.Exception