<<< PreviousNext >>>

D. mail::folder Native API reference

A mail::folder object represents a folder that contains messages and/or other folders. The folders are arranged in a top-to-bottom hierarchy. mail::account::readTopLevelFolders(3x) enumerates mail::folder objects at the top of the folder hierarchy. mail::folder::readSubFolders(3x) enumerates each mail::folder object's subfolders.

Like mail::account's methods, mail::folder's methods receive a mail::callback object, and invoke its success or fail method when the request is processed. mail::folder's methods return immediately, even if the request cannot be processed right away, and the mail::account::process(3x) method will invoke success or fail method at some later point in time.

Table of Contents
mail::folder::addMessage -- Add a message to a folder
mail::folder::clone -- Clone a mail::folder object
mail::folder::create -- Create a new folder
mail::folder::createSubFolder -- Create a new folder
mail::folder::delRights -- Delete an access control list identifier
mail::folder::destroy -- Destroy an existing folder
mail::folder::getMyRights -- Compute my access rights on a folder
mail::folder::getName -- Return the folder's name
mail::folder::getParentFolder -- Find parent folder
mail::folder::getPath -- Return the folder's server address
mail::folder::getRights -- Read access control list
mail::folder::hasMessages -- Determine if the folder is capable of storing messages
mail::folder::hasSubFolders -- Determine if the folder is capable of storing other folders
mail::folder::isparentof -- Check if another folder is this folder's subfolder
mail::folder::open -- Open a folder
mail::folder::readFolderInfo -- Get folder status
mail::folder::readSubFolders -- Enumerate subfolders
mail::folder::renameFolder -- Rename a folder
mail::folder::setRights -- Change access control lists
mail::folder::toString -- Save a folder object
<<< PreviousHomeNext >>>
mail::upperUpmail::folder::addMessage