Package com.sun.mail.imap

Class IMAPFolder

  • All Implemented Interfaces:
    ResponseHandler, java.lang.AutoCloseable, UIDFolder
    Direct Known Subclasses:
    DefaultFolder
    public class IMAPFolder
extends Folder
implements UIDFolder, ResponseHandler
    This class implements an IMAP folder.

    A closed IMAPFolder object shares a protocol connection with its IMAPStore object. When the folder is opened, it gets its own protocol connection.

    Applications that need to make use of IMAP-specific features may cast a Folder object to an IMAPFolder 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.

    The getACL, addACL, removeACL, addRights, removeRights, listRights, and myRights methods support the IMAP ACL extension. Refer to RFC 2086 for more information.

    The getSortedMessages methods support the IMAP SORT extension. Refer to RFC 5256 for more information.

    The open(int,ResyncData) method and ResyncData class supports the IMAP CONDSTORE and QRESYNC extensions. Refer to RFC 4551 and RFC 5162 for more information.

    The doCommand method and IMAPFolder.ProtocolCommand interface support use of arbitrary IMAP protocol commands.

    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.

    • Method Detail

      • getName

        public java.lang.String getName()
        Get the name of this folder.
        Specified by:
        getName in class Folder
        Returns:
        name of the Folder

      • getFullName

        public java.lang.String getFullName()
        Get the fullname of this folder.
        Specified by:
        getFullName in class Folder
        Returns:
        full name of the Folder

      • isSubscribed

        public boolean isSubscribed()
        Check whether this folder is subscribed.
        Overrides:
        isSubscribed in class Folder
        Returns:
        true if this Folder is subscribed

      • open

        public java.util.List<MailEvent> open​(int mode,
                                      ResyncData rd)
                               throws MessagingException
        Open this folder in the given mode, with the given resynchronization data.
        Parameters:
        mode - the open mode (Folder.READ_WRITE or Folder.READ_ONLY)
        rd - the ResyncData instance
        Returns:
        a List of MailEvent instances, or null if none
        Throws:
        MessagingException - if the open fails
        Since:
        JavaMail 1.5.1

      • isOpen

        public boolean isOpen()
        Check whether this connection is really open.
        Specified by:
        isOpen in class Folder
        Returns:
        true if this Folder is in the 'open' state.

      • getPermanentFlags

        public Flags getPermanentFlags()
        Return the permanent flags supported by the server.
        Specified by:
        getPermanentFlags in class Folder
        Returns:
        permanent flags, or null if not known

      • getMessages

        public Message[] getMessages()
                      throws MessagingException
        Get all Message objects from this Folder. Returns an empty array if the folder is empty. Clients can use Message objects (instead of sequence numbers) as references to the messages within a folder; this method supplies the Message objects to the client. Folder implementations are expected to provide light-weight Message objects, which get filled on demand.

        This implementation invokes getMessageCount() to get the current message count and then uses getMessage() to get Message objects from 1 till the message count.

        Overrides:
        getMessages in class Folder
        Returns:
        array of Message objects, empty array if folder is empty.
        Throws:
        FolderNotFoundException - if this folder does not exist.
        MessagingException - for other failures
        See Also:
        Folder.fetch(javax.mail.Message[], javax.mail.FetchProfile)

      • appendUIDMessages

        public AppendUID[] appendUIDMessages​(Message[] msgs)
                              throws MessagingException
        Append the given messages into this folder. Return array of AppendUID objects containing UIDs of these messages in the destination folder. Each element of the returned array corresponds to an element of the msgs array. A null element means the server didn't return UID information for the appended message.

        Depends on the APPENDUID response code defined by the UIDPLUS extension - RFC 4315.

        Parameters:
        msgs - the messages to append
        Returns:
        array of AppendUID objects
        Throws:
        MessagingException - for failures
        Since:
        JavaMail 1.4

      • addMessages

        public Message[] addMessages​(Message[] msgs)
                      throws MessagingException
        Append the given messages into this folder. Return array of Message objects representing the messages in the destination folder. Note that the folder must be open. Each element of the returned array corresponds to an element of the msgs array. A null element means the server didn't return UID information for the appended message.

        Depends on the APPENDUID response code defined by the UIDPLUS extension - RFC 4315.

        Parameters:
        msgs - the messages to add
        Returns:
        the messages in this folder
        Throws:
        MessagingException - for failures
        Since:
        JavaMail 1.4

      • copyUIDMessages

        public AppendUID[] copyUIDMessages​(Message[] msgs,
                                   Folder folder)
                            throws MessagingException
        Copy the specified messages from this folder, to the specified destination. Return array of AppendUID objects containing UIDs of these messages in the destination folder. Each element of the returned array corresponds to an element of the msgs array. A null element means the server didn't return UID information for the copied message.

        Depends on the COPYUID response code defined by the UIDPLUS extension - RFC 4315.

        Parameters:
        msgs - the messages to copy
        folder - the folder to copy the messages to
        Returns:
        array of AppendUID objects
        Throws:
        MessagingException - for failures
        Since:
        JavaMail 1.5.1

      • moveMessages

        public void moveMessages​(Message[] msgs,
                         Folder folder)
                  throws MessagingException
        Move the specified messages from this folder, to the specified destination. Depends on the MOVE extension (RFC 6851).
        Parameters:
        msgs - the messages to move
        folder - the folder to move the messages to
        Throws:
        MessagingException - for failures
        Since:
        JavaMail 1.5.4

      • moveUIDMessages

        public AppendUID[] moveUIDMessages​(Message[] msgs,
                                   Folder folder)
                            throws MessagingException
        Move the specified messages from this folder, to the specified destination. Return array of AppendUID objects containing UIDs of these messages in the destination folder. Each element of the returned array corresponds to an element of the msgs array. A null element means the server didn't return UID information for the moved message.

        Depends on the MOVE extension (RFC 6851) and the COPYUID response code defined by the UIDPLUS extension (RFC 4315).

        Parameters:
        msgs - the messages to move
        folder - the folder to move the messages to
        Returns:
        array of AppendUID objects
        Throws:
        MessagingException - for failures
        Since:
        JavaMail 1.5.4

      • expunge

        public Message[] expunge​(Message[] msgs)
                  throws MessagingException
        Expunge the indicated messages, which must have been marked as DELETED. Depends on the UIDPLUS extension - RFC 4315.
        Parameters:
        msgs - the messages to expunge
        Returns:
        the expunged messages
        Throws:
        MessagingException - for failures

      • search

        public Message[] search​(SearchTerm term)
                 throws MessagingException
        Search whole folder for messages matching the given term. If the property mail.imap.throwsearchexception is true, and the search term is too complex for the IMAP protocol, SearchException is thrown. Otherwise, if the search term is too complex, super.search is called to do the search on the client.
        Overrides:
        search in class Folder
        Parameters:
        term - the search term
        Returns:
        the messages that match
        Throws:
        SearchException - if mail.imap.throwsearchexception is true and the search is too complex for the IMAP protocol
        MessagingException - for other failures
        See Also:
        SearchTerm

      • search

        public Message[] search​(SearchTerm term,
                        Message[] msgs)
                 throws MessagingException
        Search the folder for messages matching the given term. Returns array of matching messages. Returns an empty array if no matching messages are found.
        Overrides:
        search in class Folder
        Parameters:
        term - the search criterion
        msgs - the messages to be searched
        Returns:
        array of matching messages
        Throws:
        SearchException - if the search term is too complex for the implementation to handle.
        MessagingException - for other failures
        See Also:
        SearchTerm

      • getSortedMessages

        public Message[] getSortedMessages​(SortTerm[] term)
                            throws MessagingException
        Sort the messages in the folder according to the sort criteria. The messages are returned in the sorted order, but the order of the messages in the folder is not changed.

        Depends on the SORT extension - RFC 5256.

        Parameters:
        term - the SortTerms
        Returns:
        the messages in sorted order
        Throws:
        MessagingException - for failures
        Since:
        JavaMail 1.4.4

      • getSortedMessages

        public Message[] getSortedMessages​(SortTerm[] term,
                                   SearchTerm sterm)
                            throws MessagingException
        Sort the messages in the folder according to the sort criteria. The messages are returned in the sorted order, but the order of the messages in the folder is not changed. Only messages matching the search criteria are considered.

        Depends on the SORT extension - RFC 5256.

        Parameters:
        term - the SortTerms
        sterm - the SearchTerm
        Returns:
        the messages in sorted order
        Throws:
        MessagingException - for failures
        Since:
        JavaMail 1.4.4

      • addMessageCountListener

        public void addMessageCountListener​(MessageCountListener l)
        Description copied from class: Folder
        Add a listener for MessageCount events on this Folder.

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

        Overrides:
        addMessageCountListener in class Folder
        Parameters:
        l - the Listener for MessageCount events
        See Also:
        MessageCountEvent

      • getUIDNext

        public long getUIDNext()
                throws MessagingException
        Returns the predicted UID that will be assigned to the next message that is appended to this folder. If the folder is closed, the STATUS command is used to retrieve this value. If the folder is open, the value returned from the SELECT or EXAMINE command is returned. Note that messages may have been appended to the folder while it was open and thus this value may be out of date.

        Servers implementing RFC2060 likely won't return this value when a folder is opened. Servers implementing RFC3501 should return this value when a folder is opened.

        Specified by:
        getUIDNext in interface UIDFolder
        Returns:
        the UIDNEXT value, or -1 if unknown
        Throws:
        MessagingException - for failures
        Since:
        JavaMail 1.3.3

      • getMessageByUID

        public Message getMessageByUID​(long uid)
                        throws MessagingException
        Get the Message corresponding to the given UID. If no such message exists, null is returned.
        Specified by:
        getMessageByUID in interface UIDFolder
        Parameters:
        uid - UID for the desired message
        Returns:
        the Message object. null is returned if no message corresponding to this UID is obtained.
        Throws:
        MessagingException - for failures

      • getMessagesByUID

        public Message[] getMessagesByUID​(long start,
                                  long end)
                           throws MessagingException
        Get the Messages specified by the given range.

        Returns Message objects for all valid messages in this range. Returns an empty array if no messages are found.

        Specified by:
        getMessagesByUID in interface UIDFolder
        Parameters:
        start - start UID
        end - end UID
        Returns:
        array of Message objects
        Throws:
        MessagingException - for failures
        See Also:
        UIDFolder.LASTUID

      • getMessagesByUID

        public Message[] getMessagesByUID​(long[] uids)
                           throws MessagingException
        Get the Messages specified by the given array.

        uids.length() elements are returned. If any UID in the array is invalid, a null entry is returned for that element.

        Specified by:
        getMessagesByUID in interface UIDFolder
        Parameters:
        uids - array of UIDs
        Returns:
        array of Message objects
        Throws:
        MessagingException - for failures

      • getUIDNotSticky

        public boolean getUIDNotSticky()
                        throws MessagingException
        Servers that support the UIDPLUS extension (RFC 4315) may indicate that this folder does not support persistent UIDs; that is, UIDVALIDITY will be different each time the folder is opened. Only valid when the folder is open.
        Returns:
        true if UIDs are not sticky
        Throws:
        MessagingException - for failures
        java.lang.IllegalStateException - if the folder isn't open
        Since:
        JavaMail 1.6.0
        See Also:
        "RFC 4315"

      • getHighestModSeq

        public long getHighestModSeq()
                      throws MessagingException
        Returns the HIGHESTMODSEQ for this folder.
        Returns:
        the HIGHESTMODSEQ value
        Throws:
        MessagingException - for failures
        Since:
        JavaMail 1.5.1
        See Also:
        "RFC 4551"

      • getMessagesByUIDChangedSince

        public Message[] getMessagesByUIDChangedSince​(long start,
                                              long end,
                                              long modseq)
                                       throws MessagingException
        Get the messages that have been changed since the given MODSEQ value. Also, prefetch the flags for the messages.

        The server must support the CONDSTORE extension.

        Parameters:
        start - the first message number
        end - the last message number
        modseq - the MODSEQ value
        Returns:
        the changed messages
        Throws:
        MessagingException - for failures
        Since:
        JavaMail 1.5.1
        See Also:
        "RFC 4551"

      • getQuota

        public Quota[] getQuota()
                 throws MessagingException
        Get the quotas for the quotaroot associated with this folder. Note that many folders may have the same quotaroot. Quotas are controlled on the basis of a quotaroot, not (necessarily) a folder. The relationship between folders and quotaroots depends on the IMAP server. Some servers might implement a single quotaroot for all folders owned by a user. Other servers might implement a separate quotaroot for each folder. A single folder can even have multiple quotaroots, perhaps controlling quotas for different resources.
        Returns:
        array of Quota objects for the quotaroots associated with this folder
        Throws:
        MessagingException - if the server doesn't support the QUOTA extension

      • setQuota

        public void setQuota​(Quota quota)
              throws MessagingException
        Set the quotas for the quotaroot specified in the quota argument. Typically this will be one of the quotaroots associated with this folder, as obtained from the getQuota method, but it need not be.
        Parameters:
        quota - the quota to set
        Throws:
        MessagingException - if the server doesn't support the QUOTA extension

      • getACL

        public ACL[] getACL()
             throws MessagingException
        Get the access control list entries for this folder.
        Returns:
        array of access control list entries
        Throws:
        MessagingException - if the server doesn't support the ACL extension

      • addACL

        public void addACL​(ACL acl)
            throws MessagingException
        Add an access control list entry to the access control list for this folder.
        Parameters:
        acl - the access control list entry to add
        Throws:
        MessagingException - if the server doesn't support the ACL extension

      • removeACL

        public void removeACL​(java.lang.String name)
               throws MessagingException
        Remove any access control list entry for the given identifier from the access control list for this folder.
        Parameters:
        name - the identifier for which to remove all ACL entries
        Throws:
        MessagingException - if the server doesn't support the ACL extension

      • addRights

        public void addRights​(ACL acl)
               throws MessagingException
        Add the rights specified in the ACL to the entry for the identifier specified in the ACL. If an entry for the identifier doesn't already exist, add one.
        Parameters:
        acl - the identifer and rights to add
        Throws:
        MessagingException - if the server doesn't support the ACL extension

      • removeRights

        public void removeRights​(ACL acl)
                  throws MessagingException
        Remove the rights specified in the ACL from the entry for the identifier specified in the ACL.
        Parameters:
        acl - the identifer and rights to remove
        Throws:
        MessagingException - if the server doesn't support the ACL extension

      • listRights

        public Rights[] listRights​(java.lang.String name)
                    throws MessagingException
        Get all the rights that may be allowed to the given identifier. Rights are grouped per RFC 2086 and each group is returned as an element of the array. The first element of the array is the set of rights that are always granted to the identifier. Later elements are rights that may be optionally granted to the identifier.

        Note that this method lists the rights that it is possible to assign to the given identifier, not the rights that are actually granted to the given identifier. For the latter, see the getACL method.

        Parameters:
        name - the identifier to list rights for
        Returns:
        array of Rights objects representing possible rights for the identifier
        Throws:
        MessagingException - if the server doesn't support the ACL extension

      • myRights

        public Rights myRights()
                throws MessagingException
        Get the rights allowed to the currently authenticated user.
        Returns:
        the rights granted to the current user
        Throws:
        MessagingException - if the server doesn't support the ACL extension

      • getAttributes

        public java.lang.String[] getAttributes()
                                 throws MessagingException
        Get the attributes that the IMAP server returns with the LIST response.
        Returns:
        array of attributes for this folder
        Throws:
        MessagingException - for failures
        Since:
        JavaMail 1.3.3

      • idle

        public void idle()
          throws MessagingException
        Use the IMAP IDLE command (see RFC 2177), if supported by the server, to enter idle mode so that the server can send unsolicited notifications of new messages arriving, etc. without the need for the client to constantly poll the server. Use an appropriate listener to be notified of new messages or other events. When another thread (e.g., the listener thread) needs to issue an IMAP comand for this folder, the idle mode will be terminated and this method will return. Typically the caller will invoke this method in a loop.

        The mail.imap.minidletime property enforces a minimum delay before returning from this method, to ensure that other threads have a chance to issue commands before the caller invokes this method again. The default delay is 10 milliseconds.

        Throws:
        MessagingException - if the server doesn't support the IDLE extension
        java.lang.IllegalStateException - if the folder isn't open
        Since:
        JavaMail 1.4.1

      • idle

        public void idle​(boolean once)
          throws MessagingException
        Like idle(), but if once is true, abort the IDLE command after the first notification, to allow the caller to process any notification synchronously.
        Parameters:
        once - only do one notification?
        Throws:
        MessagingException - if the server doesn't support the IDLE extension
        java.lang.IllegalStateException - if the folder isn't open
        Since:
        JavaMail 1.4.3

      • id

        public java.util.Map<java.lang.String,​java.lang.String> id​(java.util.Map<java.lang.String,​java.lang.String> clientParams)
                                                          throws MessagingException
        Send the IMAP ID command (if supported by the server) and return the result from the server. The ID command identfies the client to the server and returns information about the server to the client. See RFC 2971. The returned Map is unmodifiable.
        Parameters:
        clientParams - a Map of keys and values identifying the client
        Returns:
        a Map of keys and values identifying the server
        Throws:
        MessagingException - if the server doesn't support the ID extension
        Since:
        JavaMail 1.5.1

      • getStatusItem

        public long getStatusItem​(java.lang.String item)
                   throws MessagingException
        Use the IMAP STATUS command to get the indicated item. The STATUS item may be a standard item such as "RECENT" or "UNSEEN", or may be a server-specific item. The folder must be closed. If the item is not found, or the folder is open, -1 is returned.
        Parameters:
        item - the STATUS item to fetch
        Returns:
        the value of the STATUS item, or -1
        Throws:
        MessagingException - for errors
        Since:
        JavaMail 1.5.2

      • handleResponse

        public void handleResponse​(Response r)
        The response handler. This is the callback routine that is invoked by the protocol layer.
        Specified by:
        handleResponse in interface ResponseHandler

      • doCommand

        public java.lang.Object doCommand​(IMAPFolder.ProtocolCommand cmd)
                           throws MessagingException
        Execute a user-supplied IMAP command. The command is executed in the appropriate context with the necessary locks held and using the appropriate IMAPProtocol object.

        This method returns whatever the ProtocolCommand object's doCommand method returns. If the doCommand method throws a ConnectionException it is translated into a StoreClosedException or FolderClosedException as appropriate. If the doCommand method throws a ProtocolException it is translated into a MessagingException.

        The following example shows how to execute the IMAP NOOP command. Executing more complex IMAP commands requires intimate knowledge of the com.sun.mail.iap and com.sun.mail.imap.protocol packages, best acquired by reading the source code. 

         import com.sun.mail.iap.*;
 import com.sun.mail.imap.*;
 import com.sun.mail.imap.protocol.*;

 ...

 IMAPFolder f = (IMAPFolder)folder;
 Object val = f.doCommand(new IMAPFolder.ProtocolCommand() {
        public Object doCommand(IMAPProtocol p)
                        throws ProtocolException {
            p.simpleCommand("NOOP", null);
            return null;
        }
 });

        Here's a more complex example showing how to use the proposed IMAP SORT extension: 

         import com.sun.mail.iap.*;
 import com.sun.mail.imap.*;
 import com.sun.mail.imap.protocol.*;

 ...

 IMAPFolder f = (IMAPFolder)folder;
 Object val = f.doCommand(new IMAPFolder.ProtocolCommand() {
        public Object doCommand(IMAPProtocol p)
                        throws ProtocolException {
            // Issue command
            Argument args = new Argument();
            Argument list = new Argument();
            list.writeString("SUBJECT");
            args.writeArgument(list);
            args.writeString("UTF-8");
            args.writeString("ALL");
            Response[] r = p.command("SORT", args);
            Response response = r[r.length-1];

            // Grab response
            Vector v = new Vector();
            if (response.isOK()) { // command succesful 
                for (int i = 0, len = r.length; i < len; i++) {
                    if (!(r[i] instanceof IMAPResponse))
                        continue;

                    IMAPResponse ir = (IMAPResponse)r[i];
                    if (ir.keyEquals("SORT")) {
                        String num;
                        while ((num = ir.readAtomString()) != null)
                            System.out.println(num);
                        r[i] = null;
                    }
                }
            }

            // dispatch remaining untagged responses
            p.notifyResponseHandlers(r);
            p.handleResult(response);

            return null;
        }
 });
        Parameters:
        cmd - the protocol command
        Returns:
        the result of the command
        Throws:
        MessagingException - for failures