| Package | Description |
|---|---|
| com.sun.mail.imap |
An IMAP protocol provider for the JavaMail API
that provides access to an IMAP message store.
|
| com.sun.mail.pop3 |
A POP3 protocol provider for the JavaMail API
that provides access to a POP3 message store.
|
| javax.mail |
The JavaMailTM API
provides classes that model a mail system.
|
| javax.mail.event |
Listeners and events for the JavaMail API.
|
| javax.mail.internet |
Classes specific to Internet mail systems.
|
| Modifier and Type | Class | Description |
|---|---|---|
class |
IMAPFolder |
This class implements an IMAP folder.
|
| Modifier and Type | Method | Description |
|---|---|---|
Folder |
IMAPStore.getDefaultFolder() |
Get the default folder, representing the root of this user's
namespace.
|
Folder |
IMAPFolder.getFolder(java.lang.String name) |
Get the named subfolder.
|
Folder |
IMAPStore.getFolder(java.lang.String name) |
Get named folder.
|
Folder |
IMAPStore.getFolder(URLName url) |
Get named folder.
|
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(java.lang.String user) |
Using the IMAP NAMESPACE command (RFC 2342), return a set
of folders representing the User's namespaces.
|
Folder[] |
IMAPFolder.list(java.lang.String pattern) |
List all subfolders matching the specified pattern.
|
Folder[] |
IMAPFolder.listSubscribed(java.lang.String pattern) |
List all subscribed subfolders matching the specified pattern.
|
| Modifier and Type | Method | Description |
|---|---|---|
void |
IMAPFolder.copyMessages(Message[] msgs,
Folder folder) |
Copy the specified messages from this folder, to the
specified destination.
|
com.sun.mail.imap.AppendUID[] |
IMAPFolder.copyUIDMessages(Message[] msgs,
Folder folder) |
Copy the specified messages from this folder, to the
specified destination.
|
boolean |
IMAPFolder.renameTo(Folder f) |
Rename this folder.
|
| Modifier and Type | Class | Description |
|---|---|---|
class |
POP3Folder |
A POP3 Folder (can only be "INBOX").
|
| Modifier and Type | Method | Description |
|---|---|---|
Folder |
POP3Store.getDefaultFolder() |
|
Folder |
POP3Folder.getFolder(java.lang.String name) |
Always throws
MessagingException because no POP3 folders
can contain subfolders. |
Folder |
POP3Store.getFolder(java.lang.String name) |
Only the name "INBOX" is supported.
|
Folder |
POP3Store.getFolder(URLName url) |
|
Folder |
POP3Folder.getParent() |
|
Folder[] |
POP3Folder.list(java.lang.String pattern) |
Always throws
MessagingException because no POP3 folders
can contain subfolders. |
| Modifier and Type | Method | Description |
|---|---|---|
protected POP3Message |
POP3Folder.createMessage(Folder f,
int msgno) |
|
boolean |
POP3Folder.renameTo(Folder f) |
Always throws
MethodNotSupportedException
because the POP3 protocol doesn't support multiple folders. |
| Constructor | Description |
|---|---|
POP3Message(Folder folder,
int msgno) |
| Modifier and Type | Field | Description |
|---|---|---|
protected Folder |
Message.folder |
The containing folder, if this message is obtained from a 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(java.lang.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(java.lang.String name) |
Return the Folder object corresponding to the given name.
|
abstract Folder |
Store.getFolder(URLName url) |
Return a closed Folder object, corresponding to the given
URLName.
|
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(java.lang.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(java.lang.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(java.lang.String pattern) |
Returns a list of subscribed Folders belonging to this Folder's
namespace that match the specified pattern.
|
| 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.
|
| Constructor | Description |
|---|---|
FolderClosedException(Folder folder) |
Constructs a FolderClosedException.
|
FolderClosedException(Folder folder,
java.lang.String message) |
Constructs a FolderClosedException with the specified
detail message.
|
FolderClosedException(Folder folder,
java.lang.String message,
java.lang.Exception e) |
Constructs a FolderClosedException with the specified
detail message and embedded exception.
|
FolderNotFoundException(java.lang.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,
java.lang.String s) |
Constructs a FolderNotFoundException with the specified
detail message.
|
FolderNotFoundException(Folder folder,
java.lang.String s,
java.lang.Exception e) |
Constructs a FolderNotFoundException with the specified
detail message and embedded exception.
|
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,
java.lang.String message) |
Constructs a ReadOnlyFolderException with the specified
detail message.
|
ReadOnlyFolderException(Folder folder,
java.lang.String message,
java.lang.Exception e) |
Constructs a ReadOnlyFolderException with the specified
detail message and embedded exception.
|
| 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.
|
| 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.
|
| Constructor | Description |
|---|---|
FolderEvent(java.lang.Object source,
Folder folder,
int type) |
Constructor.
|
FolderEvent(java.lang.Object source,
Folder oldFolder,
Folder newFolder,
int type) |
Constructor.
|
MessageCountEvent(Folder folder,
int type,
boolean removed,
Message[] msgs) |
Constructor.
|
| Constructor | Description |
|---|---|
MimeMessage(Folder folder,
int msgnum) |
Constructs an empty MimeMessage object with the given Folder
and message number.
|
MimeMessage(Folder folder,
java.io.InputStream is,
int msgnum) |
Constructs a MimeMessage by reading and parsing the data from the
specified MIME InputStream.
|
MimeMessage(Folder folder,
InternetHeaders headers,
byte[] content,
int msgnum) |
Constructs a MimeMessage from the given InternetHeaders object
and content.
|
Copyright © 1996-2013, Oracle and/or its affiliates. All Rights Reserved. Use is subject to license terms< /a>.