org.apache.commons.net.pop3
Class ExtendedPOP3Client
java.lang.Object
org.apache.commons.net.SocketClient
org.apache.commons.net.pop3.POP3
org.apache.commons.net.pop3.POP3Client
org.apache.commons.net.pop3.POP3SClient
org.apache.commons.net.pop3.ExtendedPOP3Client
public class ExtendedPOP3Client
- extends POP3SClient
A POP3 Cilent class with protocol and authentication extensions support
(RFC2449 and RFC2195).
- Since:
- 3.0
- See Also:
POP3Client
Method Summary |
boolean |
auth(ExtendedPOP3Client.AUTH_METHOD method,
String username,
String password)
Authenticate to the POP3 server by sending the AUTH command with the
selected mechanism, using the given username and the given password. |
Methods inherited from class org.apache.commons.net.pop3.POP3Client |
capa, deleteMessage, listMessage, listMessages, listUniqueIdentifier, listUniqueIdentifiers, login, login, logout, noop, reset, retrieveMessage, retrieveMessageTop, status |
Methods inherited from class org.apache.commons.net.pop3.POP3 |
disconnect, getAdditionalReply, getCommandSupport, getReplyString, getReplyStrings, getState, removeProtocolCommandistener, sendCommand, sendCommand, sendCommand, sendCommand, setState |
Methods inherited from class org.apache.commons.net.SocketClient |
addProtocolCommandListener, connect, connect, connect, connect, connect, connect, createCommandSupport, fireCommandSent, fireReplyReceived, getConnectTimeout, getDefaultPort, getDefaultTimeout, getKeepAlive, getLocalAddress, getLocalPort, getProxy, getReceiveBufferSize, getRemoteAddress, getRemotePort, getSendBufferSize, getServerSocketFactory, getSoLinger, getSoTimeout, getTcpNoDelay, isAvailable, isConnected, removeProtocolCommandListener, setConnectTimeout, setDefaultPort, setDefaultTimeout, setKeepAlive, setProxy, setReceiveBufferSize, setSendBufferSize, setServerSocketFactory, setSocketFactory, setSoLinger, setSoTimeout, setTcpNoDelay, verifyRemote |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
ExtendedPOP3Client
public ExtendedPOP3Client()
throws NoSuchAlgorithmException
- The default ExtendedPOP3Client constructor.
Creates a new Extended POP3 Client.
- Throws:
NoSuchAlgorithmException
auth
public boolean auth(ExtendedPOP3Client.AUTH_METHOD method,
String username,
String password)
throws IOException,
NoSuchAlgorithmException,
InvalidKeyException,
InvalidKeySpecException
- Authenticate to the POP3 server by sending the AUTH command with the
selected mechanism, using the given username and the given password.
- Parameters:
method
- the ExtendedPOP3Client.AUTH_METHOD
to useusername
- the user namepassword
- the password
- Returns:
- True if successfully completed, false if not.
- Throws:
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.
Copyright © 2001-2012 The Apache Software Foundation. All Rights Reserved.