DefaultFolder (JavaMail API documentation)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.sun.mail.imap
class DefaultFolder

javax.mail.Folder
  com.sun.mail.imap.IMAPFolder
      com.sun.mail.imap.DefaultFolder

All Implemented Interfaces:: ResponseHandler, UIDFolder

public class DefaultFolder
extends IMAPFolder

This class

Nested Class Summary

Nested classes/interfaces inherited from class com.sun.mail.imap.IMAPFolder
`IMAPFolder.FetchProfileItem, IMAPFolder.ProtocolCommand`

Field Summary

Fields inherited from class com.sun.mail.imap.IMAPFolder
`attributes, availableFlags, exists, fullName, isNamespace, messageCache, messageCacheLock, name, permanentFlags, protocol, separator, type, uidTable, UNKNOWN_SEPARATOR`

Fields inherited from class javax.mail.Folder
`HOLDS_FOLDERS, HOLDS_MESSAGES, mode, READ_ONLY, READ_WRITE, store`

Constructor Summary
`protected`	`DefaultFolder(IMAPStore store)`

Method Summary
`void`	`appendMessages(Message[] msgs)` Append the given messages into this folder.
`boolean`	`delete(boolean recurse)` Delete this folder.
`Message[]`	`expunge()` Expunge all messages marked as DELETED.
`Folder`	`getFolder(String name)` Get the named subfolder.
`String`	`getName()` Get the name of this folder.
`Folder`	`getParent()` Get this folder's parent.
`boolean`	`hasNewMessages()` Check whether this folder has new messages.
`Folder[]`	`list(String pattern)` List all subfolders matching the specified pattern.
`Folder[]`	`listSubscribed(String pattern)` List all subscribed subfolders matching the specified pattern.
`boolean`	`renameTo(Folder f)` Rename this folder.

Methods inherited from class com.sun.mail.imap.IMAPFolder
addACL, addMessages, addRights, appendMessages, appendUIDMessages, close, copyMessages, create, delete, doCommand, doCommandIgnoreFailure, doOptionalCommand, doProtocolCommand, exists, expunge, expunge, fetch, forceClose, getACL, getAttributes, getDeletedMessageCount, getFolder, getFullName, getMessage, getMessageByUID, getMessageCount, getMessagesByUID, getMessagesByUID, getName, getNewMessageCount, getParent, getPermanentFlags, getQuota, getSeparator, getStoreProtocol, getType, getUID, getUIDNext, getUIDValidity, getUnreadMessageCount, handleResponse, hasNewMessages, idle, isOpen, isSubscribed, list, listRights, listSubscribed, myRights, open, releaseStoreProtocol, removeACL, removeRights, renameTo, search, search, setFlags, setQuota, setSubscribed

Methods inherited from class com.sun.mail.imap.IMAPFolder


addACL, addMessages, addRights, appendMessages, appendUIDMessages, close, copyMessages, create, delete, doCommand, doCommandIgnoreFailure, doOptionalCommand, doProtocolCommand, exists, expunge, expunge, fetch, forceClose, getACL, getAttributes, getDeletedMessageCount, getFolder, getFullName, getMessage, getMessageByUID, getMessageCount, getMessagesByUID, getMessagesByUID, getName, getNewMessageCount, getParent, getPermanentFlags, getQuota, getSeparator, getStoreProtocol, getType, getUID, getUIDNext, getUIDValidity, getUnreadMessageCount, handleResponse, hasNewMessages, idle, isOpen, isSubscribed, list, listRights, listSubscribed, myRights, open, releaseStoreProtocol, removeACL, removeRights, renameTo, search, search, setFlags, setQuota, setSubscribed

Methods inherited from class javax.mail.Folder
addConnectionListener, addFolderListener, addMessageChangedListener, addMessageCountListener, appendMessages, close, copyMessages, create, delete, exists, expunge, fetch, finalize, getDeletedMessageCount, getFolder, getFullName, getMessage, getMessageCount, getMessages, getMessages, getMessages, getMode, getName, getNewMessageCount, getParent, getPermanentFlags, getSeparator, getStore, getType, getUnreadMessageCount, getURLName, hasNewMessages, isOpen, isSubscribed, list, list, listSubscribed, listSubscribed, notifyConnectionListeners, notifyFolderListeners, notifyFolderRenamedListeners, notifyMessageAddedListeners, notifyMessageChangedListeners, notifyMessageRemovedListeners, open, removeConnectionListener, removeFolderListener, removeMessageChangedListener, removeMessageCountListener, renameTo, search, search, setFlags, setFlags, setFlags, setSubscribed, toString

Methods inherited from class javax.mail.Folder


addConnectionListener, addFolderListener, addMessageChangedListener, addMessageCountListener, appendMessages, close, copyMessages, create, delete, exists, expunge, fetch, finalize, getDeletedMessageCount, getFolder, getFullName, getMessage, getMessageCount, getMessages, getMessages, getMessages, getMode, getName, getNewMessageCount, getParent, getPermanentFlags, getSeparator, getStore, getType, getUnreadMessageCount, getURLName, hasNewMessages, isOpen, isSubscribed, list, list, listSubscribed, listSubscribed, notifyConnectionListeners, notifyFolderListeners, notifyFolderRenamedListeners, notifyMessageAddedListeners, notifyMessageChangedListeners, notifyMessageRemovedListeners, open, removeConnectionListener, removeFolderListener, removeMessageChangedListener, removeMessageCountListener, renameTo, search, search, setFlags, setFlags, setFlags, setSubscribed, toString

Constructor Detail

DefaultFolder

protected DefaultFolder(IMAPStore store)

Parameters:: store

Method Detail

appendMessages

public void appendMessages(Message[] msgs)
                    throws MessagingException

Overrides:: appendMessages in class IMAPFolder
Parameters:: msgs
Throws:: MessagingException

delete

public boolean delete(boolean recurse)
               throws MessagingException

Overrides:: delete in class IMAPFolder
Parameters:: recurse
Throws:: MessagingException

expunge

public Message[] expunge()
                  throws MessagingException

Overrides:: expunge in class IMAPFolder
Throws:: MessagingException

getFolder

public Folder getFolder(String name)
                 throws MessagingException

Overrides:: getFolder in class IMAPFolder
Parameters:: name
Throws:: MessagingException

getName

public String getName()

Overrides:: getName in class IMAPFolder

getParent

public Folder getParent()

Overrides:: getParent in class IMAPFolder

hasNewMessages

public boolean hasNewMessages()
                       throws MessagingException

Overrides:: hasNewMessages in class IMAPFolder
Throws:: MessagingException

list

public Folder[] list(String pattern)
              throws MessagingException

Overrides:: list in class IMAPFolder
Parameters:: pattern
Throws:: MessagingException

listSubscribed

public Folder[] listSubscribed(String pattern)
                        throws MessagingException

Overrides:: listSubscribed in class IMAPFolder
Parameters:: pattern
Throws:: MessagingException

renameTo

public boolean renameTo(Folder f)
                 throws MessagingException

Overrides:: renameTo in class IMAPFolder
Parameters:: f
Throws:: MessagingException