oracle.mail.sdk.esmail
Class DefaultFolder

java.lang.Object
  |
  +--javax.mail.Folder
        |
        +--oracle.mail.sdk.esmail.OracleFolder
              |
              +--oracle.mail.sdk.esmail.DefaultFolder

All Implemented Interfaces:

javax.mail.UIDFolder

public class DefaultFolder

extends OracleFolder

The api(s) in this folder should not be directly used by the user. A default folder does not exist on the store. It is only used as the root/namespace folder. Folder operations such as rename, delete, append, expunge, open, close, create are disallowed on the default folder.

Inner classes inherited from class javax.mail.UIDFolder

javax.mail.UIDFolder.FetchProfileItem

Fields inherited from class javax.mail.Folder

HOLDS_FOLDERS, HOLDS_MESSAGES, READ_ONLY, READ_WRITE

Fields inherited from interface javax.mail.UIDFolder

LASTUID

Method Summary

void	appendMessages(javax.mail.Message[] msgs) Append messages to this folder.
void	close()
void	create()
boolean	delete(boolean recurse) Delete this folder.
boolean	exists() exists -- check if folder exists on store
javax.mail.Message[]	expunge() Expunge messages marked \DELETED.
javax.mail.Folder	getFolder(java.lang.String name) Returns the Folder object corresponding to the given name.
javax.mail.Message	getMessage(int msgnum) Get the Message object corresponding to the given message number.
int	getMessageCount() Return total number of messages in folder.
java.lang.String	getName() Return the cannonical name of the folder.
javax.mail.Folder	getParent() Return a new Folder object that represent the parent of this folder.
int	getType() Return the folder type which it HOLDS_FOLDER, HOLDS_MESSAGE.
boolean	hasNewMessages() Check whether folder has message with \RECENT flag set.
void	open()
boolean	renameTo(javax.mail.Folder folder) Rename this folder; notify the RenameListeners

Methods inherited from class oracle.mail.sdk.esmail.OracleFolder

addACI, addACI, appendMessages, close, copyMessages, create, fetch, getFolderId, getFolderSize, getFullName, getFullPath, getGranteeACI, getMessageByType, getMessageByUID, getMessagesByUID, getMessagesByUID, getNewMessageCount, getPermanentFlags, getSeparator, getUID, getUIDValidity, getUnreadMessageCount, getURLName, isOpen, isShared, isSubscribed, list, listSubscribed, modifyACI, modifyACI, open, removeACI, removeACI, search, search, setFlags, setFlags, setFlags, setSubscribed, sortMessages

Methods inherited from class javax.mail.Folder

addConnectionListener, addFolderListener, addMessageChangedListener, addMessageCountListener, getMessages, getMessages, getMessages, getMode, getStore, list, listSubscribed, removeConnectionListener, removeFolderListener, removeMessageChangedListener, removeMessageCountListener, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getName

public java.lang.String getName()

Description copied from class: OracleFolder

Return the cannonical name of the folder.

Overrides:

getName in class OracleFolder

Following copied from class: oracle.mail.sdk.esmail.OracleFolder

See Also:

javax.mail.Folder.getName

getParent

public javax.mail.Folder getParent()

Description copied from class: OracleFolder

Return a new Folder object that represent the parent of this folder.

Overrides:

getParent in class OracleFolder

Following copied from class: oracle.mail.sdk.esmail.OracleFolder

See Also:

javax.mail.Folder.getParent

hasNewMessages

public boolean hasNewMessages()
                       throws javax.mail.MessagingException

Description copied from class: OracleFolder

Check whether folder has message with \RECENT flag set. If folder is open, already know the number of recent msgs. If folder is closed, check for recent messages.

Overrides:

hasNewMessages in class OracleFolder

Following copied from class: oracle.mail.sdk.esmail.OracleFolder

See Also:

javax.mail.Folder.hasNewMessages

open

public void open()
          throws javax.mail.MessagingException

close

public void close()
           throws javax.mail.MessagingException

create

public void create()
            throws javax.mail.MessagingException

exists

public boolean exists()
               throws javax.mail.MessagingException

Description copied from class: OracleFolder

exists -- check if folder exists on store

Overrides:

exists in class OracleFolder

Following copied from class: oracle.mail.sdk.esmail.OracleFolder

See Also:

javax.mail.Folder.exists

delete

public boolean delete(boolean recurse)
               throws javax.mail.MessagingException

Description copied from class: OracleFolder

Delete this folder. If recurse is true, delete all the sub-folders as well. Notify listeners of the DELETE event. NOTE: The INBOX is case-sensitive, all caps. In addition, creation or deletion of any folder with the name inbox is not allowed.

Overrides:

delete in class OracleFolder

Following copied from class: oracle.mail.sdk.esmail.OracleFolder

See Also:

Folder.delete

getFolder

public javax.mail.Folder getFolder(java.lang.String name)
                            throws javax.mail.MessagingException

Description copied from class: OracleFolder

Returns the Folder object corresponding to the given name. It doesn't have to physically exist in the Store. NOTE: The INBOX is case-sensitive, all caps. In addition, creation or deletion of any folder with the name inbox is not allowed. ASSUME: name is relative to the current folder; abosolute path is NOT supported.

Overrides:

getFolder in class OracleFolder

Following copied from class: oracle.mail.sdk.esmail.OracleFolder

See Also:

javax.mail.Folder.getFolder

getMessage

public javax.mail.Message getMessage(int msgnum)
                              throws javax.mail.MessagingException

Description copied from class: OracleFolder

Get the Message object corresponding to the given message number.

Overrides:

getMessage in class OracleFolder

Following copied from class: oracle.mail.sdk.esmail.OracleFolder

See Also:

javax.mail.Folder.getMessage

getMessageCount

public int getMessageCount()
                    throws javax.mail.MessagingException

Description copied from class: OracleFolder

Return total number of messages in folder. NOTE: for optimization, we can just use the cached number, but it then may be out of sync with what is in the store.

Overrides:

getMessageCount in class OracleFolder

Following copied from class: oracle.mail.sdk.esmail.OracleFolder

See Also:

javax.mail.Folder.getMessageCount

renameTo

public boolean renameTo(javax.mail.Folder folder)
                 throws javax.mail.MessagingException

Description copied from class: OracleFolder

Rename this folder; notify the RenameListeners

Overrides:

renameTo in class OracleFolder

Following copied from class: oracle.mail.sdk.esmail.OracleFolder

See Also:

javax.mail.Folder.renameTo

appendMessages

public void appendMessages(javax.mail.Message[] msgs)
                    throws javax.mail.MessagingException

Description copied from class: OracleFolder

Append messages to this folder.

Overrides:

appendMessages in class OracleFolder

Following copied from class: oracle.mail.sdk.esmail.OracleFolder

Parameters:

msgs - Message objects to be append into this folder

See Also:

Folder.appendMessages

expunge

public javax.mail.Message[] expunge()
                             throws javax.mail.MessagingException

Description copied from class: OracleFolder

Expunge messages marked \DELETED. Returns an array containing the expunged message objects.

Overrides:

expunge in class OracleFolder

Following copied from class: oracle.mail.sdk.esmail.OracleFolder

See Also:

Folder.expunge()

getType

public int getType()
            throws javax.mail.MessagingException

Description copied from class: OracleFolder

Return the folder type which it HOLDS_FOLDER, HOLDS_MESSAGE. This information is from the cache; may be up of sync with the store.

Overrides:

getType in class OracleFolder

Following copied from class: oracle.mail.sdk.esmail.OracleFolder

See Also:

javax.mail.Folder.getType