|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.commons.net.SocketClient org.apache.commons.net.imap.IMAP org.apache.commons.net.imap.IMAPClient org.apache.commons.net.imap.IMAPSClient org.apache.commons.net.imap.AuthenticatingIMAPClient
public class AuthenticatingIMAPClient
An IMAP Client class with authentication support.
IMAPSClient
Nested Class Summary | |
---|---|
static class |
AuthenticatingIMAPClient.AUTH_METHOD
The enumeration of currently-supported authentication methods. |
Nested classes/interfaces inherited from class org.apache.commons.net.imap.IMAPClient |
---|
IMAPClient.FETCH_ITEM_NAMES, IMAPClient.SEARCH_CRITERIA, IMAPClient.STATUS_DATA_ITEMS |
Nested classes/interfaces inherited from class org.apache.commons.net.imap.IMAP |
---|
IMAP.IMAPState |
Field Summary |
---|
Fields inherited from class org.apache.commons.net.imap.IMAPSClient |
---|
DEFAULT_IMAPS_PORT, DEFAULT_PROTOCOL |
Fields inherited from class org.apache.commons.net.imap.IMAP |
---|
__DEFAULT_ENCODING, __writer, _reader, DEFAULT_PORT |
Fields inherited from class org.apache.commons.net.SocketClient |
---|
_defaultPort_, _input_, _output_, _serverSocketFactory_, _socket_, _socketFactory_, _timeout_, connectTimeout, NETASCII_EOL |
Constructor Summary | |
---|---|
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. |
Method Summary | |
---|---|
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. |
Methods inherited from class org.apache.commons.net.imap.IMAPSClient |
---|
_connectAction_, execTLS, getEnabledCipherSuites, getEnabledProtocols, getTrustManager, setEnabledCipherSuites, setEnabledProtocols, setKeyManager, setTrustManager |
Methods inherited from class org.apache.commons.net.imap.IMAPClient |
---|
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 |
Methods inherited from class org.apache.commons.net.imap.IMAP |
---|
disconnect, doCommand, doCommand, generateCommandID, getReplyString, getReplyStrings, getState, sendCommand, sendCommand, sendCommand, sendCommand, sendData, setState |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
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).public 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.Method Detail |
---|
public boolean authenticate(AuthenticatingIMAPClient.AUTH_METHOD method, String username, String password) throws IOException, NoSuchAlgorithmException, InvalidKeyException, InvalidKeySpecException
IOException
- 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
IOException
- 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.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |