|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.mail.Service
javax.mail.Store
public abstract class Store
A message store that can be used to save and retrieve messages.
Field Summary |
---|
Fields inherited from class javax.mail.Service |
---|
debug, session, url |
Constructor Summary | |
---|---|
protected |
Store(Session session,
URLName url)
Constructor. |
Method Summary | |
---|---|
void |
addFolderListener(FolderListener l)
Adds a listener for folder events on any folder object obtained from this store. |
void |
addStoreListener(StoreListener l)
Adds a listener for store events on this store. |
abstract Folder |
getDefaultFolder()
Returns a folder that represents the root of the primary namespace presented to the user by this store. |
abstract Folder |
getFolder(java.lang.String name)
Returns the folder with the given name. |
abstract Folder |
getFolder(URLName url)
Returns the folder corresponding to the given URLName. |
Folder[] |
getPersonalNamespaces()
Returns the personal namespaces for the authenticated user. |
Folder[] |
getSharedNamespaces()
Returns the shared namespaces. |
Folder[] |
getUserNamespaces(java.lang.String user)
Returns the personal namespaces for the specified user. |
protected void |
notifyFolderListeners(int type,
Folder folder)
Notifies all folder listeners. |
protected void |
notifyFolderRenamedListeners(Folder oldFolder,
Folder newFolder)
Notifies all folder listeners about the renaming of a folder. |
protected void |
notifyStoreListeners(int type,
java.lang.String message)
Notifies all store event listeners. |
void |
removeFolderListener(FolderListener l)
Removes a folder event listener. |
void |
removeStoreListener(StoreListener l)
Removes a store events listener. |
Methods inherited from class javax.mail.Service |
---|
addConnectionListener, close, connect, connect, connect, connect, getURLName, isConnected, notifyConnectionListeners, protocolConnect, queueEvent, removeConnectionListener, setConnected, setURLName, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
protected Store(Session session, URLName url)
session
- session context for this storeurl
- URLName to be used for this storeMethod Detail |
---|
public abstract Folder getDefaultFolder() throws MessagingException
java.lang.IllegalStateException
- if the store is not connected
MessagingException
public abstract Folder getFolder(java.lang.String name) throws MessagingException
The exists
method can be used to determine whether the
folder actually exists.
In some Stores, name
can be an absolute path if it starts
with the hierarchy delimiter. Otherwise it is interpreted relative
to the root of this namespace.
name
- the folder name
java.lang.IllegalStateException
- if the store is not connected
MessagingException
public abstract Folder getFolder(URLName url) throws MessagingException
url
- a URLName denoting a folder
java.lang.IllegalStateException
- if this store is not connected
MessagingException
public Folder[] getPersonalNamespaces() throws MessagingException
MessagingException
public Folder[] getUserNamespaces(java.lang.String user) throws MessagingException
MessagingException
public Folder[] getSharedNamespaces() throws MessagingException
MessagingException
public void addStoreListener(StoreListener l)
public void removeStoreListener(StoreListener l)
protected void notifyStoreListeners(int type, java.lang.String message)
public void addFolderListener(FolderListener l)
public void removeFolderListener(FolderListener l)
protected void notifyFolderListeners(int type, Folder folder)
protected void notifyFolderRenamedListeners(Folder oldFolder, Folder newFolder)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |