org.subethamail.smtp.client

Class SmartClient

java.lang.Object

org.subethamail.smtp.client.SMTPClient

org.subethamail.smtp.client.SmartClient

public class SmartClient
extends SMTPClient

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

Author:

Jeff Schnitzer

Nested Class Summary

Nested classes/interfaces inherited from class org.subethamail.smtp.client.SMTPClient

SMTPClient.Response

Constructor Summary

Constructors

Constructor and Description
SmartClient() Creates an unconnected client.
SmartClient(java.lang.String host, int port, java.net.SocketAddress bindpoint, java.lang.String myHost) Connects to the specified server and issues the initial HELO command.
SmartClient(java.lang.String host, int port, java.lang.String myHost) Connects to the specified server and issues the initial HELO command.

Method Summary

Modifier and Type	Method and Description
void	connect(java.lang.String host, int port) Connects to the specified server and issues the initial HELO command.
void	dataEnd() Last step after writing data
void	dataStart() Prelude to writing data
void	dataWrite(byte[] data, int numBytes) Actually write some data
void	from(java.lang.String from)
java.lang.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.
boolean	sentFrom()
boolean	sentTo()
void	setHeloHost(java.lang.String myHost) Sets the domain name or address literal of this system, which name will be sent to the server in the parameter of the HELO and EHLO commands.
void	to(java.lang.String to)

Methods inherited from class org.subethamail.smtp.client.SMTPClient

close, createSocket, getBindpoint, getHostPort, receiveAndCheck, send, sendAndCheck, sendReceive, setBindpoint, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SmartClient

public SmartClient()

Creates an unconnected client.

SmartClient

public SmartClient(java.lang.String host,
                   int port,
                   java.lang.String myHost)
            throws java.net.UnknownHostException,
                   java.io.IOException,
                   SMTPException

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

Throws:

java.net.UnknownHostException - if problem looking up hostname

SMTPException - if problem reported by the server

java.io.IOException - if problem communicating with host

SmartClient

public SmartClient(java.lang.String host,
                   int port,
                   java.net.SocketAddress bindpoint,
                   java.lang.String myHost)
            throws java.net.UnknownHostException,
                   java.io.IOException,
                   SMTPException

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

Throws:

java.net.UnknownHostException - if problem looking up hostname

SMTPException - if problem reported by the server

java.io.IOException - if problem communicating with host

Method Detail

connect

public void connect(java.lang.String host,
                    int port)
             throws java.io.IOException,
                    SMTPException

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.

Overrides:

connect in class SMTPClient

Throws:

java.io.IOException - if there is a problem connecting to the port

SMTPException

receive

protected SMTPClient.Response receive()
                               throws java.io.IOException

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

Overrides:

receive in class SMTPClient

Throws:

java.io.IOException

from

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

Throws:

java.io.IOException

SMTPException

to

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

Throws:

java.io.IOException

SMTPException

dataStart

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

Prelude to writing data

Throws:

java.io.IOException

SMTPException

dataWrite

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

Actually write some data

Throws:

java.io.IOException

dataEnd

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

Last step after writing data

Throws:

java.io.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

sentFrom

public boolean sentFrom()

Returns:

true if we have already specified from()

sentTo

public boolean sentTo()

Returns:

true if we have already specified to()

getRecipientCount

public int getRecipientCount()

Returns:

the number of recipients that have been accepted by the server

setHeloHost

public void setHeloHost(java.lang.String myHost)

Sets the domain name or address literal of this system, which name will be sent to the server in the parameter of the HELO and EHLO commands. This has no default and is required.

getHeloHost

public java.lang.String getHeloHost()

Returns the HELO name of this system.