ORO, Inc. Logo  All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.oroinc.net.pop3.POP3

java.lang.Object
   |
   +----com.oroinc.net.SocketClient
           |
           +----com.oroinc.net.pop3.POP3

public class POP3
extends SocketClient
The POP3 class is not meant to be used by itself and is provided only so that you may easily implement your own POP3 client if you so desire. If you have no need to perform your own implementation, you should use POP3Client.

Rather than list it separately for each method, we mention here that every method communicating with the server and throwing an IOException can also throw a MalformedServerReplyException , which is a subclass of IOException. A MalformedServerReplyException will be thrown when the reply received from the server deviates enough from the protocol specification that it cannot be interpreted in a useful manner despite attempts to be as lenient as possible.

Copyright © 1997 Original Reusable Objects, Inc. All rights reserved.

See Also:
POP3Client, MalformedServerReplyException

Variable Index

 o _commandSupport_
A ProtocolCommandSupport object used to manage the registering of ProtocolCommandListeners and te firing of ProtocolCommandEvents.
 o AUTHORIZATION_STATE
A constant representing the POP3 authorization state.
 o DEFAULT_PORT
The default POP3 port.
 o DISCONNECTED_STATE
A constant representing the state where the client is not yet connected to a POP3 server.
 o TRANSACTION_STATE
A constant representing the POP3 transaction state.
 o UPDATE_STATE
A constant representing the POP3 update state.

Constructor Index

 o POP3()
The default POP3Client constructor.

Method Index

 o _connectAction_()
Performs connection initialization and sets state to AUTHORIZATION_STATE .
 o addProtocolCommandListener(ProtocolCommandListener)
Adds a ProtocolCommandListener.
 o disconnect()
Disconnects the client from the server, and sets the state to DISCONNECTED_STATE .
 o getAdditionalReply()
Retrieves the additional lines of a multi-line server reply.
 o getReplyString()
Returns the reply to the last command sent to the server.
 o getReplyStrings()
Returns an array of lines received as a reply to the last command sent to the server.
 o getState()
Returns the current POP3 client state.
 o removeProtocolCommandistener(ProtocolCommandListener)
Removes a ProtocolCommandListener.
 o sendCommand(int)
Sends a command with no arguments to the server and returns the reply code.
 o sendCommand(int, String)
Sends a command an arguments to the server and returns the reply code.
 o sendCommand(String)
Sends a command with no arguments to the server and returns the reply code.
 o sendCommand(String, String)
Sends a command an arguments to the server and returns the reply code.
 o setState(int)
Sets POP3 client state.

Variables

 o DEFAULT_PORT
 public static final int DEFAULT_PORT
The default POP3 port. Set to 110 according to RFC 1288.

 o DISCONNECTED_STATE
 public static final int DISCONNECTED_STATE
A constant representing the state where the client is not yet connected to a POP3 server.

 o AUTHORIZATION_STATE
 public static final int AUTHORIZATION_STATE
A constant representing the POP3 authorization state.

 o TRANSACTION_STATE
 public static final int TRANSACTION_STATE
A constant representing the POP3 transaction state.

 o UPDATE_STATE
 public static final int UPDATE_STATE
A constant representing the POP3 update state.

 o _commandSupport_
 protected ProtocolCommandSupport _commandSupport_
A ProtocolCommandSupport object used to manage the registering of ProtocolCommandListeners and te firing of ProtocolCommandEvents.

Constructors

 o POP3
 public POP3()
The default POP3Client constructor. Initializes the state to DISCONNECTED_STATE.

Methods

 o _connectAction_
 protected void _connectAction_() throws IOException
Performs connection initialization and sets state to AUTHORIZATION_STATE .

Overrides:
_connectAction_ in class SocketClient
 o addProtocolCommandListener
 public void addProtocolCommandListener(ProtocolCommandListener listener)
Adds a ProtocolCommandListener. Delegates this task to _commandSupport_ .

Parameters:
listener - The ProtocolCommandListener to add.
 o removeProtocolCommandistener
 public void removeProtocolCommandistener(ProtocolCommandListener listener)
Removes a ProtocolCommandListener. Delegates this task to _commandSupport_ .

Parameters:
listener - The ProtocolCommandListener to remove.
 o setState
 public void setState(int state)
Sets POP3 client state. This must be one of the _STATE constants.

Parameters:
state - The new state.
 o getState
 public int getState()
Returns the current POP3 client state.

Returns:
The current POP3 client state.
 o getAdditionalReply
 public void getAdditionalReply() throws IOException
Retrieves the additional lines of a multi-line server reply.

 o disconnect
 public void disconnect() throws IOException
Disconnects the client from the server, and sets the state to DISCONNECTED_STATE . The reply text information from the last issued command is voided to allow garbage collection of the memory used to store that information.

Throws: IOException
If there is an error in disconnecting.
Overrides:
disconnect in class SocketClient
 o sendCommand
 public int sendCommand(String command,
                        String args) throws IOException
Sends a command an arguments to the server and returns the reply code.

Parameters:
command - The POP3 command to send.
args - The command arguments.
Returns:
The server reply code (either POP3Reply.OK or POP3Reply.ERROR).
 o sendCommand
 public int sendCommand(String command) throws IOException
Sends a command with no arguments to the server and returns the reply code.

Parameters:
command - The POP3 command to send.
Returns:
The server reply code (either POP3Reply.OK or POP3Reply.ERROR).
 o sendCommand
 public int sendCommand(int command,
                        String args) throws IOException
Sends a command an arguments to the server and returns the reply code.

Parameters:
command - The POP3 command to send (one of the POP3Command constants).
args - The command arguments.
Returns:
The server reply code (either POP3Reply.OK or POP3Reply.ERROR).
 o sendCommand
 public int sendCommand(int command) throws IOException
Sends a command with no arguments to the server and returns the reply code.

Parameters:
command - The POP3 command to send (one of the POP3Command constants).
Returns:
The server reply code (either POP3Reply.OK or POP3Reply.ERROR).
 o getReplyStrings
 public String[] getReplyStrings()
Returns an array of lines received as a reply to the last command sent to the server. The lines have end of lines truncated. If the reply is a single line, but its format ndicates it should be a multiline reply, then you must call getAdditionalReply() to fetch the rest of the reply, and then call getReplyStrings again. You only have to worry about this if you are implementing your own client using the sendCommand methods.

Returns:
The last server response.
 o getReplyString
 public String getReplyString()
Returns the reply to the last command sent to the server. The value is a single string containing all the reply lines including newlines. If the reply is a single line, but its format ndicates it should be a multiline reply, then you must call getAdditionalReply() to fetch the rest of the reply, and then call getReplyString again. You only have to worry about this if you are implementing your own client using the sendCommand methods.

Returns:
The last server response.

ORO, Inc. Logo  All Packages  Class Hierarchy  This Package  Previous  Next  Index