QMessageStore Class Reference

Detailed Description

The QMessageStore class represents the main interface for storage and retrieval of messages, folders and accounts in the messaging store.

The QMessageStore class is accessed through a singleton interface and provides functions for adding, updating and deleting messages in the messaging store.

QMessageStore provides the countFolders() and queryFolders() functions for counting and listing the folders contained by the messaging store, and the countAccounts() and queryAccounts() functions for counting and listing the accounts contained by the store. These functions use the QMessageFolderFilter and QMessageFolderOrdering classes, and the QMessageAccountFilter and QMessageAccountOrdering classes to constrain their searches.

QMessageStore also implements functionality allowing the messages contained by the store to be counted or listed, using various filtering and ordering constraints. Clients can access this functionality via the countMessages and queryMessages functions of the QMessageServiceAction class.

With the exception of Windows mobile and desktop platforms, QMessageStore functions should not initiate network activity. Instead functions are restricted to operating on data already on the device. See QMessageServiceAction for functions related to initiating network activity.

If a QMessageStore operation fails, the lastError() function will return an error code value indicating the failure mode encountered. A successful operation will set the lastError() result to QMessageStore::NoError.

Messages in the messaging store are identified by QMessageId objects. The data associated with a message is retrieved in the form of a QMessage object using message(). Likewise a folder is retrieved in the form of a QMessageFolder object using folder(), and an account is retrieved in the form of a QMessageAccount object using account().

Messages can be inserted into the store using the addMessage() function, messages in the store can be manipulated via the updateMessage() function ,and removed by the removeMessage() functions.

Messaging store manipulations involving messages are reported via the messagesAdded(), messagesUpdated() and messagesRemoved() signals.

See also QMessage, QMessageId, QMessageContentContainerId, and QMessageServiceAction.

Member Type Documentation

    bool removeMessages(const QMessageIdList& ids)
    {
        QMessageFilter idsFilter(ids);
        return QMessageStore::instance()->removeMessages(idsFilter);
    }