public class IMAP extends SocketClient
| Modifier and Type | Class and Description |
|---|---|
static class |
IMAP.IMAPState |
| Modifier and Type | Field and Description |
|---|---|
protected static String |
__DEFAULT_ENCODING
The default control socket ecoding.
|
protected BufferedWriter |
__writer |
protected BufferedReader |
_reader |
static int |
DEFAULT_PORT
The default IMAP port (RFC 3501).
|
_defaultPort_, _input_, _output_, _serverSocketFactory_, _socket_, _socketFactory_, _timeout_, connectTimeout, NETASCII_EOL| Constructor and Description |
|---|
IMAP()
The default IMAPClient constructor.
|
| Modifier and Type | Method and Description |
|---|---|
protected void |
_connectAction_()
Performs connection initialization and sets state to
IMAP.IMAPState.NOT_AUTH_STATE. |
void |
disconnect()
Disconnects the client from the server, and sets the state to
DISCONNECTED_STATE . |
boolean |
doCommand(IMAPCommand command)
Sends a command to the server and return whether successful.
|
boolean |
doCommand(IMAPCommand command,
String args)
Sends a command and arguments to the server and return whether successful.
|
protected String |
generateCommandID()
Generates a new command ID (tag) for a command.
|
String |
getReplyString()
Returns the reply to the last command sent to the server.
|
String[] |
getReplyStrings()
Returns an array of lines received as a reply to the last command
sent to the server.
|
IMAP.IMAPState |
getState()
Returns the current IMAP client state.
|
int |
sendCommand(IMAPCommand command)
Sends a command with no arguments to the server and returns the
reply code.
|
int |
sendCommand(IMAPCommand command,
String args)
Sends a command and arguments to the server and returns the reply code.
|
int |
sendCommand(String command)
Sends a command with no arguments to the server and returns the
reply code.
|
int |
sendCommand(String command,
String args)
Sends a command an arguments to the server and returns the reply code.
|
int |
sendData(String command)
Sends data to the server and returns the reply code.
|
protected void |
setState(IMAP.IMAPState state)
Sets IMAP client state.
|
addProtocolCommandListener, connect, connect, connect, connect, connect, connect, createCommandSupport, fireCommandSent, fireReplyReceived, getCharset, getCharsetName, getCommandSupport, getConnectTimeout, getDefaultPort, getDefaultTimeout, getKeepAlive, getLocalAddress, getLocalPort, getProxy, getReceiveBufferSize, getRemoteAddress, getRemotePort, getSendBufferSize, getServerSocketFactory, getSoLinger, getSoTimeout, getTcpNoDelay, isAvailable, isConnected, removeProtocolCommandListener, setCharset, setConnectTimeout, setDefaultPort, setDefaultTimeout, setKeepAlive, setProxy, setReceiveBufferSize, setSendBufferSize, setServerSocketFactory, setSocketFactory, setSoLinger, setSoTimeout, setTcpNoDelay, verifyRemotepublic static final int DEFAULT_PORT
protected static final String __DEFAULT_ENCODING
protected BufferedWriter __writer
protected BufferedReader _reader
public IMAP()
DISCONNECTED_STATE.protected void _connectAction_() throws IOException
IMAP.IMAPState.NOT_AUTH_STATE._connectAction_ in class SocketClientIOExceptionprotected void setState(IMAP.IMAPState state)
_STATE constants.
state - The new state.public IMAP.IMAPState getState()
public void disconnect() throws IOException
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.
disconnect in class SocketClientIOException - If there is an error in disconnecting.public int sendCommand(String command, String args) throws IOException
command - The IMAP command to send.args - The command arguments.IOExceptionpublic int sendCommand(String command) throws IOException
command - The IMAP command to send.IOExceptionpublic int sendCommand(IMAPCommand command, String args) throws IOException
command - The IMAP command to send
(one of the IMAPCommand constants).args - The command arguments.IOExceptionpublic boolean doCommand(IMAPCommand command, String args) throws IOException
command - The IMAP command to send
(one of the IMAPCommand constants).args - The command arguments.true if the command was successfulIOExceptionpublic int sendCommand(IMAPCommand command) throws IOException
command - The IMAP command to send
(one of the IMAPCommand constants).IOExceptionpublic boolean doCommand(IMAPCommand command) throws IOException
command - The IMAP command to send
(one of the IMAPCommand constants).true if the command was successfulIOExceptionpublic int sendData(String command) throws IOException
command - The IMAP command to send.IOExceptionpublic String[] getReplyStrings()
public String getReplyString()
protected String generateCommandID()
Copyright © 2001-2013 The Apache Software Foundation. All Rights Reserved.