|
Home · All Namespaces · All Classes · Grouped Classes · Modules · Functions | |
The QMailMessageKey class defines the parameters used for querying a subset of all available messages from the mail store. More...
#include <QMailMessageKey>
This class is under development and is subject to change.
The QMailMessageKey class defines the parameters used for querying a subset of all available messages from the mail store.
A QMailMessageKey is composed of a message property, an optional comparison operator and a comparison value. The QMailMessageKey class is used in conjunction with the QMailStore::queryMessages() and QMailStore::countMessages() functions to filter results which meet the criteria defined by the key.
QMailMessageKeys can be combined using the logical operators (&), (|) and (~) to create more refined queries.
For example:
To create a query for all messages sent from "joe@user.com" with subject "meeting":
QMailMessageKey subjectKey(QMailMessageKey::Subject,"meeting");
QMailMessageKey senderKey(QMailMessageKey::Sender,"joe@user.com")
QMailMessageIdList results = QMailStore::instance()->queryMessages(subjectKey & senderKey);
To query all unread messages from a specific folder:
QMailMessageIdList unreadMessagesInFolder(const QMailFolderId& folderId)
{
QMailMessageKey parentFolderKey(QMailMessageKey::ParentFolderId, folderId);
QMailMessageKey unreadKey(QMailMessageKey::Status, QMailMessage::Read, QMailDataComparator::Excludes);
return QMailStore::instance()->queryMessages(parentFolderKey & unreadKey);
}
See also QMailStore and QMailMessage.
This enum type describes the data query properties of a QMailMessage.
| Constant | Value | Description |
|---|---|---|
| QMailMessageKey::Id | 0x0001 | The ID of the message. |
| QMailMessageKey::Type | 0x0002 | The type of the message. |
| QMailMessageKey::ParentFolderId | 0x0004 | The parent folder ID this message is contained in. |
| QMailMessageKey::Sender | 0x0008 | The message sender address string. |
| QMailMessageKey::Recipients | 0x0010 | The message recipient address string. |
| QMailMessageKey::Subject | 0x0020 | The message subject string. |
| QMailMessageKey::TimeStamp | 0x0040 | The message timestamp |
| QMailMessageKey::Status | 0x0080 | The message status flags. |
| QMailMessageKey::FromMailbox | 0x0200 | The imap mailbox the message was downloaded from. |
| QMailMessageKey::ServerUid | 0x0400 | The IMAP server UID of the message. |
| QMailMessageKey::Size | 0x0800 | The size of the message. |
| QMailMessageKey::ParentAccountId | 0x1000 | The ID of the account the message was downloaded from. |
| QMailMessageKey::AncestorFolderIds | 0x2000 | The set of IDs of folders which are direct or indirect parents of this message. |
| QMailMessageKey::ContentType | 0x4000 | The type of data contained within the message. |
| QMailMessageKey::PreviousParentFolderId | 0x8000 | The parent folder ID this message was contained in, prior to moving to the current parent folder. |
The Properties type is a typedef for QFlags<Property>. It stores an OR combination of Property values.
Constructor which creates a default-constructed key (one for which isEmpty() returns true) that matches all messages. The logical negation of an empty key also matches all messages.
The result of combining an empty key with a non-empty key is the same as the original non-empty key. This is true regardless of whether the combination is formed by a logical AND or a logical OR operation.
The result of combining two empty keys is an empty key.
Construct a QMailMessageKey which defines a query parameter where QMailMessage::Property p is compared using comparison operator c with a value value.
Construct a QMailMessageKey which defines a query parameter where messages whose identifiers are in ids are returned.
Create a copy of the QMailMessageKey other.
Destroys the QMailMessageKey
Reads the contents of a QMailMessageKey from stream.
Returns true if the key remains empty after default construction; otherwise returns false.
See also isNonMatching().
Returns true if the key is a non-matching key; otherwise returns false.
See also isEmpty().
Returns a key that does not match any messages (unlike an empty key).
See also isNonMatching() and isEmpty().
Writes the contents of a QMailMessageKey to a stream.
Returns the QVariant representation of this QMailMessageKey.
Returns true if the value of this key is not the same as the key other. Returns false otherwise.
Returns a key that is the logical AND of this key and the value of key other.
Performs a logical AND with this key and the key other and assigns the result to this key.
Assign the value of the QMailMessageKey other to this.
Returns true if the value of this key is the same as the key other. Returns false otherwise.
Returns a key that is the logical OR of this key and the value of key other.
Performs a logical OR with this key and the key other and assigns the result to this key.
Returns a key that is the logical NOT of the value of this key.
| Copyright © 2009 Trolltech | Trademarks | Qt Extended 4.4.3 |