Package org.apache.commons.net.imap
Class IMAP
java.lang.Object
org.apache.commons.net.SocketClient
org.apache.commons.net.imap.IMAP
- Direct Known Subclasses:
IMAPClient
The IMAP class provides the basic the functionality necessary to implement your
own IMAP client.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interface
Implement this interface and register it viasetChunkListener(IMAPChunkListener)
in order to get access to multi-line partial command responses.static enum
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate IMAP.IMAPChunkListener
protected static final String
The default control socket ecoding.private IMAP.IMAPState
protected BufferedWriter
private final char[]
protected BufferedReader
private int
static final int
The default IMAP port (RFC 3501).static final IMAP.IMAPChunkListener
Implementation of IMAPChunkListener that returnstrue
but otherwise does nothing.Fields inherited from class org.apache.commons.net.SocketClient
_defaultPort_, _hostname_, _input_, _output_, _serverSocketFactory_, _socket_, _socketFactory_, _timeout_, connectTimeout, NETASCII_EOL
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprivate void
Get the reply for a command that expects a tagged response.private void
__getReply
(boolean wantTag) Get the reply for a command, reading the response until the reply is found.protected void
Performs connection initialization and sets state toIMAP.IMAPState.NOT_AUTH_STATE
.void
Disconnects the client from the server, and sets the state toDISCONNECTED_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 void
fireReplyReceived
(int replyCode, String ignored) OverridesSocketClient.fireReplyReceived(int, String)
so as to avoid creating the reply string if there are no listeners to invoke.protected String
Generates a new command ID (tag) for a command.Returns the reply to the last command sent to the server.String[]
Returns an array of lines received as a reply to the last command sent to the server.getState()
Returns the current IMAP client state.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
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.private int
sendCommandWithID
(String commandID, String command, String args) Sends a command an arguments to the server and returns the reply code.int
Sends data to the server and returns the reply code.void
setChunkListener
(IMAP.IMAPChunkListener listener) Sets the current chunk listener.protected void
setState
(IMAP.IMAPState state) Sets IMAP client state.Methods inherited from class org.apache.commons.net.SocketClient
addProtocolCommandListener, connect, connect, connect, connect, connect, connect, createCommandSupport, fireCommandSent, 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, verifyRemote
-
Field Details
-
DEFAULT_PORT
public static final int DEFAULT_PORTThe default IMAP port (RFC 3501).- See Also:
-
__DEFAULT_ENCODING
The default control socket ecoding.- See Also:
-
__state
-
__writer
-
_reader
-
_replyCode
private int _replyCode -
_replyLines
-
TRUE_CHUNK_LISTENER
Implementation of IMAPChunkListener that returns
true
but otherwise does nothing.This is intended for use with a suitable ProtocolCommandListener. If the IMAP response contains multiple-line data, the protocol listener will be called for each multi-line chunk. The accumulated reply data will be cleared after calling the listener. If the response is very long, this can significantly reduce memory requirements. The listener will also start receiving response data earlier, as it does not have to wait for the entire response to be read.
The ProtocolCommandListener must be prepared to accept partial responses. This should not be a problem for listeners that just log the input.
- Since:
- 3.4
- See Also:
-
__chunkListener
-
_initialID
private final char[] _initialID
-
-
Constructor Details
-
IMAP
public IMAP()The default IMAPClient constructor. Initializes the state toDISCONNECTED_STATE
.
-
-
Method Details
-
__getReply
Get the reply for a command that expects a tagged response.- Throws:
IOException
-
__getReply
Get the reply for a command, reading the response until the reply is found.- Parameters:
wantTag
-true
if the command expects a tagged response.- Throws:
IOException
-
fireReplyReceived
OverridesSocketClient.fireReplyReceived(int, String)
so as to avoid creating the reply string if there are no listeners to invoke.- Overrides:
fireReplyReceived
in classSocketClient
- Parameters:
replyCode
- passed to the listenersignored
- the string is only created if there are listeners defined.- Since:
- 3.4
- See Also:
-
_connectAction_
Performs connection initialization and sets state toIMAP.IMAPState.NOT_AUTH_STATE
.- Overrides:
_connectAction_
in classSocketClient
- Throws:
IOException
- (SocketException) if a problem occurs with the socket
-
setState
Sets IMAP client state. This must be one of the_STATE
constants.- Parameters:
state
- The new state.
-
getState
Returns the current IMAP client state.- Returns:
- The current IMAP client state.
-
disconnect
Disconnects the client from the server, and sets the state toDISCONNECTED_STATE
. The reply text information from the last issued command is voided to allow garbage collection of the memory used to store that information.- Overrides:
disconnect
in classSocketClient
- Throws:
IOException
- If there is an error in disconnecting.
-
sendCommandWithID
Sends a command an arguments to the server and returns the reply code.- Parameters:
commandID
- The ID (tag) of the command.command
- The IMAP command to send.args
- The command arguments.- Returns:
- The server reply code (either IMAPReply.OK, IMAPReply.NO or IMAPReply.BAD).
- Throws:
IOException
-
sendCommand
Sends a command an arguments to the server and returns the reply code.- Parameters:
command
- The IMAP command to send.args
- The command arguments.- Returns:
- The server reply code (see IMAPReply).
- Throws:
IOException
- on error
-
sendCommand
Sends a command with no arguments to the server and returns the reply code.- Parameters:
command
- The IMAP command to send.- Returns:
- The server reply code (see IMAPReply).
- Throws:
IOException
- on error
-
sendCommand
Sends a command and arguments to the server and returns the reply code.- Parameters:
command
- The IMAP command to send (one of the IMAPCommand constants).args
- The command arguments.- Returns:
- The server reply code (see IMAPReply).
- Throws:
IOException
- on error
-
doCommand
Sends a command and arguments to the server and return whether successful.- Parameters:
command
- The IMAP command to send (one of the IMAPCommand constants).args
- The command arguments.- Returns:
true
if the command was successful- Throws:
IOException
- on error
-
sendCommand
Sends a command with no arguments to the server and returns the reply code.- Parameters:
command
- The IMAP command to send (one of the IMAPCommand constants).- Returns:
- The server reply code (see IMAPReply).
- Throws:
IOException
- on error
-
doCommand
Sends a command to the server and return whether successful.- Parameters:
command
- The IMAP command to send (one of the IMAPCommand constants).- Returns:
true
if the command was successful- Throws:
IOException
- on error
-
sendData
Sends data to the server and returns the reply code.- Parameters:
command
- The IMAP command to send.- Returns:
- The server reply code (see IMAPReply).
- Throws:
IOException
- on error
-
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.- Returns:
- The last server response.
-
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.- Returns:
- The last server response.
-
setChunkListener
Sets the current chunk listener. If a listener is registered and the implementation returns true, then any registeredPrintCommandListener
instances will be invoked with the partial response and a status ofIMAPReply.PARTIAL
to indicate that the final reply code is not yet known.- Parameters:
listener
- the class to use, ornull
to disable- Since:
- 3.4
- See Also:
-
generateCommandID
Generates a new command ID (tag) for a command.- Returns:
- a new command ID (tag) for an IMAP command.
-