Uses of Class
javax.mail.Folder
Packages that use Folder
Package
Description
An IMAP protocol provider for the Jakarta Mail API
that provides access to an IMAP message store.
A POP3 protocol provider for the Jakarta Mail API
that provides access to a POP3 message store.
Utility classes for use with the Jakarta Mail API.
The Jakarta Mail API
provides classes that model a mail system.
Listeners and events for the Jakarta Mail API.
Classes specific to Internet mail systems.
-
Uses of Folder in com.sun.mail.imap
Subclasses of Folder in com.sun.mail.imapModifier and TypeClassDescriptionclassThe default IMAP folder (root of the naming hierarchy).classThis class implements an IMAP folder.Methods in com.sun.mail.imap that return FolderModifier and TypeMethodDescriptionIMAPStore.getDefaultFolder()Get the default folder, representing the root of this user's namespace.Get the named subfolder.Get named folder.Get named folder.DefaultFolder.getParent()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[]Folder[]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 FolderModifier and TypeMethodDescriptionvoidIMAPFolder.copyMessages(Message[] msgs, Folder folder) Copy the specified messages from this folder, to the specified destination.IMAPFolder.copyUIDMessages(Message[] msgs, Folder folder) Copy the specified messages from this folder, to the specified destination.voidIMAPFolder.moveMessages(Message[] msgs, Folder folder) Move the specified messages from this folder, to the specified destination.IMAPFolder.moveUIDMessages(Message[] msgs, Folder folder) Move the specified messages from this folder, to the specified destination.booleanbooleanRename this folder.voidWatch the Folder for new messages and other events using the IMAP IDLE command.Constructors in com.sun.mail.imap with parameters of type Folder -
Uses of Folder in com.sun.mail.pop3
Subclasses of Folder in com.sun.mail.pop3Modifier and TypeClassDescriptionclassThe POP3 DefaultFolder.classA POP3 Folder (can only be "INBOX").Methods in com.sun.mail.pop3 that return FolderModifier and TypeMethodDescriptionPOP3Store.getDefaultFolder()Always throwsMessagingExceptionbecause no POP3 folders can contain subfolders.Only the name "INBOX" is supported.protected FolderDefaultFolder.getInbox()DefaultFolder.getParent()POP3Folder.getParent()Folder[]Folder[]Always throwsMessagingExceptionbecause no POP3 folders can contain subfolders.Methods in com.sun.mail.pop3 with parameters of type FolderModifier and TypeMethodDescriptionprotected POP3MessagePOP3Folder.createMessage(Folder f, int msgno) booleanbooleanAlways throwsMethodNotSupportedExceptionbecause the POP3 protocol doesn't support multiple folders.Constructors in com.sun.mail.pop3 with parameters of type Folder -
Uses of Folder in com.sun.mail.util
Methods in com.sun.mail.util that return FolderModifier and TypeMethodDescriptionFolderClosedIOException.getFolder()Returns the dead Folder objectConstructors in com.sun.mail.util with parameters of type FolderModifierConstructorDescriptionFolderClosedIOException(Folder folder) ConstructorFolderClosedIOException(Folder folder, String message) Constructor -
Uses of Folder in javax.mail
Fields in javax.mail declared as FolderModifier and TypeFieldDescriptionprotected FolderMessage.folderThe containing folder, if this message is obtained from a folderMethods in javax.mail that return FolderModifier and TypeMethodDescriptionabstract FolderStore.getDefaultFolder()Returns a Folder object that represents the 'root' of the default namespace presented to the user by the Store.abstract FolderReturn the Folder object corresponding to the given name.FolderClosedException.getFolder()Returns the dead Folder objectFolderNotFoundException.getFolder()Returns the offending Folder object.Message.getFolder()Get the folder from which this message was obtained.ReadOnlyFolderException.getFolder()Returns the Folder object.Get a closed Folder object for the given URLName.abstract FolderReturn the Folder object corresponding to the given name.abstract FolderReturn a closed Folder object, corresponding to the given URLName.abstract FolderFolder.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 foruser.Folder[]Folder.list()Convenience method that returns the list of folders under this Folder.abstract Folder[]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 javax.mail with parameters of type FolderModifier and TypeMethodDescriptionvoidFolder.copyMessages(Message[] msgs, Folder folder) Copy the specified Messages from this Folder into another Folder.protected voidStore.notifyFolderListeners(int type, Folder folder) Notify all FolderListeners.protected voidFolder.notifyFolderRenamedListeners(Folder folder) Notify all FolderListeners registered on this Folder and this folder's Store about the renaming of this folder.protected voidStore.notifyFolderRenamedListeners(Folder oldF, Folder newF) Notify all FolderListeners about the renaming of a folder.abstract booleanRename this Folder.Constructors in javax.mail with parameters of type FolderModifierConstructorDescriptionFolderClosedException(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(String s, Folder folder) Constructs a FolderNotFoundException with the specified detail message and the specified folder.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.protectedConstructor 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 javax.mail.event
Fields in javax.mail.event declared as FolderModifier and TypeFieldDescriptionprotected FolderFolderEvent.folderThe folder the event occurred on.protected FolderFolderEvent.newFolderThe folder that represents the new name, in case of a RENAMED event.Methods in javax.mail.event that return FolderModifier and TypeMethodDescriptionFolderEvent.getFolder()Return the affected 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 javax.mail.event with parameters of type FolderModifierConstructorDescriptionFolderEvent(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 javax.mail.internet
Constructors in javax.mail.internet with parameters of type FolderModifierConstructorDescriptionprotectedMimeMessage(Folder folder, int msgnum) Constructs an empty MimeMessage object with the given Folder and message number.protectedMimeMessage(Folder folder, InputStream is, int msgnum) Constructs a MimeMessage by reading and parsing the data from the specified MIME InputStream.protectedMimeMessage(Folder folder, InternetHeaders headers, byte[] content, int msgnum) Constructs a MimeMessage from the given InternetHeaders object and content.