Module jakarta.mail
Package jakarta.mail

Class Store

  • All Implemented Interfaces:
    java.lang.AutoCloseable
    public abstract class Store
extends Service
    An abstract class that models a message store and its access protocol, for storing and retrieving messages. Subclasses provide actual implementations.

    Note that Store extends the Service class, which provides many common methods for naming stores, connecting to stores, and listening to connection events.

    Author:
    John Mani, Bill Shannon
    See Also:
    Service, ConnectionEvent, StoreEvent

    • Constructor Detail

      • Store

        protected Store​(Session session,
                URLName urlname)
        Constructor.
        Parameters:
        session - Session object for this Store.
        urlname - URLName object to be used for this Store

    • Method Detail

      • getDefaultFolder

        public abstract Folder getDefaultFolder()
                                 throws MessagingException
        Returns a Folder object that represents the 'root' of the default namespace presented to the user by the Store.
        Returns:
        the root Folder
        Throws:
        java.lang.IllegalStateException - if this Store is not connected.
        MessagingException - for other failures

      • getFolder

        public abstract Folder getFolder​(java.lang.String name)
                          throws MessagingException
        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.

        Parameters:
        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.
        Returns:
        Folder object
        Throws:
        java.lang.IllegalStateException - if this Store is not connected.
        MessagingException - for other failures
        See Also:
        Folder.exists(), Folder.create(int)

      • getFolder

        public abstract Folder getFolder​(URLName url)
                          throws MessagingException
        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.

        Parameters:
        url - URLName that denotes a folder
        Returns:
        Folder object
        Throws:
        java.lang.IllegalStateException - if this Store is not connected.
        MessagingException - for other failures
        See Also:
        URLName

      • getPersonalNamespaces

        public Folder[] getPersonalNamespaces()
                               throws MessagingException
        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.

        Returns:
        array of Folder objects
        Throws:
        java.lang.IllegalStateException - if this Store is not connected.
        MessagingException - for other failures

      • getUserNamespaces

        public Folder[] getUserNamespaces​(java.lang.String user)
                           throws MessagingException
        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.

        Parameters:
        user - the user name
        Returns:
        array of Folder objects
        Throws:
        java.lang.IllegalStateException - if this Store is not connected.
        MessagingException - for other failures

      • getSharedNamespaces

        public Folder[] getSharedNamespaces()
                             throws MessagingException
        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.

        Returns:
        array of Folder objects
        Throws:
        java.lang.IllegalStateException - if this Store is not connected.
        MessagingException - for other failures

      • addStoreListener

        public void addStoreListener​(StoreListener l)
        Add a listener for StoreEvents on this Store.

        The default implementation provided here adds this listener to an internal list of StoreListeners.

        Parameters:
        l - the Listener for Store events
        See Also:
        StoreEvent

      • notifyStoreListeners

        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.

        Parameters:
        type - the StoreEvent type
        message - a message for the StoreEvent

      • addFolderListener

        public void addFolderListener​(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.

        Parameters:
        l - the Listener for Folder events
        See Also:
        FolderEvent

      • notifyFolderListeners

        protected void notifyFolderListeners​(int type,
                                     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.

        Parameters:
        type - type of FolderEvent
        folder - affected Folder
        See Also:
        notifyFolderRenamedListeners(jakarta.mail.Folder, jakarta.mail.Folder)

      • notifyFolderRenamedListeners

        protected void notifyFolderRenamedListeners​(Folder oldF,
                                            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.

        Parameters:
        oldF - the folder being renamed
        newF - the folder representing the new name.