File	Doc	Category	Size	Date	Package
Store.java	API Doc	Glassfish v2 API	12030	Mon May 14 15:28:48 BST 2007	javax.mail

Store

• java.lang.Object
  • javax.mail.Service

Fields Summary
private volatile Vector	storeListeners
private volatile Vector	folderListeners

Constructors Summary
protected Store(Session session, URLName urlname) Constructor. param session Session object for this Store. param urlname URLName object to be used for this Store super(session, urlname);

Methods Summary
public synchronized void	addFolderListener(javax.mail.event.FolderListener l) Add a listener for Folder events on any Folder object obtained from this Store. FolderEvents are delivered to FolderListeners on the affected Folder as well as to FolderListeners on the containing Store. The default implementation provided here adds this listener to an internal list of FolderListeners. param l the Listener for Folder events see javax.mail.event.FolderEvent if (folderListeners == null) folderListeners = new Vector(); folderListeners.addElement(l);
public synchronized void	addStoreListener(javax.mail.event.StoreListener l) Add a listener for StoreEvents on this Store. The default implementation provided here adds this listener to an internal list of StoreListeners. param l the Listener for Store events see javax.mail.event.StoreEvent if (storeListeners == null) storeListeners = new Vector(); storeListeners.addElement(l);
public abstract javax.mail.Folder	getDefaultFolder() Returns a Folder object that represents the 'root' of the default namespace presented to the user by the Store. return the root Folder exception IllegalStateException if this Store is not connected.
public abstract javax.mail.Folder	getFolder(java.lang.String name) Return the Folder object corresponding to the given name. Note that a Folder object is returned even if the named folder does not physically exist on the Store. The exists() method on the folder object indicates whether this folder really exists. Folder objects are not cached by the Store, so invoking this method on the same name multiple times will return that many distinct Folder objects. param 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. return Folder object exception IllegalStateException if this Store is not connected. see Folder#exists see Folder#create
public abstract javax.mail.Folder	getFolder(javax.mail.URLName url) Return a closed Folder object, corresponding to the given URLName. The store specified in the given URLName should refer to this Store object. 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. param url URLName that denotes a folder see URLName exception IllegalStateException if this Store is not connected. return Folder object
public javax.mail.Folder[]	getPersonalNamespaces() Return a set of folders representing the personal namespaces for the current user. A personal namespace is a set of names that is considered within the personal scope of the authenticated user. Typically, only the authenticated user has access to mail folders in their personal namespace. If an INBOX exists for a user, it must appear within the user's personal namespace. In the typical case, there should be only one personal namespace for each user in each Store. This implementation returns an array with a single entry containing the return value of the getDefaultFolder method. Subclasses should override this method to return appropriate information. exception IllegalStateException if this Store is not connected. return array of Folder objects since JavaMail 1.2 return new Folder[] { getDefaultFolder() };
public javax.mail.Folder[]	getSharedNamespaces() Return a set of folders representing the shared namespaces. A shared namespace is a namespace that consists of mail folders that are intended to be shared amongst users and do not exist within a user's personal namespace. This implementation returns an empty array. Subclasses should override this method to return appropriate information. exception IllegalStateException if this Store is not connected. return array of Folder objects since JavaMail 1.2 return new Folder[0];
public javax.mail.Folder[]	getUserNamespaces(java.lang.String user) Return a set of folders representing the namespaces for user. The namespaces returned represent the personal namespaces for the user. To access mail folders in the other user's namespace, the currently authenticated user must be explicitly granted access rights. For example, it is common for a manager to grant to their secretary access rights to their mail folders. This implementation returns an empty array. Subclasses should override this method to return appropriate information. exception IllegalStateException if this Store is not connected. return array of Folder objects since JavaMail 1.2 return new Folder[0];
protected void	notifyFolderListeners(int type, javax.mail.Folder folder) Notify all FolderListeners. Store implementations are expected to use this method to broadcast Folder events. The provided default implementation queues the event into an internal event queue. An event dispatcher thread dequeues events from the queue and dispatches them to the registered FolderListeners. Note that the event dispatching occurs in a separate thread, thus avoiding potential deadlock problems. param type type of FolderEvent param folder affected Folder see #notifyFolderRenamedListeners if (folderListeners == null) return; FolderEvent e = new FolderEvent(this, folder, type); queueEvent(e, folderListeners);
protected void	notifyFolderRenamedListeners(javax.mail.Folder oldF, javax.mail.Folder newF) Notify all FolderListeners about the renaming of a folder. Store implementations are expected to use this method to broadcast Folder events indicating the renaming of folders. The provided default implementation queues the event into an internal event queue. An event dispatcher thread dequeues events from the queue and dispatches them to the registered FolderListeners. Note that the event dispatching occurs in a separate thread, thus avoiding potential deadlock problems. param oldF the folder being renamed param newF the folder representing the new name. since JavaMail 1.1 if (folderListeners == null) return; FolderEvent e = new FolderEvent(this, oldF, newF,FolderEvent.RENAMED); queueEvent(e, folderListeners);
protected void	notifyStoreListeners(int type, java.lang.String message) Notify all StoreListeners. Store implementations are expected to use this method to broadcast StoreEvents. The provided default implementation queues the event into an internal event queue. An event dispatcher thread dequeues events from the queue and dispatches them to the registered StoreListeners. Note that the event dispatching occurs in a separate thread, thus avoiding potential deadlock problems. if (storeListeners == null) return; StoreEvent e = new StoreEvent(this, type, message); queueEvent(e, storeListeners);
public synchronized void	removeFolderListener(javax.mail.event.FolderListener l) Remove a listener for Folder events. The default implementation provided here removes this listener from the internal list of FolderListeners. param l the listener see #addFolderListener if (folderListeners != null) folderListeners.removeElement(l);
public synchronized void	removeStoreListener(javax.mail.event.StoreListener l) Remove a listener for Store events. The default implementation provided here removes this listener from the internal list of StoreListeners. param l the listener see #addStoreListener if (storeListeners != null) storeListeners.removeElement(l);