public class POP3Store extends Store
Constructor and Description |
---|
POP3Store(Session session,
URLName url) |
POP3Store(Session session,
URLName url,
String name,
boolean isSSL) |
Modifier and Type | Method and Description |
---|---|
Map |
capabilities()
Return a Map of the capabilities the server provided,
as per RFC 2449.
|
void |
close()
Close this service and terminate its connection.
|
protected void |
finalize()
Stop the event dispatcher thread so the queue can be garbage collected.
|
Folder |
getDefaultFolder()
Returns a Folder object that represents the 'root' of
the default namespace presented to the user by the Store.
|
Folder |
getFolder(String name)
Only the name "INBOX" is supported.
|
Folder |
getFolder(URLName url)
Return a closed Folder object, corresponding to the given
URLName.
|
boolean |
isConnected()
Check whether this store is connected.
|
protected boolean |
protocolConnect(String host,
int portNum,
String user,
String passwd)
The service implementation should override this method to
perform the actual protocol-specific connection attempt.
|
addFolderListener, addStoreListener, getPersonalNamespaces, getSharedNamespaces, getUserNamespaces, notifyFolderListeners, notifyFolderRenamedListeners, notifyStoreListeners, removeFolderListener, removeStoreListener
addConnectionListener, connect, connect, connect, connect, getURLName, notifyConnectionListeners, queueEvent, removeConnectionListener, setConnected, setURLName, toString
protected boolean protocolConnect(String host, int portNum, String user, String passwd) throws MessagingException
Service
connect
method
calls this method as needed.
The protocolConnect
method should return
false
if a user name or password is required
for authentication but the corresponding parameter is null;
the connect
method will prompt the user when
needed to supply missing information. This method may
also return false
if authentication fails for
the supplied user name or password. Alternatively, this method
may throw an AuthenticationFailedException when authentication
fails. This exception may include a String message with more
detail about the failure.
The protocolConnect
method should throw an
exception to report failures not related to authentication,
such as an invalid host name or port number, loss of a
connection during the authentication process, unavailability
of the server, etc.
protocolConnect
in class Service
host
- the name of the host to connect toportNum
- the port to use (-1 means use default port)user
- the name of the user to login aspasswd
- the user's passwordAuthenticationFailedException
- for authentication failuresMessagingException
- for non-authentication failurespublic boolean isConnected()
isConnected
in class Service
public void close() throws MessagingException
Service
This implementation uses setConnected(false)
to set
this service's connected state to false
. It will then
send a close ConnectionEvent to any registered ConnectionListeners.
Subclasses overriding this method to do implementation specific
cleanup should call this method as a last step to insure event
notification, probably by including a call to super.close()
in a finally
clause.
close
in class Service
MessagingException
- for errors while closingConnectionEvent
public Folder getDefaultFolder() throws MessagingException
Store
getDefaultFolder
in class Store
MessagingException
public Folder getFolder(String name) throws MessagingException
getFolder
in class Store
name
- The name of the Folder. In some Stores, name can
be an absolute path if it starts with the
hierarchy delimiter. Else it is interpreted
relative to the 'root' of this namespace.MessagingException
Folder.exists()
,
Folder.create(int)
public Folder getFolder(URLName url) throws MessagingException
Store
Implementations of this method may obtain the name of the
actual folder using the getFile()
method on
URLName, and use that name to create the folder.
getFolder
in class Store
url
- URLName that denotes a folderMessagingException
URLName
public Map capabilities() throws MessagingException
For example, to check if the server supports the STLS capability, use:
if (store.capabilities().containsKey("STLS")) ...
MessagingException
Copyright © 2012 JBoss by Red Hat. All Rights Reserved.