SMTPConnection (gnu-classpath-ext-inetlib 1.1.1 API)

java.lang.Object
- gnu.inet.smtp.SMTPConnection

```
public class SMTPConnection
extends Object
```
An SMTP client. This implements RFC 2821.

Author:

Chris Burdess

Field Summary

Fields
Modifier and Type	Field and Description
`protected static int`	`AMBIGUOUS`
`protected static String`	`AUTH`
`protected boolean`	`continuation` If true, there are more responses to read.
`protected static String`	`DATA`
`static int`	`DEFAULT_PORT` The default SMTP port.
`protected static String`	`EHLO`
`protected static String`	`EXPN`
`protected static String`	`FINISH_DATA`
`protected String`	`greeting` The greeting message given by the server.
`protected static String`	`HELO`
`protected static String`	`HELP`
`protected LineInputStream`	`in` The input stream used to read responses from the server.
`protected static int`	`INFO`
`static Logger`	`logger` The logger used for SMTP protocol traces.
`protected static String`	`MAIL_FROM`
`protected static String`	`NOOP`
`protected static int`	`OK`
`protected static int`	`OK_NOT_LOCAL`
`protected static int`	`OK_UNVERIFIED`
`protected CRLFOutputStream`	`out` The output stream used to send commands to the server.
`protected static String`	`QUIT`
`protected static String`	`RCPT_TO`
`protected static int`	`READY`
`protected String`	`response` The last response message received from the server.
`protected static String`	`RSET`
`protected static int`	`SEND_DATA`
`static Level`	`SMTP_TRACE` The network trace level.
`protected Socket`	`socket` The underlying socket used for communicating with the server.
`protected static String`	`SP`
`protected static String`	`STARTTLS`
`protected static String`	`VRFY`

Constructor Summary

Constructors
Constructor and Description
`SMTPConnection(String host)` Creates a new connection to the specified host, using the default SMTP port.
`SMTPConnection(String host, int port)` Creates a new connection to the specified host, using the specified port.
`SMTPConnection(String host, int port, int connectionTimeout, int timeout)` Creates a new connection to the specified host, using the specified port.
`SMTPConnection(String host, int port, int connectionTimeout, int timeout, boolean secure, TrustManager tm)` Creates a new connection to the specified host, using the specified port.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`authenticate(String mechanism, String username, String password)` Authenticates the connection using the specified SASL mechanism, username, and password.
`OutputStream`	`data()` Requests an output stream to write message data to.
`List`	`ehlo(String hostname)` Issues an EHLO command.
`List`	`expn(String address)` Returns a list of valid possibilities for the specified mailing list, or null on failure.
`boolean`	`finishData()` Completes the DATA procedure.
`protected int`	`getAllResponses()` Returns the next response from the server.
`String`	`getGreeting()` Returns the server greeting message.
`String`	`getLastResponse()` Returns the text of the last response received from the server.
`protected int`	`getResponse()` Returns the next response from the server.
`protected SSLSocketFactory`	`getSSLSocketFactory(TrustManager tm)` Returns a configured SSLSocketFactory to use in creating new SSL sockets.
`boolean`	`helo(String hostname)` Issues a HELO command.
`List`	`help(String arg)` Returns some useful information about the specified parameter.
`boolean`	`mailFrom(String reversePath, ParameterList parameters)` Execute a MAIL command.
`void`	`noop()` Issues a NOOP command.
`void`	`quit()` Close the connection to the server.
`boolean`	`rcptTo(String forwardPath, ParameterList parameters)` Execute a RCPT command.
`void`	`rset()` Aborts the current mail transaction.
`protected void`	`send(String command)` Send the specified command string to the server.
`boolean`	`starttls()` Negotiate TLS over the current connection.
`boolean`	`starttls(TrustManager tm)` Negotiate TLS over the current connection.
`List`	`vrfy(String address)` Returns a list of valid possibilities for the specified address, or null on failure.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - logger
```
public static final Logger logger
```
    The logger used for SMTP protocol traces.
  - SMTP_TRACE
```
public static final Level SMTP_TRACE
```
    The network trace level.
  - DEFAULT_PORT
```
public static final int DEFAULT_PORT
```
    The default SMTP port.
    
    See Also:
    
    Constant Field Values
  - MAIL_FROM
```
protected static final String MAIL_FROM
```
    See Also:
    
    Constant Field Values
  - RCPT_TO
```
protected static final String RCPT_TO
```
    See Also:
    
    Constant Field Values
  - SP
```
protected static final String SP
```
    See Also:
    
    Constant Field Values
  - DATA
```
protected static final String DATA
```
    See Also:
    
    Constant Field Values
  - FINISH_DATA
```
protected static final String FINISH_DATA
```
    See Also:
    
    Constant Field Values
  - RSET
```
protected static final String RSET
```
    See Also:
    
    Constant Field Values
  - VRFY
```
protected static final String VRFY
```
    See Also:
    
    Constant Field Values
  - EXPN
```
protected static final String EXPN
```
    See Also:
    
    Constant Field Values
  - HELP
```
protected static final String HELP
```
    See Also:
    
    Constant Field Values
  - NOOP
```
protected static final String NOOP
```
    See Also:
    
    Constant Field Values
  - QUIT
```
protected static final String QUIT
```
    See Also:
    
    Constant Field Values
  - HELO
```
protected static final String HELO
```
    See Also:
    
    Constant Field Values
  - EHLO
```
protected static final String EHLO
```
    See Also:
    
    Constant Field Values
  - AUTH
```
protected static final String AUTH
```
    See Also:
    
    Constant Field Values
  - STARTTLS
```
protected static final String STARTTLS
```
    See Also:
    
    Constant Field Values
  - INFO
```
protected static final int INFO
```
    See Also:
    
    Constant Field Values
  - READY
```
protected static final int READY
```
    See Also:
    
    Constant Field Values
  - OK
```
protected static final int OK
```
    See Also:
    
    Constant Field Values
  - OK_NOT_LOCAL
```
protected static final int OK_NOT_LOCAL
```
    See Also:
    
    Constant Field Values
  - OK_UNVERIFIED
```
protected static final int OK_UNVERIFIED
```
    See Also:
    
    Constant Field Values
  - SEND_DATA
```
protected static final int SEND_DATA
```
    See Also:
    
    Constant Field Values
  - AMBIGUOUS
```
protected static final int AMBIGUOUS
```
    See Also:
    
    Constant Field Values
  - socket
```
protected Socket socket
```
    The underlying socket used for communicating with the server.
  - in
```
protected LineInputStream in
```
    The input stream used to read responses from the server.
  - out
```
protected CRLFOutputStream out
```
    The output stream used to send commands to the server.
  - response
```
protected String response
```
    The last response message received from the server.
  - continuation
```
protected boolean continuation
```
    If true, there are more responses to read.
  - greeting
```
protected final String greeting
```
    The greeting message given by the server.
- Constructor Detail
  - SMTPConnection
```
public SMTPConnection(String host)
               throws IOException
```
    Creates a new connection to the specified host, using the default SMTP port.
    
    Parameters:
    
    host - the server hostname
    
    Throws:
    
    IOException
  - SMTPConnection
```
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
    
    Throws:
    
    IOException
  - SMTPConnection
```
public SMTPConnection(String host,
                      int port,
                      int connectionTimeout,
                      int timeout)
               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
    
    Throws:
    
    IOException
  - SMTPConnection
```
public SMTPConnection(String host,
                      int port,
                      int connectionTimeout,
                      int timeout,
                      boolean secure,
                      TrustManager tm)
               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
    
    secure - true to create an SMTPS connection
    
    tm - a trust manager used to check SSL certificates, or null to use the default
    
    Throws:
    
    IOException
- Method Detail
  - getGreeting
```
public String getGreeting()
```
    Returns the server greeting message.
  - getLastResponse
```
public String getLastResponse()
```
    Returns the text of the last response received from the server.
  - mailFrom
```
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
    
    Throws:
    
    IOException
  - rcptTo
```
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
    
    Throws:
    
    IOException
  - data
```
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
    
    Throws:
    
    IOException
  - finishData
```
public boolean finishData()
                   throws IOException
```
    Completes the DATA procedure.
    
    Returns:
    
    true id transfer was successful, false otherwise
    
    Throws:
    
    IOException
    
    See Also:
    
    data()
  - rset
```
public void rset()
          throws IOException
```
    Aborts the current mail transaction.
    
    Throws:
    
    IOException
  - vrfy
```
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
    
    Throws:
    
    IOException
  - expn
```
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
    
    Throws:
    
    IOException
  - help
```
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.
    
    Throws:
    
    IOException
  - noop
```
public void noop()
          throws IOException
```
    Issues a NOOP command. This does nothing, but can be used to keep the connection alive.
    
    Throws:
    
    IOException
  - quit
```
public void quit()
          throws IOException
```
    Close the connection to the server.
    
    Throws:
    
    IOException
  - helo
```
public boolean helo(String hostname)
             throws IOException
```
    Issues a HELO command.
    
    Parameters:
    
    hostname - the local host name
    
    Throws:
    
    IOException
  - ehlo
```
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
    
    Throws:
    
    IOException
  - getSSLSocketFactory
```
protected SSLSocketFactory getSSLSocketFactory(TrustManager tm)
                                        throws GeneralSecurityException
```
    Returns a configured SSLSocketFactory to use in creating new SSL sockets.
    
    Parameters:
    
    tm - an optional trust manager to use
    
    Throws:
    
    GeneralSecurityException
  - starttls
```
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.
    
    Throws:
    
    IOException
  - starttls
```
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
    
    Throws:
    
    IOException
  - authenticate
```
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
    
    Throws:
    
    IOException
  - send
```
protected void send(String command)
             throws IOException
```
    Send the specified command string to the server.
    
    Parameters:
    
    command - the command to send
    
    Throws:
    
    IOException
  - getResponse
```
protected int getResponse()
                   throws IOException
```
    Returns the next response from the server.
    
    Throws:
    
    IOException
  - getAllResponses
```
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.
    
    Throws:
    
    IOException

Class SMTPConnection

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

logger

SMTP_TRACE

DEFAULT_PORT

MAIL_FROM

RCPT_TO

SP

DATA

FINISH_DATA

RSET

VRFY

EXPN

HELP

NOOP

QUIT

HELO

EHLO

AUTH

STARTTLS

INFO

READY

OK

OK_NOT_LOCAL

OK_UNVERIFIED

SEND_DATA

AMBIGUOUS

socket

in

out

response

continuation

greeting

Constructor Detail

SMTPConnection

SMTPConnection

SMTPConnection

SMTPConnection

Method Detail

getGreeting

getLastResponse

mailFrom

rcptTo

data

finishData

rset

vrfy

expn

help

noop

quit

helo

ehlo

getSSLSocketFactory

starttls

starttls

authenticate

send

getResponse

getAllResponses