gnu.mail.providers.imap
public class IMAPFolder extends Folder implements UIDFolder
Version: 0.1
Field Summary | |
---|---|
protected char | delimiter |
protected int | messageCount |
protected int | newMessageCount |
protected String | path
The folder path. |
protected Flags | permanentFlags |
protected boolean | subscribed |
protected int | type
The type of this folder(HOLDS_MESSAGES or HOLDS_FOLDERS). |
protected long | uidValidity |
Constructor Summary | |
---|---|
protected | IMAPFolder(Store store, String path)
Constructor. |
protected | IMAPFolder(Store store, String path, char delimiter)
Constructor. |
protected | IMAPFolder(Store store, String path, int type, char delimiter)
Constructor. |
Method Summary | |
---|---|
void | appendMessages(Message[] messages)
Appends the specified set of messages to this folder.
|
void | close(boolean expunge)
Closes this folder. |
boolean | create(int type)
Create this folder. |
boolean | delete(boolean flag)
Delete this folder. |
boolean | equals(Object other) |
boolean | exists()
Indicates whether this folder exists. |
Message[] | expunge()
Expunges this folder.
|
void | fetch(Message[] messages, FetchProfile fp)
IMAP fetch routine.
|
int | getDeletedMessageCount()
Returns the number of deleted messages in this folder. |
Folder | getFolder(String name)
Returns a subfolder with the specified name. |
String | getFullName()
Returns the full path of this folder. |
Message | getMessage(int msgnum)
Returns the specified message number from this folder.
|
Message | getMessageByUID(long uid) |
int | getMessageCount()
Returns the number of messages in this folder. |
int | getMessageCountByCriteria(String criteria)
Convenience method for returning the number of messages in the
current folder that match the single criteria. |
Message[] | getMessagesByUID(long start, long end) |
Message[] | getMessagesByUID(long[] uids) |
String | getName()
Returns the name of this folder. |
int | getNewMessageCount()
Returns the number of new messages in this folder. |
Folder | getParent()
Returns the parent folder of this folder. |
Flags | getPermanentFlags()
Returns the permanent flags for this folder. |
Quota[] | getQuota()
Returns the quotas for this folder. |
char | getSeparator()
Returns the path separator charcter. |
int | getType()
Returns the type of this folder. |
long | getUID(Message message) |
long | getUIDValidity() |
int | getUnreadMessageCount()
Returns the number of unread messages in this folder. |
boolean | hasNewMessages()
Indicates whether this folder contains new messages. |
boolean | isOpen()
Indicates whether this folder is open. |
boolean | isSubscribed() |
Folder[] | list(String pattern)
Returns the subfolders for this folder. |
Folder[] | listSubscribed(String pattern)
Returns the subscribed subfolders for this folder. |
void | open(int mode)
Opens this folder. |
boolean | renameTo(Folder folder)
Rename this folder. |
Message[] | search(SearchTerm term)
IMAP search function. |
Message[] | search(SearchTerm term, Message[] msgs)
IMAP search function. |
void | setSubscribed(boolean flag) |
MimeMessage
s are accepted.Parameters: expunge if the folder is to be expunged before it is closed
Throws: MessagingException if a messaging error occurred
Throws: MessagingException if a messaging error occurred
Throws: MessagingException if a messaging error occurred
See Also: getDeletedMessageCount
Throws: MessagingException if a messaging error occurred
Throws: MessagingException if a messaging error occurred
Throws: MessagingException if a messaging error occurred
Throws: MessagingException if a messaging error occurred
See Also: getUnreadMessageCount
Throws: MessagingException if a messaging error occurred
Throws: MessagingException if a messaging error occurred