com.sun.mail.imap

Class IMAPFolder

java.lang.Object

Folder

com.sun.mail.imap.IMAPFolder

All Implemented Interfaces:

ResponseHandler

Direct Known Subclasses:

DefaultFolder

public class IMAPFolder
extends Folder
implements 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 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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IMAPFolder.FetchProfileItem A fetch profile item for fetching headers.
static interface	IMAPFolder.ProtocolCommand A simple interface for user-defined IMAP protocol commands.

Method Summary

Modifier and Type	Method and Description
void	addACL(ACL acl) Add an access control list entry to the access control list for this folder.
void	addMessageCountListener(MessageCountListener l)
Message[]	addMessages(Message[] msgs) Append the given messages into this folder.
void	addRights(ACL acl) Add the rights specified in the ACL to the entry for the identifier specified in the ACL.
void	appendMessages(Message[] msgs) Append the given messages into this folder.
AppendUID[]	appendUIDMessages(Message[] msgs) Append the given messages into this folder.
void	close(boolean expunge) Close this folder.
void	copyMessages(Message[] msgs, Folder folder) Copy the specified messages from this folder, to the specified destination.
boolean	create(int type) Create this folder, with the specified type.
boolean	delete(boolean recurse) Delete this folder.
java.lang.Object	doCommand(IMAPFolder.ProtocolCommand cmd) Execute a user-supplied IMAP command.
java.lang.Object	doCommandIgnoreFailure(IMAPFolder.ProtocolCommand cmd)
java.lang.Object	doOptionalCommand(java.lang.String err, IMAPFolder.ProtocolCommand cmd)
boolean	exists() Check whether this folder really exists on the server.
Message[]	expunge() Expunge all messages marked as DELETED.
Message[]	expunge(Message[] msgs) Expunge the indicated messages, which must have been marked as DELETED.
void	fetch(Message[] msgs, FetchProfile fp) Prefetch attributes, based on the given FetchProfile.
void	forceClose() Close this folder without waiting for the server.
ACL[]	getACL() Get the access control list entries for this folder.
java.lang.String[]	getAttributes() Get the attributes that the IMAP server returns with the LIST response.
int	getDeletedMessageCount() Get the deleted message count.
Folder	getFolder(java.lang.String name) Get the named subfolder.
java.lang.String	getFullName() Get the fullname of this folder.
Message	getMessage(int msgnum) Get the specified message.
Message	getMessageByUID(long uid) Get the Message corresponding to the given UID.
int	getMessageCount() Get the total message count.
Message[]	getMessagesByUID(long[] uids) Get the Messages specified by the given array.
Message[]	getMessagesByUID(long start, long end) Get the Messages specified by the given range.
java.lang.String	getName() Get the name of this folder.
int	getNewMessageCount() Get the new message count.
Folder	getParent() Get this folder's parent.
Flags	getPermanentFlags() Return the permanent flags supported by the server.
Quota[]	getQuota() Get the quotas for the quotaroot associated with this folder.
char	getSeparator() Get the separator character.
Message[]	getSortedMessages(SortTerm[] term) Sort the messages in the folder according to the sort criteria.
Message[]	getSortedMessages(SortTerm[] term, SearchTerm sterm) Sort the messages in the folder according to the sort criteria.
int	getType() Get the type of this folder.
long	getUID(Message message) Get the UID for the specified message.
long	getUIDNext() Returns the predicted UID that will be assigned to the next message that is appended to this folder.
long	getUIDValidity() Returns the UIDValidity for this folder.
int	getUnreadMessageCount() Get the unread message count.
void	handleResponse(Response r) The response handler.
boolean	hasNewMessages() Check whether this folder has new messages.
void	idle() 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.
void	idle(boolean once) Like idle(), but if once is true, abort the IDLE command after the first notification, to allow the caller to process any notification synchronously.
boolean	isOpen() Check whether this connection is really open.
boolean	isSubscribed() Check whether this folder is subscribed.
Folder[]	list(java.lang.String pattern) List all subfolders matching the specified pattern.
Rights[]	listRights(java.lang.String name) Get all the rights that may be allowed to the given identifier.
Folder[]	listSubscribed(java.lang.String pattern) List all subscribed subfolders matching the specified pattern.
Rights	myRights() Get the rights allowed to the currently authenticated user.
void	open(int mode) Open this folder in the given mode.
void	removeACL(java.lang.String name) Remove any access control list entry for the given identifier from the access control list for this folder.
void	removeRights(ACL acl) Remove the rights specified in the ACL from the entry for the identifier specified in the ACL.
boolean	renameTo(Folder f) Rename this folder.
Message[]	search(SearchTerm term) Search whole folder for messages matching the given term.
Message[]	search(SearchTerm term, Message[] msgs) Search the folder for messages matching the given term.
void	setFlags(int[] msgnums, Flags flag, boolean value) Set the specified flags for the given array of message numbers.
void	setFlags(int start, int end, Flags flag, boolean value) Set the specified flags for the given range of message numbers.
void	setFlags(Message[] msgs, Flags flag, boolean value) Set the specified flags for the given array of messages.
void	setQuota(Quota quota) Set the quotas for the quotaroot specified in the quota argument.
void	setSubscribed(boolean subscribe) Subscribe/Unsubscribe this folder.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getName

public java.lang.String getName()

Get the name of this folder.

getFullName

public java.lang.String getFullName()

Get the fullname of this folder.

getParent

public Folder getParent()
                 throws MessagingException

Get this folder's parent.

Throws:

MessagingException

exists

public boolean exists()
               throws MessagingException

Check whether this folder really exists on the server.

Throws:

MessagingException

list

public Folder[] list(java.lang.String pattern)
              throws MessagingException

List all subfolders matching the specified pattern.

Throws:

MessagingException

listSubscribed

public Folder[] listSubscribed(java.lang.String pattern)
                        throws MessagingException

List all subscribed subfolders matching the specified pattern.

Throws:

MessagingException

getSeparator

public char getSeparator()
                  throws MessagingException

Get the separator character.

Throws:

MessagingException

getType

public int getType()
            throws MessagingException

Get the type of this folder.

Throws:

MessagingException

isSubscribed

public boolean isSubscribed()

Check whether this folder is subscribed.

setSubscribed

public void setSubscribed(boolean subscribe)
                   throws MessagingException

Subscribe/Unsubscribe this folder.

Throws:

MessagingException

create

public boolean create(int type)
               throws MessagingException

Create this folder, with the specified type.

Throws:

MessagingException

hasNewMessages

public boolean hasNewMessages()
                       throws MessagingException

Check whether this folder has new messages.

Throws:

MessagingException

getFolder

public Folder getFolder(java.lang.String name)
                 throws MessagingException

Get the named subfolder.

Throws:

MessagingException

delete

public boolean delete(boolean recurse)
               throws MessagingException

Delete this folder.

Throws:

MessagingException

renameTo

public boolean renameTo(Folder f)
                 throws MessagingException

Rename this folder.

Throws:

MessagingException

open

public void open(int mode)
          throws MessagingException

Open this folder in the given mode.

Throws:

MessagingException

fetch

public void fetch(Message[] msgs,
                  FetchProfile fp)
           throws MessagingException

Prefetch attributes, based on the given FetchProfile.

Throws:

MessagingException

setFlags

public void setFlags(Message[] msgs,
                     Flags flag,
                     boolean value)
              throws MessagingException

Set the specified flags for the given array of messages.

Throws:

MessagingException

setFlags

public void setFlags(int start,
                     int end,
                     Flags flag,
                     boolean value)
              throws MessagingException

Set the specified flags for the given range of message numbers.

Throws:

MessagingException

setFlags

public void setFlags(int[] msgnums,
                     Flags flag,
                     boolean value)
              throws MessagingException

Set the specified flags for the given array of message numbers.

Throws:

MessagingException

close

public void close(boolean expunge)
           throws MessagingException

Close this folder.

Throws:

MessagingException

forceClose

public void forceClose()
                throws MessagingException

Close this folder without waiting for the server.

Throws:

MessagingException

isOpen

public boolean isOpen()

Check whether this connection is really open.

getPermanentFlags

public Flags getPermanentFlags()

Return the permanent flags supported by the server.

getMessageCount

public int getMessageCount()
                    throws MessagingException

Get the total message count.

Throws:

MessagingException

getNewMessageCount

public int getNewMessageCount()
                       throws MessagingException

Get the new message count.

Throws:

MessagingException

getUnreadMessageCount

public int getUnreadMessageCount()
                          throws MessagingException

Get the unread message count.

Throws:

MessagingException

getDeletedMessageCount

public int getDeletedMessageCount()
                           throws MessagingException

Get the deleted message count.

Throws:

MessagingException

getMessage

public Message getMessage(int msgnum)
                   throws MessagingException

Get the specified message.

Throws:

MessagingException

appendMessages

public void appendMessages(Message[] msgs)
                    throws MessagingException

Append the given messages into this folder.

Throws:

MessagingException

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 2359.

Throws:

MessagingException

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 2359.

Throws:

MessagingException

Since:

JavaMail 1.4

copyMessages

public void copyMessages(Message[] msgs,
                         Folder folder)
                  throws MessagingException

Copy the specified messages from this folder, to the specified destination.

Throws:

MessagingException

expunge

public Message[] expunge()
                  throws MessagingException

Expunge all messages marked as DELETED.

Throws:

MessagingException

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 2359.

Throws:

MessagingException

search

public Message[] search(SearchTerm term)
                 throws MessagingException

Search whole folder for messages matching the given term.

Throws:

MessagingException

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.

Throws:

MessagingException

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.

Throws:

MessagingException

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.

Throws:

MessagingException

Since:

JavaMail 1.4.4

addMessageCountListener

public void addMessageCountListener(MessageCountListener l)

getUIDValidity

public long getUIDValidity()
                    throws MessagingException

Returns the UIDValidity for this folder.

Throws:

MessagingException

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.

Returns:

the UIDNEXT value, or -1 if unknown

Throws:

MessagingException

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.

Throws:

MessagingException

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.

Throws:

MessagingException

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.

Throws:

MessagingException

getUID

public long getUID(Message message)
            throws MessagingException

Get the UID for the specified message.

Throws:

MessagingException

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.

Throws:

MessagingException

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.

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

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;
        }
 });
 

Throws:

MessagingException

doOptionalCommand

public java.lang.Object doOptionalCommand(java.lang.String err,
                                          IMAPFolder.ProtocolCommand cmd)
                                   throws MessagingException

Throws:

MessagingException

doCommandIgnoreFailure

public java.lang.Object doCommandIgnoreFailure(IMAPFolder.ProtocolCommand cmd)
                                        throws MessagingException

Throws:

MessagingException