java.lang.Object | +--javax.mail.Folder | +--gnu.mail.providers.imap.IMAPFolder
char | |
int | |
int | |
String | The folder path. |
int | The type of this folder (HOLDS_MESSAGES or HOLDS_FOLDERS). |
IMAPFolder(Store store, String path) Constructor. |
IMAPFolder(Store store, String path, char delimiter) Constructor. |
IMAPFolder(Store store, String path, int type, char delimiter) Constructor. |
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. |
getFolder(String name) Returns a subfolder with the specified name. | |
getFolder(String name, int type, char delimiter) Returns a configured subfolder. | |
String | Returns the full path of this folder. |
getMessage(int msgnum) Returns the specified message number from this folder. | |
int | Returns the number of messages in this folder. |
String | getName() Returns the name of this folder. |
int | Returns the number of new messages in this folder. |
Returns the parent folder of this folder. | |
Returns the permanent flags for this folder. | |
char | Returns the path separator charcter. |
int | getType() Returns the type of this folder. |
boolean | Indicates whether this folder contains new messages. |
boolean | isOpen() Indicates whether this folder is open. |
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 | Rename this folder. |
Message[] | search(SearchTerm term) IMAP search function. |
Message[] | search(SearchTerm term, Message msgs) IMAP search function. |
protected char delimiter
protected int messageCount
protected int newMessageCount
protected String path
protected Flags permanentFlags
protected int type
protected IMAPFolder(Store store, String path)
protected IMAPFolder(Store store, String path, char delimiter)
protected IMAPFolder(Store store, String path, int type, char delimiter)
public void appendMessages(Message messages)
MimeMessage
s are accepted.
public void close(boolean expunge)
MessagingException
- if a messaging error occurredpublic boolean create(int type)
public boolean delete(boolean flag)
public boolean equals(Object other)
public boolean exists()
MessagingException
- if a messaging error occurredpublic Message[] expunge()
MessagingException
- if a messaging error occurredpublic void fetch(Message messages, FetchProfile fp)
public Folder getFolder(String name)
protected IMAPFolder getFolder(String name, int type, char delimiter)
public String getFullName()
public Message getMessage(int msgnum)
MessagingException
- if a messaging error occurredpublic int getMessageCount()
MessagingException
- if a messaging error occurredpublic String getName()
public int getNewMessageCount()
MessagingException
- if a messaging error occurredpublic Folder getParent()
public Flags getPermanentFlags()
public char getSeparator()
public int getType()
MessagingException
- if a messaging error occurredpublic boolean hasNewMessages()
MessagingException
- if a messaging error occurredpublic boolean isOpen()
public Folder[] list(String pattern)
public Folder[] listSubscribed(String pattern)
public void open(int mode)
MessagingException
- if a messaging error occurredpublic boolean renameTo(Folder folder)
public Message[] search(SearchTerm term)
public Message[] search(SearchTerm term, Message msgs)