public class

DefaultFolder

extends IMAPFolder

java.lang.Object
↳	com.google.code.javax.mail.Folder
	↳	com.google.code.com.sun.mail.imap.IMAPFolder
		↳	com.google.code.com.sun.mail.imap.DefaultFolder

Class Overview

The default IMAP folder (root of the naming hierarchy).

Summary

[Expand]

Inherited Constants

From class com.google.code.com.sun.mail.imap.IMAPFolder

From class com.google.code.javax.mail.Folder

From interface com.google.code.javax.mail.UIDFolder

[Expand]

Inherited Fields

From class com.google.code.com.sun.mail.imap.IMAPFolder

From class com.google.code.javax.mail.Folder

Protected Constructors
	DefaultFolder(IMAPStore store)

Public Methods
void	appendMessages(Message[] msgs) Append the given messages into this folder.
boolean	delete(boolean recurse) Delete this folder.
Message[]	expunge() Expunge all messages marked as DELETED.
Folder	getFolder(String name) Get the named subfolder.
synchronized String	getName() Get the name of this folder.
Folder	getParent() Get this folder's parent.
boolean	hasNewMessages() Check whether this folder has new messages.
synchronized Folder[]	list(String pattern) List all subfolders matching the specified pattern.
synchronized Folder[]	listSubscribed(String pattern) List all subscribed subfolders matching the specified pattern.
boolean	renameTo(Folder f) Rename this folder.

[Expand]

Inherited Methods

From class com.google.code.com.sun.mail.imap.IMAPFolder

void	addACL(ACL acl) Add an access control list entry to the access control list for this folder.
synchronized void	addMessageCountListener(MessageCountListener l) Add a listener for MessageCount events on this GmailFolder.
synchronized 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.
synchronized void	appendMessages(Message[] msgs) Append the given messages into this folder.
synchronized AppendUID[]	appendUIDMessages(Message[] msgs) Append the given messages into this folder.
void	checkClosed()
void	checkExists()
void	checkOpened()
void	checkRange(int msgno)
synchronized void	close(boolean expunge) Close this folder.
synchronized void	copyMessages(Message[] msgs, Folder folder) Copy the specified messages from this folder, to the specified destination.
synchronized boolean	create(int type) Create this folder, with the specified type.
synchronized boolean	delete(boolean recurse) Delete this folder.
Object	doCommand(IMAPFolder.ProtocolCommand cmd) Execute a user-supplied IMAP command.
Object	doCommandIgnoreFailure(IMAPFolder.ProtocolCommand cmd)
Object	doOptionalCommand(String err, IMAPFolder.ProtocolCommand cmd)
Object	doProtocolCommand(IMAPFolder.ProtocolCommand cmd)
synchronized boolean	exists() Check whether this folder really exists on the server.
synchronized Message[]	expunge(Message[] msgs) Expunge the indicated messages, which must have been marked as DELETED.
synchronized Message[]	expunge() Expunge all messages marked as DELETED.
synchronized void	fetch(Message[] msgs, FetchProfile fp) Prefetch attributes, based on the given FetchProfile.
synchronized void	forceClose() Close this folder without waiting for the server.
ACL[]	getACL() Get the access control list entries for this folder.
synchronized String[]	getAttributes() Get the attributes that the IMAP server returns with the LIST response.
synchronized int	getDeletedMessageCount() Get the deleted message count.
synchronized Folder	getFolder(String name) Get the named subfolder.
synchronized String	getFullName() Get the fullname of this folder.
synchronized Message	getMessage(int msgnum) Get the specified message.
IMAPMessage	getMessageBySeqNumber(int seqnum) Get the message object for the given sequence number.
synchronized Message	getMessageByUID(long uid) Get the Message corresponding to the given UID.
synchronized int	getMessageCount() Get the total message count.
synchronized Message[]	getMessagesByUID(long[] uids) Get the Messages specified by the given array.
synchronized Message[]	getMessagesByUID(long start, long end) Get the Messages specified by the given range.
synchronized String	getName() Get the name of this folder.
synchronized int	getNewMessageCount() Get the new message count.
synchronized Folder	getParent() Get this folder's parent.
synchronized Flags	getPermanentFlags() Return the permanent flags supported by the server.
IMAPProtocol	getProtocol() Return the IMAPProtocol object for this folder.
Quota[]	getQuota() Get the quotas for the quotaroot associated with this folder.
synchronized char	getSeparator() Get the separator character.
synchronized Message[]	getSortedMessages(SortTerm[] term, SearchTerm sterm) Sort the messages in the folder according to the sort criteria.
synchronized Message[]	getSortedMessages(SortTerm[] term) Sort the messages in the folder according to the sort criteria.
synchronized IMAPProtocol	getStoreProtocol() Get this folder's Store's protocol connection.
synchronized int	getType() Get the type of this folder.
synchronized long	getUID(Message message) Get the UID for the specified message.
synchronized long	getUIDNext() Returns the predicted UID that will be assigned to the next message that is appended to this folder.
synchronized long	getUIDValidity() Returns the UIDValidity for this folder.
synchronized int	getUnreadMessageCount() Get the unread message count.
void	handleResponse(Response r) The response handler.
synchronized boolean	hasNewMessages() Check whether this folder has new messages.
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.
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.
synchronized boolean	isOpen() Check whether this connection is really open.
synchronized boolean	isSubscribed() Check whether this folder is subscribed.
void	keepConnectionAlive(boolean keepStoreAlive) Issue a noop command for the connection if the connection has not been used in more than a second.
Folder[]	list(String pattern) List all subfolders matching the specified pattern.
Rights[]	listRights(String name) Get all the rights that may be allowed to the given identifier.
Folder[]	listSubscribed(String pattern) List all subscribed subfolders matching the specified pattern.
Rights	myRights() Get the rights allowed to the currently authenticated user.
synchronized void	open(int mode) Open this folder in the given mode.
void	releaseProtocol(boolean returnToPool) Release the protocol object.
synchronized void	releaseStoreProtocol(IMAPProtocol p) Release the store protocol object.
void	removeACL(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.
synchronized boolean	renameTo(Folder f) Rename this folder.
synchronized Message[]	search(SearchTerm term) Search whole folder for messages matching the given term.
synchronized Message[]	search(SearchTerm term, Message[] msgs) Search the folder for messages matching the given term.
synchronized void	setFlags(Message[] msgs, Flags flag, boolean value) Set the specified flags for the given array of messages.
synchronized void	setGoogleMessageLabels(Message[] msgs, String[] labels, boolean value)
void	setQuota(Quota quota) Set the quotas for the quotaroot specified in the quota argument.
synchronized void	setSubscribed(boolean subscribe) Subscribe/Unsubscribe this folder.
synchronized void	throwClosedException(ConnectionException cex) Throw the appropriate 'closed' exception.
Folder[]	xlist(String pattern)

From class com.google.code.javax.mail.Folder

synchronized void	addConnectionListener(ConnectionListener l) Add a listener for Connection events on this GmailFolder.
synchronized void	addFolderListener(FolderListener l) Add a listener for GmailFolder events on this GmailFolder.
synchronized void	addMessageChangedListener(MessageChangedListener l) Add a listener for MessageChanged events on this GmailFolder.
synchronized void	addMessageCountListener(MessageCountListener l) Add a listener for MessageCount events on this GmailFolder.
abstract void	appendMessages(Message[] msgs) Append given Messages to this folder.
abstract void	close(boolean expunge) Close this GmailFolder.
void	copyMessages(Message[] msgs, Folder folder) Copy the specified Messages from this GmailFolder into another GmailFolder.
abstract boolean	create(int type) Create this folder on the Store.
abstract boolean	delete(boolean recurse) Delete this GmailFolder.
abstract boolean	exists() Tests if this folder physically exists on the Store.
abstract Message[]	expunge() Expunge (permanently remove) messages marked DELETED.
void	fetch(Message[] msgs, FetchProfile fp) Prefetch the items specified in the FetchProfile for the given Messages.
void	finalize()
synchronized int	getDeletedMessageCount() Get the number of deleted messages in this GmailFolder.
abstract Folder	getFolder(String name) Return the GmailFolder object corresponding to the given name.
abstract String	getFullName() Returns the full name of this GmailFolder.
abstract Message	getMessage(int msgnum) Get the Message object corresponding to the given message number.
abstract int	getMessageCount() Get total number of messages in this GmailFolder.
synchronized Message[]	getMessages(int[] msgnums) Get the Message objects for message numbers specified in the array.
synchronized Message[]	getMessages() Get all Message objects from this GmailFolder.
synchronized Message[]	getMessages(int start, int end) Get the Message objects for message numbers ranging from start through end, both start and end inclusive.
int	getMode() Return the open mode of this folder.
abstract String	getName() Returns the name of this GmailFolder.
synchronized int	getNewMessageCount() Get the number of new messages in this GmailFolder.
abstract Folder	getParent() Returns the parent folder of this folder.
abstract Flags	getPermanentFlags() Get the permanent flags supported by this GmailFolder.
abstract char	getSeparator() Return the delimiter character that separates this GmailFolder's pathname from the names of immediate subfolders.
Store	getStore() Returns the Store that owns this GmailFolder object.
abstract int	getType() Returns the type of this GmailFolder, that is, whether this folder can hold messages or subfolders or both.
URLName	getURLName() Return a URLName representing this folder.
synchronized int	getUnreadMessageCount() Get the total number of unread messages in this GmailFolder.
abstract boolean	hasNewMessages() Returns true if this GmailFolder has new messages since the last time this indication was reset.
abstract boolean	isOpen() Indicates whether this GmailFolder is in the 'open' state.
boolean	isSubscribed() Returns true if this GmailFolder is subscribed.
Folder[]	list() Convenience method that returns the list of folders under this GmailFolder.
abstract Folder[]	list(String pattern) Returns a list of Folders belonging to this GmailFolder's namespace that match the specified pattern.
Folder[]	listSubscribed() Convenience method that returns the list of subscribed folders under this GmailFolder.
Folder[]	listSubscribed(String pattern) Returns a list of subscribed Folders belonging to this GmailFolder's namespace that match the specified pattern.
void	notifyConnectionListeners(int type) Notify all ConnectionListeners.
void	notifyFolderListeners(int type) Notify all FolderListeners registered on this GmailFolder and this folder's Store.
void	notifyFolderRenamedListeners(Folder folder) Notify all FolderListeners registered on this GmailFolder and this folder's Store about the renaming of this folder.
void	notifyMessageAddedListeners(Message[] msgs) Notify all MessageCountListeners about the addition of messages into this folder.
void	notifyMessageChangedListeners(int type, Message msg) Notify all MessageChangedListeners.
void	notifyMessageRemovedListeners(boolean removed, Message[] msgs) Notify all MessageCountListeners about the removal of messages from this GmailFolder.
abstract void	open(int mode) Open this GmailFolder.
synchronized void	removeConnectionListener(ConnectionListener l) Remove a Connection event listener.
synchronized void	removeFolderListener(FolderListener l) Remove a GmailFolder event listener.
synchronized void	removeMessageChangedListener(MessageChangedListener l) Remove a MessageChanged listener.
synchronized void	removeMessageCountListener(MessageCountListener l) Remove a MessageCount listener.
abstract boolean	renameTo(Folder f) Rename this GmailFolder.
Message[]	search(SearchTerm term) Search this GmailFolder for messages matching the specified search criterion.
Message[]	search(SearchTerm term, Message[] msgs) Search the given array of messages for those that match the specified search criterion.
synchronized void	setFlags(int start, int end, Flags flag, boolean value) Set the specified flags on the messages numbered from start through end, both start and end inclusive.
synchronized void	setFlags(Message[] msgs, Flags flag, boolean value) Set the specified flags on the messages specified in the array.
synchronized void	setFlags(int[] msgnums, Flags flag, boolean value) Set the specified flags on the messages whose message numbers are in the array.
void	setSubscribed(boolean subscribe) Subscribe or unsubscribe this GmailFolder.
String	toString() override the default toString(), it will return the String from GmailFolder.getFullName() or if that is null, it will use the default toString() behavior.
Folder[]	xlist()
abstract Folder[]	xlist(String pattern)

From class java.lang.Object

From interface com.google.code.com.sun.mail.iap.ResponseHandler

From interface com.google.code.javax.mail.UIDFolder

Protected Constructors

protected DefaultFolder (IMAPStore store)

Parameters

store

Public Methods

public void appendMessages (Message[] msgs)

Append the given messages into this folder.

Parameters

msgs	Array of Messages to be appended

Throws

MessagingException

public boolean delete (boolean recurse)

Delete this folder.

Parameters

recurse

Returns

true if the GmailFolder is deleted successfully

Throws

MessagingException

public Message[] expunge ()

Expunge all messages marked as DELETED.

Returns

array of expunged Message objects

Throws

MessagingException

public Folder getFolder (String name)

Get the named subfolder.

Parameters

name	Name of the GmailFolder

Returns

GmailFolder object

Throws

MessagingException

public synchronized String getName ()

Get the name of this folder.

Returns

name of the GmailFolder

public Folder getParent ()

Get this folder's parent.

Returns

Parent folder

public boolean hasNewMessages ()

Check whether this folder has new messages.

Returns

true if the Store has new Messages

Throws

MessagingException

public synchronized Folder[] list (String pattern)

List all subfolders matching the specified pattern.

Parameters

pattern	The match pattern

Returns

array of matching GmailFolder objects. An empty array is returned if no matching Folders exist.

Throws

MessagingException

public synchronized Folder[] listSubscribed (String pattern)

List all subscribed subfolders matching the specified pattern.

Parameters

pattern	The match pattern

Returns

array of matching subscribed GmailFolder objects. An empty array is returned if no matching subscribed folders exist.

Throws

MessagingException

public boolean renameTo (Folder f)

Rename this folder.

Parameters

f	A folder representing the new name for this GmailFolder

Returns

true if the GmailFolder is renamed successfully

Throws

MessagingException

Interfaces

Classes

DefaultFolder

Class Overview

Summary

Protected Constructors

protected DefaultFolder (IMAPStore store)

Parameters

Public Methods

public void appendMessages (Message[] msgs)

Parameters

Throws

public boolean delete (boolean recurse)

Parameters

Returns

Throws

public Message[] expunge ()

Returns

Throws

public Folder getFolder (String name)

Parameters

Returns

Throws

public synchronized String getName ()

Returns

public Folder getParent ()

Returns

public boolean hasNewMessages ()

Returns

Throws

public synchronized Folder[] list (String pattern)

Parameters

Returns

Throws

public synchronized Folder[] listSubscribed (String pattern)

Parameters

Returns

Throws

public boolean renameTo (Folder f)

Parameters

Returns

Throws