Folder

This folder can contain other folders

This folder can contain messages

The GmailFolder is read only. The state and contents of this folder cannot be modified.

The state and contents of this folder can be modified.

The open mode of this folder. The open mode is GmailFolder.READ_ONLY, GmailFolder.READ_WRITE, or -1 if not known.

The parent store.

Constructor that takes a Store object.

Add a listener for Connection events on this GmailFolder.

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

Add a listener for GmailFolder events on this GmailFolder.

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

Add a listener for MessageChanged events on this GmailFolder.

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

Add a listener for MessageCount events on this GmailFolder.

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

Append given Messages to this folder. This method can be invoked on a closed GmailFolder. An appropriate MessageCountEvent is delivered to any MessageCountListener registered on this folder when the messages arrive in the folder.

GmailFolder implementations must not abort this operation if a Message in the given message array turns out to be an expunged Message.

Close this GmailFolder. This method is valid only on open Folders.

A CLOSED ConnectionEvent is delivered to any ConnectionListeners registered on this GmailFolder. Note that the folder is closed even if this method terminates abnormally by throwing a MessagingException.

Copy the specified Messages from this GmailFolder into another GmailFolder. This operation appends these Messages to the destination GmailFolder. The destination GmailFolder does not have to be opened. An appropriate MessageCountEvent is delivered to any MessageCountListener registered on the destination folder when the messages arrive in the folder.

Note that the specified Message objects must belong to this folder. GmailFolder implementations might be able to optimize this method by doing server-side copies.

This implementation just invokes appendMessages() on the destination folder to append the given Messages. Specific folder implementations that support server-side copies should do so, if the destination folder's Store is the same as this folder's Store. Also, an implementation must not abort the operation if a Message in the array turns out to be an expunged Message.

Create this folder on the Store. When this folder is created, any folders in its path that do not exist are also created.

If the creation is successful, a CREATED FolderEvent is delivered to any FolderListeners registered on this GmailFolder and this Store.

Delete this GmailFolder. This method will succeed only on a closed GmailFolder.

The recurse flag controls whether the deletion affects subfolders or not. If true, all subfolders are deleted, then this folder itself is deleted. If false, the behaviour is dependent on the folder type and is elaborated below:

• The folder can contain only messages: (type == HOLDS_MESSAGES).
  All messages within the folder are removed. The folder itself is then removed. An appropriate FolderEvent is generated by the Store and this folder.

• The folder can contain only subfolders: (type == HOLDS_FOLDERS).
  If this folder is empty (does not contain any subfolders at all), it is removed. An appropriate FolderEvent is generated by the Store and this folder.
  If this folder contains any subfolders, the delete fails and returns false.

• The folder can contain subfolders as well as messages:
  If the folder is empty (no messages or subfolders), it is removed. If the folder contains no subfolders, but only messages, then all messages are removed. The folder itself is then removed. In both the above cases, an appropriate FolderEvent is generated by the Store and this folder.

  If the folder contains subfolders there are 3 possible choices an implementation is free to do:

  1. The operation fails, irrespective of whether this folder contains messages or not. Some implementations might elect to go with this simple approach. The delete() method returns false.
  2. Any messages within the folder are removed. Subfolders are not removed. The folder itself is not removed or affected in any manner. The delete() method returns true. And the exists() method on this folder will return true indicating that this folder still exists.
     An appropriate FolderEvent is generated by the Store and this folder.
  3. Any messages within the folder are removed. Subfolders are not removed. The folder itself changes its type from HOLDS_FOLDERS | HOLDS_MESSAGES to HOLDS_FOLDERS. Thus new messages cannot be added to this folder, but new subfolders can be created underneath. The delete() method returns true indicating success. The exists() method on this folder will return true indicating that this folder still exists.
     An appropriate FolderEvent is generated by the Store and this folder.

Tests if this folder physically exists on the Store. This method can be invoked on a closed GmailFolder.

Expunge (permanently remove) messages marked DELETED. Returns an array containing the expunged message objects. The getMessageNumber method on each of these message objects returns that Message's original (that is, prior to the expunge) sequence number. A MessageCountEvent containing the expunged messages is delivered to any MessageCountListeners registered on the folder.

Expunge causes the renumbering of Message objects subsequent to the expunged messages. Clients that use message numbers as references to messages should be aware of this and should be prepared to deal with the situation (probably by flushing out existing message number caches and reloading them). Because of this complexity, it is better for clients to use Message objects as references to messages, rather than message numbers. Any expunged Messages objects still have to be pruned, but other Messages in that folder are not affected by the expunge.

After a message is expunged, only the isExpunged and getMessageNumber methods are still valid on the corresponding Message object; other methods may throw MessageRemovedException

Prefetch the items specified in the FetchProfile for the given Messages.

Clients use this method to indicate that the specified items are needed en-masse for the given message range. Implementations are expected to retrieve these items for the given message range in a efficient manner. Note that this method is just a hint to the implementation to prefetch the desired items.

An example is a client filling its header-view window with the Subject, From and X-mailer headers for all messages in the folder.

  Message[] msgs = folder.getMessages();

  FetchProfile fp = new FetchProfile();
  fp.add(FetchProfile.Item.ENVELOPE);
  fp.add("X-mailer");
  folder.fetch(msgs, fp);
  
  for (int i = 0; i < folder.getMessageCount(); i++) {
      display(msg[i].getFrom());
      display(msg[i].getSubject());
      display(msg[i].getHeader("X-mailer"));
  }

 

The implementation provided here just returns without doing anything useful. Providers wanting to provide a real implementation for this method should override this method.

Get the number of deleted messages in this GmailFolder.

This method can be invoked on a closed folder. However, note that for some folder implementations, getting the deleted message count can be an expensive operation involving actually opening the folder. In such cases, a provider can choose not to support this functionality in the closed state, in which case this method must return -1.

Clients invoking this method on a closed folder must be aware that this is a potentially expensive operation. Clients must also be prepared to handle a return value of -1 in this case.

This implementation returns -1 if this folder is closed. Else this implementation gets each Message in the folder using getMessage(int) and checks whether its DELETED flag is set. The total number of messages that have this flag set is returned.

Return the GmailFolder object corresponding to the given name. Note that this folder does not physically have to exist in the Store. The exists() method on a GmailFolder indicates whether it really exists on the Store.

In some Stores, name can be an absolute path if it starts with the hierarchy delimiter. Otherwise, it is interpreted relative to this GmailFolder.

GmailFolder objects are not cached by the Store, so invoking this method on the same name multiple times will return that many distinct GmailFolder objects.

This method can be invoked on a closed GmailFolder.

Returns the full name of this GmailFolder. If the folder resides under the root hierarchy of this Store, the returned name is relative to the root. Otherwise an absolute name, starting with the hierarchy delimiter, is returned.

This method can be invoked on a closed GmailFolder.

Get the Message object corresponding to the given message number. A Message object's message number is the relative position of this Message in its GmailFolder. Messages are numbered starting at 1 through the total number of message in the folder. Note that the message number for a particular Message can change during a session if other messages in the GmailFolder are deleted and the GmailFolder is expunged.

Message objects are light-weight references to the actual message that get filled up on demand. Hence GmailFolder implementations are expected to provide light-weight Message objects.

Unlike GmailFolder objects, repeated calls to getMessage with the same message number will return the same Message object, as long as no messages in this folder have been expunged.

Since message numbers can change within a session if the folder is expunged , clients are advised not to use message numbers as references to messages. Use Message objects instead.

Get total number of messages in this GmailFolder.

This method can be invoked on a closed folder. However, note that for some folder implementations, getting the total message count can be an expensive operation involving actually opening the folder. In such cases, a provider can choose not to support this functionality in the closed state, in which case this method must return -1.

Clients invoking this method on a closed folder must be aware that this is a potentially expensive operation. Clients must also be prepared to handle a return value of -1 in this case.

Get the Message objects for message numbers specified in the array.

Message objects are light-weight references to the actual message that get filled up on demand. Hence GmailFolder implementations are expected to provide light-weight Message objects.

This implementation uses getMessage(index) to obtain the required Message objects. Note that the returned array must contain msgnums.length Message objects

Get all Message objects from this GmailFolder. 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. GmailFolder 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.

Get the Message objects for message numbers ranging from start through end, both start and end inclusive. Note that message numbers start at 1, not 0.

Message objects are light-weight references to the actual message that get filled up on demand. Hence GmailFolder implementations are expected to provide light-weight Message objects.

This implementation uses getMessage(index) to obtain the required Message objects. Note that the returned array must contain (end-start+1) Message objects.

Return the open mode of this folder. Returns GmailFolder.READ_ONLY, GmailFolder.READ_WRITE, or -1 if the open mode is not known (usually only because an older GmailFolder provider has not been updated to use this new method).

Returns the name of this GmailFolder.

This method can be invoked on a closed GmailFolder.

Get the number of new messages in this GmailFolder.

This method can be invoked on a closed folder. However, note that for some folder implementations, getting the new message count can be an expensive operation involving actually opening the folder. In such cases, a provider can choose not to support this functionality in the closed state, in which case this method must return -1.

Clients invoking this method on a closed folder must be aware that this is a potentially expensive operation. Clients must also be prepared to handle a return value of -1 in this case.

This implementation returns -1 if this folder is closed. Else this implementation gets each Message in the folder using getMessage(int) and checks whether its RECENT flag is set. The total number of messages that have this flag set is returned.

Returns the parent folder of this folder. This method can be invoked on a closed GmailFolder. If this folder is the top of a folder hierarchy, this method returns null.

Note that since GmailFolder objects are not cached, invoking this method returns a new distinct GmailFolder object.

Get the permanent flags supported by this GmailFolder. Returns a Flags object that contains all the flags supported.

The special flag Flags.Flag.USER indicates that this GmailFolder supports arbitrary user-defined flags.

The supported permanent flags for a folder may not be available until the folder is opened.

Return the delimiter character that separates this GmailFolder's pathname from the names of immediate subfolders. This method can be invoked on a closed GmailFolder.

Returns the Store that owns this GmailFolder object. This method can be invoked on a closed GmailFolder.

Returns the type of this GmailFolder, that is, whether this folder can hold messages or subfolders or both. The returned value is an integer bitfield with the appropriate bits set. This method can be invoked on a closed folder.

Return a URLName representing this folder. The returned URLName does not include the password used to access the store.

Get the total number of unread messages in this GmailFolder.

This method can be invoked on a closed folder. However, note that for some folder implementations, getting the unread message count can be an expensive operation involving actually opening the folder. In such cases, a provider can choose not to support this functionality in the closed state, in which case this method must return -1.

Clients invoking this method on a closed folder must be aware that this is a potentially expensive operation. Clients must also be prepared to handle a return value of -1 in this case.

This implementation returns -1 if this folder is closed. Else this implementation gets each Message in the folder using getMessage(int) and checks whether its SEEN flag is set. The total number of messages that do not have this flag set is returned.

Returns true if this GmailFolder has new messages since the last time this indication was reset. When this indication is set or reset depends on the GmailFolder implementation (and in the case of IMAP, depends on the server). This method can be used to implement a lightweight "check for new mail" operation on a GmailFolder without opening it. (For example, a thread that monitors a mailbox and flags when it has new mail.) This method should indicate whether any messages in the GmailFolder have the RECENT flag set.

Note that this is not an incremental check for new mail, i.e., it cannot be used to determine whether any new messages have arrived since the last time this method was invoked. To implement incremental checks, the GmailFolder needs to be opened.

This method can be invoked on a closed GmailFolder that can contain Messages.

Indicates whether this GmailFolder is in the 'open' state.

Returns true if this GmailFolder is subscribed.

This method can be invoked on a closed GmailFolder.

The default implementation provided here just returns true.

Convenience method that returns the list of folders under this GmailFolder. This method just calls the list(String pattern) method with "%" as the match pattern. This method can be invoked on a closed GmailFolder.

Returns a list of Folders belonging to this GmailFolder's namespace that match the specified pattern. Patterns may contain the wildcard characters "%", which matches any character except hierarchy delimiters, and "*", which matches any character.

As an example, given the folder hierarchy:

    Personal/
       Finance/
          Stocks
          Bonus
          StockOptions
       Jokes
 

GmailFolder objects are not cached by the Store, so invoking this method on the same pattern multiple times will return that many distinct GmailFolder objects.

This method can be invoked on a closed GmailFolder.

Convenience method that returns the list of subscribed folders under this GmailFolder. This method just calls the listSubscribed(String pattern) method with "%" as the match pattern. This method can be invoked on a closed GmailFolder.

Returns a list of subscribed Folders belonging to this GmailFolder's namespace that match the specified pattern. If the folder does not support subscription, this method should resolve to list. (The default implementation provided here, does just this). The pattern can contain wildcards as for list.

Note that, at a given level of the folder hierarchy, a particular folder may not be subscribed, but folders underneath that folder in the folder hierarchy may be subscribed. In order to allow walking the folder hierarchy, such unsubscribed folders may be returned, indicating that a folder lower in the hierarchy is subscribed. The isSubscribed method on a folder will tell whether any particular folder is actually subscribed.

GmailFolder objects are not cached by the Store, so invoking this method on the same pattern multiple times will return that many distinct GmailFolder objects.

This method can be invoked on a closed GmailFolder.

Open this GmailFolder. This method is valid only on Folders that can contain Messages and that are closed.

If this folder is opened successfully, an OPENED ConnectionEvent is delivered to any ConnectionListeners registered on this GmailFolder.

The effect of opening multiple connections to the same folder on a specifc Store is implementation dependent. Some implementations allow multiple readers, but only one writer. Others allow multiple writers as well as readers.

Remove a Connection event listener.

The implementation provided here removes this listener from the internal list of ConnectionListeners.

Remove a GmailFolder event listener.

The implementation provided here removes this listener from the internal list of FolderListeners.

Remove a MessageChanged listener.

The implementation provided here removes this listener from the internal list of MessageChangedListeners.

Remove a MessageCount listener.

The implementation provided here removes this listener from the internal list of MessageCountListeners.

Rename this GmailFolder. This method will succeed only on a closed GmailFolder.

If the rename is successful, a RENAMED FolderEvent is delivered to FolderListeners registered on this folder and its containing Store.

Search this GmailFolder for messages matching the specified search criterion. Returns an array containing the matching messages . Returns an empty array if no matches were found.

This implementation invokes search(term, getMessages()), to apply the search over all the messages in this folder. Providers that can implement server-side searching might want to override this method to provide a more efficient implementation.

Search the given array of messages for those that match the specified search criterion. Returns an array containing the matching messages. Returns an empty array if no matches were found.

Note that the specified Message objects must belong to this folder.

This implementation iterates through the given array of messages, and applies the search criterion on each message by calling its match() method with the given term. The messages that succeed in the match are returned. Providers that can implement server-side searching might want to override this method to provide a more efficient implementation. If the search term is too complex or contains user-defined terms that cannot be executed on the server, providers may elect to either throw a SearchException or degenerate to client-side searching by calling super.search() to invoke this implementation.

Set the specified flags on the messages numbered from start through end, both start and end inclusive. Note that message numbers start at 1, not 0. This will result in appropriate MessageChangedEvents being delivered to any MessageChangedListener registered on this Message's containing folder.

Certain GmailFolder implementations can optimize the operation of setting Flags for a group of messages, so clients might want to use this method, rather than invoking Message.setFlags for each Message.

The default implementation uses getMessage(int) to get each Message object and then invokes setFlags on that object to set the flags. Specific GmailFolder implementations that can optimize this case should do so. Also, an implementation must not abort the operation if a message number refers to an expunged message.

Set the specified flags on the messages specified in the array. This will result in appropriate MessageChangedEvents being delivered to any MessageChangedListener registered on this Message's containing folder.

Note that the specified Message objects must belong to this folder. Certain GmailFolder implementations can optimize the operation of setting Flags for a group of messages, so clients might want to use this method, rather than invoking Message.setFlags for each Message.

This implementation degenerates to invoking setFlags() on each Message object. Specific GmailFolder implementations that can optimize this case should do so. Also, an implementation must not abort the operation if a Message in the array turns out to be an expunged Message.

Set the specified flags on the messages whose message numbers are in the array. This will result in appropriate MessageChangedEvents being delivered to any MessageChangedListener registered on this Message's containing folder.

Certain GmailFolder implementations can optimize the operation of setting Flags for a group of messages, so clients might want to use this method, rather than invoking Message.setFlags for each Message.

The default implementation uses getMessage(int) to get each Message object and then invokes setFlags on that object to set the flags. Specific GmailFolder implementations that can optimize this case should do so. Also, an implementation must not abort the operation if a message number refers to an expunged message.

Subscribe or unsubscribe this GmailFolder. Not all Stores support subscription.

This method can be invoked on a closed GmailFolder.

The implementation provided here just throws the MethodNotSupportedException.

override the default toString(), it will return the String from GmailFolder.getFullName() or if that is null, it will use the default toString() behavior.

Notify all ConnectionListeners. GmailFolder implementations are expected to use this method to broadcast connection events.

The provided implementation queues the event into an internal event queue. An event dispatcher thread dequeues events from the queue and dispatches them to the registered ConnectionListeners. Note that the event dispatching occurs in a separate thread, thus avoiding potential deadlock problems.

Notify all FolderListeners registered on this GmailFolder and this folder's Store. GmailFolder implementations are expected to use this method to broadcast GmailFolder events.

The implementation provided here queues the event into an internal event queue. An event dispatcher thread dequeues events from the queue and dispatches them to the FolderListeners registered on this folder. The implementation also invokes notifyFolderListeners on this folder's Store to notify any FolderListeners registered on the store.

Notify all FolderListeners registered on this GmailFolder and this folder's Store about the renaming of this folder. GmailFolder implementations are expected to use this method to broadcast GmailFolder events indicating the renaming of folders.

The implementation provided here queues the event into an internal event queue. An event dispatcher thread dequeues events from the queue and dispatches them to the FolderListeners registered on this folder. The implementation also invokes notifyFolderRenamedListeners on this folder's Store to notify any FolderListeners registered on the store.

Notify all MessageCountListeners about the addition of messages into this folder. GmailFolder implementations are expected to use this method to broadcast MessageCount events for indicating arrival of new messages.

The provided implementation queues the event into an internal event queue. An event dispatcher thread dequeues events from the queue and dispatches them to the registered MessageCountListeners. Note that the event dispatching occurs in a separate thread, thus avoiding potential deadlock problems.

Notify all MessageChangedListeners. GmailFolder implementations are expected to use this method to broadcast MessageChanged events.

The provided implementation queues the event into an internal event queue. An event dispatcher thread dequeues events from the queue and dispatches them to registered MessageChangedListeners. Note that the event dispatching occurs in a separate thread, thus avoiding potential deadlock problems.

Notify all MessageCountListeners about the removal of messages from this GmailFolder. GmailFolder implementations are expected to use this method to broadcast MessageCount events indicating removal of messages.

The provided implementation queues the event into an internal event queue. An event dispatcher thread dequeues events from the queue and dispatches them to the registered MessageCountListeners. Note that the event dispatching occurs in a separate thread, thus avoiding potential deadlock problems.