Uses of Class
jakarta.mail.Folder

Packages that use Folder

Package	Description
com.sun.mail.imap	An IMAP protocol provider for the Jakarta Mail API that provides access to an IMAP message store.
com.sun.mail.pop3	A POP3 protocol provider for the Jakarta Mail API that provides access to a POP3 message store.
com.sun.mail.util	Utility classes for use with the Jakarta Mail API.
jakarta.mail	The Jakarta Mail API provides classes that model a mail system.
jakarta.mail.event	Listeners and events for the Jakarta Mail API.
jakarta.mail.internet	Classes specific to Internet mail systems.

Uses of Folder in com.sun.mail.imap

Subclasses of Folder in com.sun.mail.imap

Modifier and Type	Class	Description
class	DefaultFolder	The default IMAP folder (root of the naming hierarchy).
class	IMAPFolder	This class implements an IMAP folder.

Methods in com.sun.mail.imap that return Folder

Modifier and Type	Method	Description
Folder	IMAPStore.getDefaultFolder()	Get the default folder, representing the root of this user's namespace.
Folder	DefaultFolder.getFolder(String name)
Folder	IMAPFolder.getFolder(String name)	Get the named subfolder.
Folder	IMAPStore.getFolder(URLName url)	Get named folder.
Folder	IMAPStore.getFolder(String name)	Get named folder.
Folder	DefaultFolder.getParent()
Folder	IMAPFolder.getParent()	Get this folder's parent.
Folder[]	IMAPStore.getPersonalNamespaces()	Using the IMAP NAMESPACE command (RFC 2342), return a set of folders representing the Personal namespaces.
Folder[]	IMAPStore.getSharedNamespaces()	Using the IMAP NAMESPACE command (RFC 2342), return a set of folders representing the Shared namespaces.
Folder[]	IMAPStore.getUserNamespaces(String user)	Using the IMAP NAMESPACE command (RFC 2342), return a set of folders representing the User's namespaces.
Folder[]	DefaultFolder.list(String pattern)
Folder[]	IMAPFolder.list(String pattern)	List all subfolders matching the specified pattern.
Folder[]	DefaultFolder.listSubscribed(String pattern)
Folder[]	IMAPFolder.listSubscribed(String pattern)	List all subscribed subfolders matching the specified pattern.

Methods in com.sun.mail.imap with parameters of type Folder

Modifier and Type	Method	Description
void	IMAPFolder.copyMessages(Message[] msgs, Folder folder)	Copy the specified messages from this folder, to the specified destination.
AppendUID[]	IMAPFolder.copyUIDMessages(Message[] msgs, Folder folder)	Copy the specified messages from this folder, to the specified destination.
void	IMAPFolder.moveMessages(Message[] msgs, Folder folder)	Move the specified messages from this folder, to the specified destination.
AppendUID[]	IMAPFolder.moveUIDMessages(Message[] msgs, Folder folder)	Move the specified messages from this folder, to the specified destination.
boolean	DefaultFolder.renameTo(Folder f)
boolean	IMAPFolder.renameTo(Folder f)	Rename this folder.
void	IdleManager.watch(Folder folder)	Watch the Folder for new messages and other events using the IMAP IDLE command.

Constructors in com.sun.mail.imap with parameters of type Folder

Constructor	Description
MessageVanishedEvent(Folder folder, long[] uids)	Constructor.

Uses of Folder in com.sun.mail.pop3

Subclasses of Folder in com.sun.mail.pop3

Modifier and Type	Class	Description
class	DefaultFolder	The POP3 DefaultFolder.
class	POP3Folder	A POP3 Folder (can only be "INBOX").

Methods in com.sun.mail.pop3 that return Folder

Modifier and Type	Method	Description
Folder	POP3Store.getDefaultFolder()
Folder	DefaultFolder.getFolder(String name)
Folder	POP3Folder.getFolder(String name)	Always throws MessagingException because no POP3 folders can contain subfolders.
Folder	POP3Store.getFolder(URLName url)
Folder	POP3Store.getFolder(String name)	Only the name "INBOX" is supported.
protected Folder	DefaultFolder.getInbox()
Folder	DefaultFolder.getParent()
Folder	POP3Folder.getParent()
Folder[]	DefaultFolder.list(String pattern)
Folder[]	POP3Folder.list(String pattern)	Always throws MessagingException because no POP3 folders can contain subfolders.

Methods in com.sun.mail.pop3 with parameters of type Folder

Modifier and Type	Method	Description
protected POP3Message	POP3Folder.createMessage(Folder f, int msgno)
boolean	DefaultFolder.renameTo(Folder f)
boolean	POP3Folder.renameTo(Folder f)	Always throws MethodNotSupportedException because the POP3 protocol doesn't support multiple folders.

Constructors in com.sun.mail.pop3 with parameters of type Folder

Constructor	Description
POP3Message(Folder folder, int msgno)

Uses of Folder in com.sun.mail.util

Methods in com.sun.mail.util that return Folder

Modifier and Type	Method	Description
Folder	FolderClosedIOException.getFolder()	Returns the dead Folder object

Constructors in com.sun.mail.util with parameters of type Folder

Constructor	Description
FolderClosedIOException(Folder folder)	Constructor
FolderClosedIOException(Folder folder, String message)	Constructor

Uses of Folder in jakarta.mail

Fields in jakarta.mail declared as Folder

Modifier and Type	Field	Description
protected Folder	Message.folder	The containing folder, if this message is obtained from a folder

Methods in jakarta.mail that return Folder

Modifier and Type	Method	Description
abstract Folder	Store.getDefaultFolder()	Returns a Folder object that represents the 'root' of the default namespace presented to the user by the Store.
abstract Folder	Folder.getFolder(String name)	Return the Folder object corresponding to the given name.
Folder	FolderClosedException.getFolder()	Returns the dead Folder object
Folder	FolderNotFoundException.getFolder()	Returns the offending Folder object.
Folder	Message.getFolder()	Get the folder from which this message was obtained.
Folder	ReadOnlyFolderException.getFolder()	Returns the Folder object.
Folder	Session.getFolder(URLName url)	Get a closed Folder object for the given URLName.
abstract Folder	Store.getFolder(URLName url)	Return a closed Folder object, corresponding to the given URLName.
abstract Folder	Store.getFolder(String name)	Return the Folder object corresponding to the given name.
abstract Folder	Folder.getParent()	Returns the parent folder of this folder.
Folder[]	Store.getPersonalNamespaces()	Return a set of folders representing the personal namespaces for the current user.
Folder[]	Store.getSharedNamespaces()	Return a set of folders representing the shared namespaces.
Folder[]	Store.getUserNamespaces(String user)	Return a set of folders representing the namespaces for user.
Folder[]	Folder.list()	Convenience method that returns the list of folders under this Folder.
abstract Folder[]	Folder.list(String pattern)	Returns a list of Folders belonging to this Folder's namespace that match the specified pattern.
Folder[]	Folder.listSubscribed()	Convenience method that returns the list of subscribed folders under this Folder.
Folder[]	Folder.listSubscribed(String pattern)	Returns a list of subscribed Folders belonging to this Folder's namespace that match the specified pattern.

Methods in jakarta.mail with parameters of type Folder

Modifier and Type	Method	Description
void	Folder.copyMessages(Message[] msgs, Folder folder)	Copy the specified Messages from this Folder into another Folder.
protected void	Store.notifyFolderListeners(int type, Folder folder)	Notify all FolderListeners.
protected void	Folder.notifyFolderRenamedListeners(Folder folder)	Notify all FolderListeners registered on this Folder and this folder's Store about the renaming of this folder.
protected void	Store.notifyFolderRenamedListeners(Folder oldF, Folder newF)	Notify all FolderListeners about the renaming of a folder.
abstract boolean	Folder.renameTo(Folder f)	Rename this Folder.

Constructors in jakarta.mail with parameters of type Folder

Constructor	Description
FolderClosedException(Folder folder)	Constructs a FolderClosedException.
FolderClosedException(Folder folder, String message)	Constructs a FolderClosedException with the specified detail message.
FolderClosedException(Folder folder, String message, Exception e)	Constructs a FolderClosedException with the specified detail message and embedded exception.
FolderNotFoundException(Folder folder)	Constructs a FolderNotFoundException.
FolderNotFoundException(Folder folder, String s)	Constructs a FolderNotFoundException with the specified detail message.
FolderNotFoundException(Folder folder, String s, Exception e)	Constructs a FolderNotFoundException with the specified detail message and embedded exception.
FolderNotFoundException(String s, Folder folder)	Constructs a FolderNotFoundException with the specified detail message and the specified folder.
Message(Folder folder, int msgnum)	Constructor that takes a Folder and a message number.
ReadOnlyFolderException(Folder folder)	Constructs a ReadOnlyFolderException with the specified folder and no detail message.
ReadOnlyFolderException(Folder folder, String message)	Constructs a ReadOnlyFolderException with the specified detail message.
ReadOnlyFolderException(Folder folder, String message, Exception e)	Constructs a ReadOnlyFolderException with the specified detail message and embedded exception.

Uses of Folder in jakarta.mail.event

Fields in jakarta.mail.event declared as Folder

Modifier and Type	Field	Description
protected Folder	FolderEvent.folder	The folder the event occurred on.
protected Folder	FolderEvent.newFolder	The folder that represents the new name, in case of a RENAMED event.

Methods in jakarta.mail.event that return Folder

Modifier and Type	Method	Description
Folder	FolderEvent.getFolder()	Return the affected folder.
Folder	FolderEvent.getNewFolder()	If this event indicates that a folder is renamed, (i.e, the event type is RENAMED), then this method returns the Folder object representing the new name.

Constructors in jakarta.mail.event with parameters of type Folder

Constructor	Description
FolderEvent(Object source, Folder folder, int type)	Constructor.
FolderEvent(Object source, Folder oldFolder, Folder newFolder, int type)	Constructor.
MessageCountEvent(Folder folder, int type, boolean removed, Message[] msgs)	Constructor.

Uses of Folder in jakarta.mail.internet

Constructors in jakarta.mail.internet with parameters of type Folder

Constructor	Description
MimeMessage(Folder folder, int msgnum)	Constructs an empty MimeMessage object with the given Folder and message number.
MimeMessage(Folder folder, InternetHeaders headers, byte[] content, int msgnum)	Constructs a MimeMessage from the given InternetHeaders object and content.
MimeMessage(Folder folder, InputStream is, int msgnum)	Constructs a MimeMessage by reading and parsing the data from the specified MIME InputStream.