|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--javax.mail.Service | +--javax.mail.Store | +--com.sun.mail.imap.IMAPStore
This class provides access to an IMAP message store.
Applications that need to make use of IMAP-specific features may cast
a Store
object to an IMAPStore
object and
use the methods on this class. The getQuota
and
setQuota
methods support the IMAP QUOTA extension.
Refer to RFC 2087
for more information.
See the com.sun.mail.imap package documentation for further information on the IMAP protocol provider.
WARNING: The APIs unique to this class should be considered EXPERIMENTAL. They may be changed in the future in ways that are incompatible with applications using the current APIs.
Constructor Summary | |
IMAPStore(Session session,
URLName url)
Constructor that takes a Session object and a URLName that represents a specific IMAP server. |
Method Summary | |
void |
close()
Close this Store. |
Folder |
getDefaultFolder()
Get the default folder, representing the root of this user's namespace. |
Folder |
getFolder(java.lang.String name)
Get named folder. |
Folder |
getFolder(URLName url)
Get named folder. |
Folder[] |
getPersonalNamespaces()
Using the IMAP NAMESPACE command (RFC 2342), return a set of folders representing the Personal namespaces. |
Quota[] |
getQuota(java.lang.String root)
Get the quotas for the named quota root. |
Folder[] |
getSharedNamespaces()
Using the IMAP NAMESPACE command (RFC 2342), return a set of folders representing the Shared namespaces. |
Folder[] |
getUserNamespaces(java.lang.String user)
Using the IMAP NAMESPACE command (RFC 2342), return a set of folders representing the User's namespaces. |
void |
handleResponse(com.sun.mail.iap.Response r)
Response handler method. |
boolean |
isConnected()
Check whether this store is connected. |
void |
setQuota(Quota quota)
Set the quotas for the quota root specified in the quota argument. |
Methods inherited from class javax.mail.Store |
addFolderListener, addStoreListener, removeFolderListener, removeStoreListener |
Methods inherited from class javax.mail.Service |
addConnectionListener, connect, connect, connect, getURLName, removeConnectionListener, toString |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public IMAPStore(Session session, URLName url)
Method Detail |
public boolean isConnected()
isConnected
in class Service
public void close() throws MessagingException
close
in class Service
public Folder getDefaultFolder() throws MessagingException
getDefaultFolder
in class Store
public Folder getFolder(java.lang.String name) throws MessagingException
getFolder
in class Store
public Folder getFolder(URLName url) throws MessagingException
getFolder
in class Store
public Folder[] getPersonalNamespaces() throws MessagingException
getPersonalNamespaces
in class Store
public Folder[] getUserNamespaces(java.lang.String user) throws MessagingException
getUserNamespaces
in class Store
public Folder[] getSharedNamespaces() throws MessagingException
getSharedNamespaces
in class Store
public Quota[] getQuota(java.lang.String root) throws MessagingException
root
- the name of the quota rootMessagingException
- if the server doesn't support the
QUOTA extensionpublic void setQuota(Quota quota) throws MessagingException
getQuota
method, but it need not be.quota
- the quota to setMessagingException
- if the server doesn't support the
QUOTA extensionpublic void handleResponse(com.sun.mail.iap.Response r)
handleResponse
in interface com.sun.mail.iap.ResponseHandler
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |