public class AuthenticatingIMAPClient extends IMAPSClient
IMAPSClient
Modifier and Type | Class and Description |
---|---|
static class |
AuthenticatingIMAPClient.AUTH_METHOD
The enumeration of currently-supported authentication methods.
|
IMAPClient.FETCH_ITEM_NAMES, IMAPClient.SEARCH_CRITERIA, IMAPClient.STATUS_DATA_ITEMS
IMAP.IMAPChunkListener, IMAP.IMAPState
DEFAULT_IMAPS_PORT, DEFAULT_PROTOCOL
__DEFAULT_ENCODING, __writer, _reader, DEFAULT_PORT, TRUE_CHUNK_LISTENER
_defaultPort_, _hostname_, _input_, _output_, _serverSocketFactory_, _socket_, _socketFactory_, _timeout_, connectTimeout, NETASCII_EOL
Constructor and Description |
---|
AuthenticatingIMAPClient()
Constructor for AuthenticatingIMAPClient that delegates to IMAPSClient.
|
AuthenticatingIMAPClient(boolean implicit)
Constructor for AuthenticatingIMAPClient that delegates to IMAPSClient.
|
AuthenticatingIMAPClient(boolean implicit,
SSLContext ctx)
Constructor for AuthenticatingIMAPClient that delegates to IMAPSClient.
|
AuthenticatingIMAPClient(SSLContext context)
Constructor for AuthenticatingIMAPClient that delegates to IMAPSClient.
|
AuthenticatingIMAPClient(String proto)
Constructor for AuthenticatingIMAPClient that delegates to IMAPSClient.
|
AuthenticatingIMAPClient(String proto,
boolean implicit)
Constructor for AuthenticatingIMAPClient that delegates to IMAPSClient.
|
AuthenticatingIMAPClient(String proto,
boolean implicit,
SSLContext ctx)
Constructor for AuthenticatingIMAPClient that delegates to IMAPSClient.
|
Modifier and Type | Method and Description |
---|---|
boolean |
auth(AuthenticatingIMAPClient.AUTH_METHOD method,
String username,
String password)
Authenticate to the IMAP server by sending the AUTHENTICATE command with the
selected mechanism, using the given username and the given password.
|
boolean |
authenticate(AuthenticatingIMAPClient.AUTH_METHOD method,
String username,
String password)
Authenticate to the IMAP server by sending the AUTHENTICATE command with the
selected mechanism, using the given username and the given password.
|
_connectAction_, execTLS, getEnabledCipherSuites, getEnabledProtocols, getHostnameVerifier, getTrustManager, isEndpointCheckingEnabled, setEnabledCipherSuites, setEnabledProtocols, setEndpointCheckingEnabled, setHostnameVerifier, setKeyManager, setTrustManager
append, append, append, capability, check, close, copy, create, delete, examine, expunge, fetch, list, login, logout, lsub, noop, rename, search, search, select, status, store, subscribe, uid, unsubscribe
disconnect, doCommand, doCommand, fireReplyReceived, generateCommandID, getReplyString, getReplyStrings, getState, sendCommand, sendCommand, sendCommand, sendCommand, sendData, setChunkListener, setState
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
public AuthenticatingIMAPClient()
public AuthenticatingIMAPClient(boolean implicit)
implicit
- The security mode (Implicit/Explicit).public AuthenticatingIMAPClient(String proto)
proto
- the protocol.public AuthenticatingIMAPClient(String proto, boolean implicit)
proto
- the protocol.implicit
- The security mode(Implicit/Explicit).public AuthenticatingIMAPClient(String proto, boolean implicit, SSLContext ctx)
proto
- the protocol.implicit
- The security mode(Implicit/Explicit).ctx
- the contextpublic AuthenticatingIMAPClient(boolean implicit, SSLContext ctx)
implicit
- The security mode(Implicit/Explicit).ctx
- A pre-configured SSL Context.public AuthenticatingIMAPClient(SSLContext context)
context
- A pre-configured SSL Context.public boolean authenticate(AuthenticatingIMAPClient.AUTH_METHOD method, String username, String password) throws IOException, NoSuchAlgorithmException, InvalidKeyException, InvalidKeySpecException
method
- the method nameusername
- userpassword
- passwordIOException
- If an I/O error occurs while either sending a
command to the server or receiving a reply from the server.NoSuchAlgorithmException
- If the CRAM hash algorithm
cannot be instantiated by the Java runtime system.InvalidKeyException
- If the CRAM hash algorithm
failed to use the given password.InvalidKeySpecException
- If the CRAM hash algorithm
failed to use the given password.public boolean auth(AuthenticatingIMAPClient.AUTH_METHOD method, String username, String password) throws IOException, NoSuchAlgorithmException, InvalidKeyException, InvalidKeySpecException
method
- the method nameusername
- userpassword
- passwordIOException
- If an I/O error occurs while either sending a
command to the server or receiving a reply from the server.NoSuchAlgorithmException
- If the CRAM hash algorithm
cannot be instantiated by the Java runtime system.InvalidKeyException
- If the CRAM hash algorithm
failed to use the given password.InvalidKeySpecException
- If the CRAM hash algorithm
failed to use the given password.Copyright © 2001–2016 The Apache Software Foundation. All rights reserved.