Java javax.mail Folder fields, constructors, methods, implement or subclass

Introduction

In this page you can find the methods, fields and constructors for javax.mail Folder.

The text is from its open source code.

Subclass

javax.mail.Folder has subclasses.
Click this link to see all its subclasses.

Field

int	HOLDS_MESSAGES This folder can contain messages
int	HOLDS_FOLDERS This folder can contain other folders
int	READ_ONLY The Folder is read only.
int	READ_WRITE The state and contents of this folder can be modified.

Method

void	addMessageCountListener(MessageCountListener l) Add a listener for MessageCount events on this Folder.
void	appendMessages(Message[] msgs) Append given Messages to this folder.
void	close(boolean expunge) Close this Folder.
void	copyMessages(Message[] msgs, Folder folder) Copy the specified Messages from this Folder into another Folder.
boolean	create(int type) Create this folder on the Store.
boolean	delete(boolean recurse) Delete this Folder.
boolean	exists() Tests if this folder physically exists on the Store.
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.
Folder	getFolder(String name) Return the Folder object corresponding to the given name.
String	getFullName() Returns the full name of this Folder.
Message	getMessage(int msgnum) Get the Message object corresponding to the given message number.
int	getMessageCount() Get total number of messages in this Folder.
Message[]	getMessages() Get all Message objects from this Folder.
Message[]	getMessages(int start, int end) Get the Message objects for message numbers ranging from start through end, both start and end inclusive.
Message[]	getMessages(int[] msgnums) Get the Message objects for message numbers specified in the array.
int	getMode() Return the open mode of this folder.
String	getName() Returns the name of this Folder.
int	getNewMessageCount() Get the number of new messages in this Folder.
Folder	getParent() Returns the parent folder of this folder.
Flags	getPermanentFlags() Get the permanent flags supported by this Folder.
char	getSeparator() Return the delimiter character that separates this Folder's pathname from the names of immediate subfolders.
Store	getStore() Returns the Store that owns this Folder object.
int	getType() Returns the type of this Folder, that is, whether this folder can hold messages or subfolders or both.
int	getUnreadMessageCount() Get the total number of unread messages in this Folder.
URLName	getURLName() Return a URLName representing this folder.
int	hashCode() Returns a hash code value for the object.
boolean	hasNewMessages() Returns true if this Folder has new messages since the last time this indication was reset.
boolean	isOpen() Indicates whether this Folder is in the 'open' state.
boolean	isSubscribed() Returns true if this Folder is subscribed.
Folder[]	list(String pattern) Returns a list of Folders belonging to this Folder's namespace that match the specified pattern.
Folder[]	list() Convenience method that returns the list of folders under this Folder.
void	open(int mode) Open this Folder.
boolean	renameTo(Folder f) Rename this Folder.
Message[]	search(SearchTerm term) Search this Folder for messages matching the specified search criterion.
void	setFlags(Message[] msgs, Flags flag, boolean value) Set the specified flags on the messages specified in the array.
void	setFlags(int[] msgnums, Flags flag, boolean value) Set the specified flags on the messages whose message numbers are in the array.
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.
void	setSubscribed(boolean subscribe) Subscribe or unsubscribe this Folder.
String	toString() override the default toString(), it will return the String from Folder.getFullName() or if that is null, it will use the default toString() behavior.