Top Description Fields Constructors Methods
com.sun.mail.imap

public Class DefaultFolder

extends IMAPFolder
Class Inheritance
Imports
javax.mail.Folder, .Message, .MessagingException, .MethodNotSupportedException, com.sun.mail.iap.ProtocolException, com.sun.mail.imap.protocol.IMAPProtocol, .ListInfo
The default IMAP folder (root of the naming hierarchy).
Author
John Mani

Field Summary

Inherited from com.sun.mail.imap.IMAPFolder:
attributesavailableFlagsexistsfullNameisNamespaceloggermessageCachemessageCacheLocknamepermanentFlagsprotocolseparatortypeuidTableUNKNOWN_SEPARATOR

Constructor Summary

AccessConstructor and Description
protected
DefaultFolder(IMAPStore store)

Method Summary

Modifier and TypeMethod and Description
public void
appendMessages(Message[]
array of Messages to be appended
msgs)

Overrides com.sun.mail.imap.IMAPFolder.appendMessages.

Append the given messages into this folder.
public boolean
delete(boolean
also delete subfolders?
recurse)

Overrides com.sun.mail.imap.IMAPFolder.delete.

Delete this folder.
public Message[]
expunge()

Overrides com.sun.mail.imap.IMAPFolder.expunge.

Expunge all messages marked as DELETED.
public Folder
getFolder(String
name of the Folder
name)

Overrides com.sun.mail.imap.IMAPFolder.getFolder.

Get the named subfolder.
public synchronized String
getName()

Overrides com.sun.mail.imap.IMAPFolder.getName.

Get the name of this folder.
public Folder
getParent()

Overrides com.sun.mail.imap.IMAPFolder.getParent.

Get this folder's parent.
public boolean
hasNewMessages()

Overrides com.sun.mail.imap.IMAPFolder.hasNewMessages.

Check whether this folder has new messages.
public synchronized Folder[]
list(final String
the match pattern
pattern)

Overrides com.sun.mail.imap.IMAPFolder.list.

List all subfolders matching the specified pattern.
public synchronized Folder[]
listSubscribed(final String
the match pattern
pattern)

Overrides com.sun.mail.imap.IMAPFolder.listSubscribed.

List all subscribed subfolders matching the specified pattern.
public boolean
renameTo(Folder
a folder representing the new name for this Folder
f)

Overrides com.sun.mail.imap.IMAPFolder.renameTo.

Rename this folder.
Inherited from com.sun.mail.imap.IMAPFolder:
addACLaddMessageCountListeneraddMessagesaddRightsappendUIDMessagescheckClosedcheckExistscheckOpenedcheckRangeclosecopyMessagescopyUIDMessagescreatedoCommanddoCommandIgnoreFailuredoOptionalCommanddoProtocolCommandexistsexpungefetchforceClosegetACLgetAttributesgetChannelgetDeletedMessageCountgetEnvelopeCommandgetFullNamegetHighestModSeqgetMessagegetMessageBySeqNumbergetMessageByUIDgetMessageCountgetMessagesgetMessagesBySeqNumbersgetMessagesByUIDgetMessagesByUIDgetMessagesByUIDChangedSincegetNewMessageCountgetPermanentFlagsgetProtocolgetQuotagetSeparatorgetSortedMessagesgetSortedMessagesgetStatusItemgetStoreProtocolgetTypegetUIDgetUIDNextgetUIDNotStickygetUIDValiditygetUnreadMessageCounthandleIdlehandleResponsehandleResponsesididleidleidleAbortidleAbortWaitisOpenisSubscribedkeepConnectionAlivelistRightsmoveMessagesmoveUIDMessagesmyRightsnewIMAPMessageopenopenreleaseProtocolreleaseStoreProtocolremoveACLremoveRightssearchsearchsetFlagssetFlagssetFlagssetQuotasetSubscribedstartIdlethrowClosedExceptionwaitIfIdle

Constructor Detail

DefaultFolderback to summary
protected DefaultFolder(IMAPStore store)

Method Detail

appendMessagesback to summary
public void appendMessages(Message[] msgs) throws MessagingException

Overrides com.sun.mail.imap.IMAPFolder.appendMessages.

Doc from com.sun.mail.imap.IMAPFolder.appendMessages.

Append the given messages into this folder.

Parameters
msgs:Message[]

Doc from javax.mail.Folder.appendMessages.

array of Messages to be appended

Annotations
@Override
Exceptions
MessagingException:

Doc from javax.mail.Folder.appendMessages.

if the append failed.

deleteback to summary
public boolean delete(boolean recurse) throws MessagingException

Overrides com.sun.mail.imap.IMAPFolder.delete.

Doc from com.sun.mail.imap.IMAPFolder.delete.

Delete this folder.

Parameters
recurse:boolean

Doc from javax.mail.Folder.delete.

also delete subfolders?

Returns:boolean

Doc from javax.mail.Folder.delete.

true if the Folder is deleted successfully

Annotations
@Override
Exceptions
MessagingException:

Doc from javax.mail.Folder.delete.

for other failures

expungeback to summary
public Message[] expunge() throws MessagingException

Overrides com.sun.mail.imap.IMAPFolder.expunge.

Doc from com.sun.mail.imap.IMAPFolder.expunge.

Expunge all messages marked as DELETED.

Returns:Message[]

Doc from javax.mail.Folder.expunge.

array of expunged Message objects

Annotations
@Override
Exceptions
MessagingException:

Doc from javax.mail.Folder.expunge.

for other failures

getFolderback to summary
public Folder getFolder(String name) throws MessagingException

Overrides com.sun.mail.imap.IMAPFolder.getFolder.

Doc from com.sun.mail.imap.IMAPFolder.getFolder.

Get the named subfolder.

Parameters
name:String

Doc from javax.mail.Folder.getFolder.

name of the Folder

Returns:Folder

Doc from javax.mail.Folder.getFolder.

Folder object

Annotations
@Override
Exceptions
MessagingException:

Doc from javax.mail.Folder.getFolder.

for failures

getNameback to summary
public synchronized String getName()

Overrides com.sun.mail.imap.IMAPFolder.getName.

Doc from com.sun.mail.imap.IMAPFolder.getName.

Get the name of this folder.

Returns:String

Doc from javax.mail.Folder.getName.

name of the Folder

Annotations
@Override
getParentback to summary
public Folder getParent()

Overrides com.sun.mail.imap.IMAPFolder.getParent.

Doc from com.sun.mail.imap.IMAPFolder.getParent.

Get this folder's parent.

Returns:Folder

Doc from javax.mail.Folder.getParent.

Parent folder

Annotations
@Override
hasNewMessagesback to summary
public boolean hasNewMessages() throws MessagingException

Overrides com.sun.mail.imap.IMAPFolder.hasNewMessages.

Doc from com.sun.mail.imap.IMAPFolder.hasNewMessages.

Check whether this folder has new messages.

Returns:boolean

Doc from javax.mail.Folder.hasNewMessages.

true if the Store has new Messages

Annotations
@Override
Exceptions
MessagingException:

Doc from javax.mail.Folder.hasNewMessages.

for other failures

listback to summary
public synchronized Folder[] list(final String pattern) throws MessagingException

Overrides com.sun.mail.imap.IMAPFolder.list.

Doc from com.sun.mail.imap.IMAPFolder.list.

List all subfolders matching the specified pattern.

Parameters
pattern:String

Doc from javax.mail.Folder.list.

the match pattern

Returns:Folder[]

Doc from javax.mail.Folder.list.

array of matching Folder objects. An empty array is returned if no matching Folders exist.

Annotations
@Override
Exceptions
MessagingException:

Doc from javax.mail.Folder.list.

for other failures

listSubscribedback to summary
public synchronized Folder[] listSubscribed(final String pattern) throws MessagingException

Overrides com.sun.mail.imap.IMAPFolder.listSubscribed.

Doc from com.sun.mail.imap.IMAPFolder.listSubscribed.

List all subscribed subfolders matching the specified pattern.

Parameters
pattern:String

Doc from javax.mail.Folder.listSubscribed.

the match pattern

Returns:Folder[]

Doc from javax.mail.Folder.listSubscribed.

array of matching subscribed Folder objects. An empty array is returned if no matching subscribed folders exist.

Annotations
@Override
Exceptions
MessagingException:

Doc from javax.mail.Folder.listSubscribed.

for other failures

renameToback to summary
public boolean renameTo(Folder f) throws MessagingException

Overrides com.sun.mail.imap.IMAPFolder.renameTo.

Doc from com.sun.mail.imap.IMAPFolder.renameTo.

Rename this folder.

Parameters
f:Folder

Doc from javax.mail.Folder.renameTo.

a folder representing the new name for this Folder

Returns:boolean

Doc from javax.mail.Folder.renameTo.

true if the Folder is renamed successfully

Annotations
@Override
Exceptions
MessagingException:

Doc from javax.mail.Folder.renameTo.

for other failures