Detailed Description
The QMessageFolder class provides an interface for folders containing messages in the messaging store.
QMessageFolder represents a folder of messages, either fully or partially stored in the messaging store. A QMessageFolder object has an optional parent of the same type, allowing folders to be arranged in tree structures. Messages may be associated with folders, allowing for simple classification and access by their parentFolderId property.
Member Function Documentation
QMessageFolder::QMessageFolder ()
Constructor that creates an empty and invalid QMessageFolder. An empty folder is one which has no path, no parent folder and no parent account. An invalid folder does not exist in the database and has an invalid id.
QMessageFolder::QMessageFolder ( const QMessageFolderId & id )
Constructor that creates a QMessageFolder by loading the data from the messaging store as specified by the QMessageFolderId id. If the folder does not exist in the messaging store, then this constructor will create an empty and invalid QMessageFolder.
QMessageFolder::QMessageFolder ( const QMessageFolder & other )
Constructs a copy of other.
QMessageFolder::~QMessageFolder () [virtual]
Destroys the QMessageFolder object.
Returns the identifier of the QMessageFolder object. A QMessageFolder with an invalid identifier does not yet exist in the messaging store.
QString QMessageFolder::name () const
Returns the display name of the folder suitable for viewing in a user interface. This is typically the same as, or a simplification of the path() for the folder.
QMessageAccountId QMessageFolder::parentAccountId () const
Returns the identifier of the parent account of the folder. If the folder is not linked to an account an invalid identifier is returned.
QMessageFolderId QMessageFolder::parentFolderId () const
Returns the identifier of the parent folder. This folder is a root folder if the parent identifier is invalid.
QString QMessageFolder::path () const
Returns the path of the folder.