oracle.mail.sdk.esmail
Class DefaultFolder

oracle.mail.sdk.esmail.OracleFolder
  |
  +--oracle.mail.sdk.esmail.DefaultFolder

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 oracle.mail.sdk.esmail.OracleFolder

OracleFolder.OracleFlag

Method Summary

void	appendMessages(javax.mail.Message[] msgs) Appends messages to this folder.
void	close()
void	create()
boolean	delete(boolean recurse) Deletes this folder.
boolean	exists() Checks if the folder exists on the store.
javax.mail.Message[]	expunge() Expunges messages marked \DELETED.
oracle.mail.sdk.esmail.Folder	getFolder(java.lang.String name) Returns the folder object corresponding to the given name.
javax.mail.Message	getMessage(int msgnum) Returns the message object corresponding to the given message number.
int	getMessageCount() Returns the total number of messages in a folder.
java.lang.String	getName() Returns the cannonical name of the folder.
oracle.mail.sdk.esmail.Folder	getParent() Returns a new folder object that represents the parent of this folder.
int	getType() Returns the folder type - HOLDS_FOLDER, HOLDS_MESSAGE.
boolean	hasNewMessages() Checks whether the folder has messages with the \RECENT flag set.
void	open()
boolean	renameTo(oracle.mail.sdk.esmail.Folder folder) Renames this folder and notifies the RenameListeners.

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

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

Method Detail

getName

public java.lang.String getName()

Description copied from class: OracleFolder

Returns the cannonical name of the folder.

Overrides:

getName in class OracleFolder

Tags copied from class: OracleFolder

See Also:

javax.mail.Folder.getName

getParent

public oracle.mail.sdk.esmail.Folder getParent()

Description copied from class: OracleFolder

Returns a new folder object that represents the parent of this folder.

Overrides:

getParent in class OracleFolder

Tags copied from class: OracleFolder

See Also:

javax.mail.Folder.getParent

hasNewMessages

public boolean hasNewMessages()
                       throws oracle.mail.sdk.esmail.MessagingException

Description copied from class: OracleFolder

Checks whether the folder has messages with the \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

Tags copied from class: OracleFolder

See Also:

javax.mail.Folder.hasNewMessages

open

public void open()
          throws oracle.mail.sdk.esmail.MessagingException

close

public void close()
           throws oracle.mail.sdk.esmail.MessagingException

create

public void create()
            throws oracle.mail.sdk.esmail.MessagingException

exists

public boolean exists()
               throws oracle.mail.sdk.esmail.MessagingException

Description copied from class: OracleFolder

Checks if the folder exists on the store.

Overrides:

exists in class OracleFolder

Tags copied from class: OracleFolder

See Also:

javax.mail.Folder.exists

delete

public boolean delete(boolean recurse)
               throws oracle.mail.sdk.esmail.MessagingException

Description copied from class: OracleFolder

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

Overrides:

delete in class OracleFolder

Tags copied from class: OracleFolder

See Also:

Folder.delete

getFolder

public oracle.mail.sdk.esmail.Folder getFolder(java.lang.String name)
                                        throws oracle.mail.sdk.esmail.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 capital letters. In addition, creation or deletion of any folder with the name inbox is not allowed. Assume that the folder name is relative to the current folder; absolute path is NOT supported.

Overrides:

getFolder in class OracleFolder

Tags copied from class: OracleFolder

See Also:

javax.mail.Folder.getFolder

getMessage

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

Description copied from class: OracleFolder

Returns the message object corresponding to the given message number.

Overrides:

getMessage in class OracleFolder

Tags copied from class: OracleFolder

See Also:

javax.mail.Folder.getMessage

getMessageCount

public int getMessageCount()
                    throws oracle.mail.sdk.esmail.MessagingException

Description copied from class: OracleFolder

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

Overrides:

getMessageCount in class OracleFolder

Tags copied from class: OracleFolder

See Also:

javax.mail.Folder.getMessageCount

renameTo

public boolean renameTo(oracle.mail.sdk.esmail.Folder folder)
                 throws oracle.mail.sdk.esmail.MessagingException

Description copied from class: OracleFolder

Renames this folder and notifies the RenameListeners.

Overrides:

renameTo in class OracleFolder

Tags copied from class: OracleFolder

See Also:

javax.mail.Folder.renameTo

appendMessages

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

Description copied from class: OracleFolder

Appends messages to this folder.

Overrides:

appendMessages in class OracleFolder

Tags copied from class: OracleFolder

Parameters:

msgs - Message objects to append into this folder

See Also:

Folder.appendMessages

expunge

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

Description copied from class: OracleFolder

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

Overrides:

expunge in class OracleFolder

Tags copied from class: OracleFolder

See Also:

Folder.expunge()

getType

public int getType()
            throws oracle.mail.sdk.esmail.MessagingException

Description copied from class: OracleFolder

Returns the folder type - HOLDS_FOLDER, HOLDS_MESSAGE. This information is from the cache; may be out of sync with the store.

Overrides:

getType in class OracleFolder

Tags copied from class: OracleFolder

See Also:

javax.mail.Folder.getType