javax.mail
public abstract class Folder extends Object
Field Summary | |
---|---|
static int | HOLDS_FOLDERS
Flag that indicates that a folder can contain other folders. |
static int | HOLDS_MESSAGES
Flag that indicates that a folder can contain messages. |
protected int | mode
The current mode of this folder.
|
static int | READ_ONLY
Flag indicating that this folder cannot be modified. |
static int | READ_WRITE
Flag indictaing that this folder can be modified.
|
protected Store | store
The store that this folder is part of. |
Constructor Summary | |
---|---|
protected | Folder(Store store)
Constructor that initializes the Store.
|
Method Summary | |
---|---|
void | addConnectionListener(ConnectionListener listener) |
void | addFolderListener(FolderListener listener) |
void | addMessageChangedListener(MessageChangedListener listener) |
void | addMessageCountListener(MessageCountListener listener) |
abstract void | appendMessages(Message[] messages)
Append the supplied messages to this folder. |
abstract void | close(boolean expunge)
Close this folder; it must already be open.
|
void | copyMessages(Message[] messages, Folder folder)
Copy the specified messages to another folder.
|
abstract boolean | create(int type)
Create a new folder capable of containing subfoldera and/or messages as
determined by the type parameter. |
abstract boolean | delete(boolean recurse)
Delete this folder and possibly any subfolders. |
abstract boolean | exists()
Check to see if this folder physically exists in the store.
|
abstract Message[] | expunge()
Permanently delete all supplied messages that have the DELETED flag set from the Store.
|
void | fetch(Message[] messages, FetchProfile profile)
Hint to the store to prefetch information on the supplied messaged.
|
protected void | finalize()
Unregisters all listeners. |
int | getDeletedMessageCount()
Return the numbew of messages in this folder that have the Flag.DELETED flag set.
|
abstract Folder | getFolder(String name)
Get the Folder determined by the supplied name; if the name is relative
then it is interpreted relative to this folder. |
abstract String | getFullName()
Return the full absolute name of this folder.
|
abstract Message | getMessage(int index)
Retrieve the message with the specified index in this Folder;
messages indices start at 1 not zero.
|
abstract int | getMessageCount()
Return the number of messages this folder contains.
|
Message[] | getMessages(int start, int end)
Retrieve messages with index between start and end inclusive
|
Message[] | getMessages(int[] ids)
Retrieve messages with the specified indices.
|
Message[] | getMessages()
Retrieve all messages.
|
int | getMode()
Return the mode of this folder ass passed to Folder, or -1 if
the folder is closed.
|
abstract String | getName()
Return the name of this folder.
|
int | getNewMessageCount()
Return the numbew of messages in this folder that have the Flag.RECENT flag set.
|
abstract Folder | getParent()
Return the parent for this folder; if the folder is at the root of a heirarchy
this returns null.
|
abstract Flags | getPermanentFlags()
Get the flags supported by this folder.
|
abstract char | getSeparator()
Return the character used by this folder's Store to separate path components.
|
Store | getStore()
Return the store that this folder is part of.
|
abstract int | getType()
Return the type of this folder, indicating whether it can contain subfolders,
messages, or both. |
int | getUnreadMessageCount()
Return the numbew of messages in this folder that do not have the Flag.SEEN flag set.
|
URLName | getURLName()
Return the URLName for this folder, which includes the location of the store.
|
abstract boolean | hasNewMessages()
Check to see if this Folder conatins messages with the Flag.RECENT flag set.
|
abstract boolean | isOpen()
Indicates that the folder has been opened.
|
boolean | isSubscribed()
Determine if the user is subscribed to this Folder. |
abstract Folder[] | list(String pattern)
Return a list of folders from this Folder's namespace that match the supplied pattern.
|
Folder[] | list()
Convenience method that invokes list with the pattern "%".
|
Folder[] | listSubscribed(String pattern)
Return a list of folders to which the user is subscribed and which match the supplied pattern.
|
Folder[] | listSubscribed()
Convenience method that invokes listSubscribed with the pattern "%".
|
protected void | notifyConnectionListeners(int type) |
protected void | notifyFolderListeners(int type) |
protected void | notifyFolderRenamedListeners(Folder newFolder) |
protected void | notifyMessageAddedListeners(Message[] messages) |
protected void | notifyMessageChangedListeners(int type, Message message) |
protected void | notifyMessageRemovedListeners(boolean removed, Message[] messages) |
abstract void | open(int mode)
Open this folder; the folder must be able to contain messages and
must currently be closed. |
void | removeConnectionListener(ConnectionListener listener) |
void | removeFolderListener(FolderListener listener) |
void | removeMessageChangedListener(MessageChangedListener listener) |
void | removeMessageCountListener(MessageCountListener listener) |
abstract boolean | renameTo(Folder newName)
Rename this folder; the folder must be closed.
|
Message[] | search(SearchTerm term)
Search this folder for messages matching the supplied search criteria.
|
Message[] | search(SearchTerm term, Message[] messages)
Search the supplied messages for those that match the supplied criteria;
messages must belong to this folder.
|
void | setFlags(Message[] messages, Flags flags, boolean value)
Set flags on the messages to the supplied value; all messages must belong to this folder.
|
void | setFlags(int start, int end, Flags flags, boolean value)
Set flags on a range of messages to the supplied value.
|
void | setFlags(int[] ids, Flags flags, boolean value)
Set flags on a set of messages to the supplied value.
|
void | setSubscribed(boolean subscribed)
Set the user's subscription to this folder.
|
String | toString()
Returns the full name of this folder; if null, returns the value from the superclass. |
Parameters: store the store that this folder is part of
Parameters: messages the messages to append
Throws: MessagingException if there was a problem accessing the store
Parameters: expunge whether to expunge all deleted messages
Throws: MessagingException if there was a problem accessing the store; the folder is still closed
(Message[])
.Parameters: messages the messages to copy folder the folder to copy to
Throws: MessagingException if there was a problem accessing the store
CREATED FolderEvent
is sent to all FolderListeners registered with this Folder or with the Store.
Parameters: type the type, indicating if this folder should contain subfolders, messages or both
Returns: true if the folder was sucessfully created
Throws: MessagingException if there was a problem accessing the store
Parameters: recurse whether subfolders should be recursively deleted as well
Returns: true if the delete operation succeeds
Throws: MessagingException if there was a problem accessing the store
Returns: true if the folder really exists
Throws: MessagingException if there was a problem accessing the store
Returns: the original indices of messages that were actually deleted
Throws: MessagingException if there was a problem accessing the store
Parameters: messages messages for which information should be fetched profile the information to fetch
Throws: MessagingException if there was a problem accessing the store
See Also: FetchProfile
Returns: the number of new messages, or -1 if unknown
Throws: MessagingException if there was a problem accessing the store
Parameters: name the name of the folder to return
Returns: the named folder
Throws: MessagingException if there was a problem accessing the store
Returns: the full name of this folder
Parameters: index the index of the message to fetch
Returns: the message
Throws: MessagingException if there was a problem accessing the store
Returns: the number of messages, or -1 if unknown
Throws: MessagingException if there was a problem accessing the store
Parameters: start index of first message end index of last message
Returns: an array of messages from start to end inclusive
Throws: MessagingException if there was a problem accessing the store
Parameters: ids the indices of the messages to fetch
Returns: the specified messages
Throws: MessagingException if there was a problem accessing the store
Returns: all messages in this folder
Throws: MessagingException if there was a problem accessing the store
Returns: the mode this folder was opened with
Returns: this folder's name
Returns: the number of new messages, or -1 if unknown
Throws: MessagingException if there was a problem accessing the store
Returns: this folder's parent
Throws: MessagingException
Returns: the flags supported by this folder, or null if unknown
See Also: Flags
Returns: the name separater character
Throws: MessagingException if there was a problem accessing the store
Returns: the store this folder is part of
Returns: the type of this folder
Throws: MessagingException if there was a problem accessing the store
See Also: HOLDS_FOLDERS HOLDS_MESSAGES
Returns: the number of new messages, or -1 if unknown
Throws: MessagingException if there was a problem accessing the store
Returns: the URLName for this folder
Throws: MessagingException
Returns: true if the Store has recent messages
Throws: MessagingException if there was a problem accessing the store
Returns: true if the folder is open
Returns: true is the user is subscribed to this Folder
Parameters: pattern the pattern to search for
Returns: a, possibly empty, array containing Folders that matched the pattern
Throws: MessagingException if there was a problem accessing the store
Returns: a, possibly empty, array of subfolders
Throws: MessagingException if there was a problem accessing the store
Parameters: pattern the pattern to search for
Returns: a, possibly empty, array containing subscribed Folders that matched the pattern
Throws: MessagingException if there was a problem accessing the store
Returns: a, possibly empty, array of subscribed subfolders
Throws: MessagingException if there was a problem accessing the store
Parameters: mode READ_ONLY or READ_WRITE
Throws: MessagingException if there was a problem accessing the store
Parameters: newName the new name for this folder
Returns: true if the rename succeeded
Throws: MessagingException if there was a problem accessing the store
search(term, getMessages())
applying the search over all messages in the folder; subclasses may provide
a more efficient mechanism.
Parameters: term the search criteria
Returns: an array containing messages that match the criteria
Throws: MessagingException if there was a problem accessing the store
Parameters: term the search criteria messages the messages to search
Returns: an array containing messages that match the criteria
Throws: MessagingException if there was a problem accessing the store
Parameters: messages whose flags should be set flags the set of flags to modify value the value the flags should be set to
Throws: MessagingException if there was a problem accessing the store
Parameters: start first message end set end last message end set flags the set of flags end modify value the value the flags should be set end
Throws: MessagingException if there was a problem accessing the store
Parameters: ids the indexes of the messages to set flags the set of flags end modify value the value the flags should be set end
Throws: MessagingException if there was a problem accessing the store
Parameters: subscribed whether to subscribe to this Folder
Throws: MessagingException if there was a problem accessing the store MethodNotSupportedException if the Store does not support subscription
Returns: a string form of this folder