B. mail::account Native API reference

A mail::account object represents a "mail account". An account is a collection of folders (mail::folder objects). The folders are arranged in a hierarchy, top to bottom. A folder must be "opened", before messages in the folder can be read. One folder, per account, can be opened at a time. Opening another folder closes the previous folder. mail::account objects contain methods for enumerating and navigating the mail::folder objects, and for accessing messages in the currently-open folder.

Most of the following mail::account methods are asynchronous. They do not wait for the requested action to complete. They accept a mail::callback, or one of its subclasses, as an argument. A completed request results in invoking either the success or the fail method of the mail::callback object. The mail::account methods return immediately even if the request cannot be completed immediately. The mail::account::process(3x) method handles outstanding requests, and it will invoke the success or the fail method when the request is finally completed.

Table of Contents
mail::account::checkNewMail -- Check for new mail
mail::account::copyMessagesTo -- Copy messages to another folder
mail::account::findFolder -- A direct short-cut to a folder
mail::account::folderFromString -- Restore a folder object
mail::account::getFolderIndexInfo -- Return message status
mail::account::getFolderIndexSize -- Return number of messages in the current folder
mail::account::getFolderKeywordInfo -- Return message keywords
mail::account::getSendFolder -- Create a folder object for sending mail
mail::account::hasCapability -- Mail account's properties
mail::account::isRemoteUrl -- Determine whether the account is a remote account
mail::account::logout -- Disconnect from the server
mail::account::moveMessagesTo -- Move messages to another folder
mail::account::open -- Open a new mail account
mail::account::poll -- Wait for the next event
mail::account::process -- Process pending events
mail::account::readMessageAttributes -- Return message metadata
mail::account::readMessageContent -- Read messages
mail::account::readMessageContentDecoded -- Read decoded message contents
mail::account::readTopLevelFolders -- Enumerate top-level folders
mail::account::removeMessages -- Remove messages from the folder
mail::account::resume -- Resume after a suspend
mail::account::saveFolderIndexInfo -- Update message status
mail::account::searchMessages -- Search messages in the current folder
mail::account::translatePath -- Convert readable folder path to internal folder path
mail::account::updateFolderIndexFlags -- Update status of multiple messages
mail::account::updateFolderIndexInfo -- Update status of the currently open folder
mail::account::updateKeywords -- Update message keywords
mail::account::updateNotify -- Request notification of folder updates