![]() |
Home | ![]() |
The QMailMessageSortKey class defines the parameters used for sorting a subset of queried messages from the mail store. More...
#include <QMailMessageSortKey>
This class is under development and is subject to change.
typedef | ArgumentType |
enum | Property { Id, Type, ParentFolderId, Sender, ..., RfcId } |
QMailMessageSortKey () | |
QMailMessageSortKey ( const QMailMessageSortKey & other ) | |
virtual | ~QMailMessageSortKey () |
const QList<ArgumentType> & | arguments () const |
void | deserialize ( Stream & stream ) |
bool | isEmpty () const |
void | serialize ( Stream & stream ) const |
bool | operator!= ( const QMailMessageSortKey & other ) const |
QMailMessageSortKey | operator& ( const QMailMessageSortKey & other ) const |
QMailMessageSortKey & | operator&= ( const QMailMessageSortKey & other ) |
QMailMessageSortKey & | operator= ( const QMailMessageSortKey & other ) |
bool | operator== ( const QMailMessageSortKey & other ) const |
QMailMessageSortKey | contentType ( Qt::SortOrder order = Qt::AscendingOrder ) |
QMailMessageSortKey | copyServerUid ( Qt::SortOrder order = Qt::AscendingOrder ) |
QMailMessageSortKey | id ( Qt::SortOrder order = Qt::AscendingOrder ) |
QMailMessageSortKey | listId ( Qt::SortOrder order = Qt::AscendingOrder ) |
QMailMessageSortKey | messageType ( Qt::SortOrder order = Qt::AscendingOrder ) |
QMailMessageSortKey | parentAccountId ( Qt::SortOrder order = Qt::AscendingOrder ) |
QMailMessageSortKey | parentFolderId ( Qt::SortOrder order = Qt::AscendingOrder ) |
QMailMessageSortKey | previousParentFolderId ( Qt::SortOrder order = Qt::AscendingOrder ) |
QMailMessageSortKey | receptionTimeStamp ( Qt::SortOrder order = Qt::AscendingOrder ) |
QMailMessageSortKey | recipients ( Qt::SortOrder order = Qt::AscendingOrder ) |
QMailMessageSortKey | restoreFolderId ( Qt::SortOrder order = Qt::AscendingOrder ) |
QMailMessageSortKey | rfcId ( Qt::SortOrder order = Qt::AscendingOrder ) |
QMailMessageSortKey | sender ( Qt::SortOrder order = Qt::AscendingOrder ) |
QMailMessageSortKey | serverUid ( Qt::SortOrder order = Qt::AscendingOrder ) |
QMailMessageSortKey | size ( Qt::SortOrder order = Qt::AscendingOrder ) |
QMailMessageSortKey | status ( quint64 mask, Qt::SortOrder order = Qt::DescendingOrder ) |
QMailMessageSortKey | subject ( Qt::SortOrder order = Qt::AscendingOrder ) |
QMailMessageSortKey | timeStamp ( Qt::SortOrder order = Qt::AscendingOrder ) |
The QMailMessageSortKey class defines the parameters used for sorting a subset of queried messages from the mail store.
A QMailMessageSortKey is composed of a message property to sort and a sort order. The QMailMessageSortKey class is used in conjunction with the QMailStore::queryMessages() function to sort message results according to the criteria defined by the sort key.
For example: To create a query for all messages sorted by their timestamp in decending order:
QMailMessageSortKey sortKey(QMailMessageSortKey::timeStamp(Qt::DescendingOrder)); QMailIdList results = QMailStore::instance()->queryMessages(QMailMessageKey(), sortKey);
See also QMailStore and QMailMessageKey.
Defines the type used to represent a single sort criterion of a message sort key.
This enum type describes the sortable data properties of a QMailFolder.
Constant | Value | Description |
---|---|---|
QMailMessageSortKey::Id | 0 | The ID of the message. |
QMailMessageSortKey::Type | 1 | The type of the message. |
QMailMessageSortKey::ParentFolderId | 2 | The parent folder ID this message is contained in. |
QMailMessageSortKey::Sender | 3 | The message sender address string. |
QMailMessageSortKey::Recipients | 4 | The message recipient address string. |
QMailMessageSortKey::Subject | 5 | The message subject string. |
QMailMessageSortKey::TimeStamp | 6 | The message origination timestamp. |
QMailMessageSortKey::ReceptionTimeStamp | 7 | The message reception timestamp. |
QMailMessageSortKey::Status | 8 | The message status flags. |
QMailMessageSortKey::ServerUid | 9 | The IMAP server UID of the message. |
QMailMessageSortKey::ParentAccountId | 11 | The ID of the account the mesasge was downloaded from. |
QMailMessageSortKey::Size | 10 | The size of the message. |
QMailMessageSortKey::ContentType | 12 | The type of data contained within the message. |
QMailMessageSortKey::PreviousParentFolderId | 13 | The parent folder ID this message was contained in, prior to moving to the current parent folder. |
QMailMessageSortKey::CopyServerUid | 14 | The server uid of the message this is a copy of |
QMailMessageSortKey::ListId | 15 | The name of the list |
QMailMessageSortKey::RestoreFolderId | 16 | The folderId of where the message should be restored to |
QMailMessageSortKey::RfcId | 17 | The messages rfc id |
Create a QMailMessageSortKey with specifying matching parameters.
A default-constructed key (one for which isEmpty() returns true) sorts no messages.
The result of combining an empty key with a non-empty key is the same as the original non-empty key.
The result of combining two empty keys is an empty key.
Create a copy of the QMailMessageSortKey other.
Destroys this QMailMessageSortKey.
Returns the list of arguments to this QMailMessageSortKey.
Returns a key that sorts messages by their content types, according to order.
See also QMailMessage::content().
Returns a key that sorts messages by their copy server identifiers, according to order.
See also QMailMessage::copyServerUid().
Reads the contents of a QMailMessageSortKey from stream.
Returns a key that sorts messages by their identifiers, according to order.
See also QMailMessage::id().
Returns true if the key remains empty after default construction; otherwise returns false.
Returns a key that sorts messages by list identifier according to order.
See also QMailMessage::listId().
Returns a key that sorts messages by their message type, according to order.
See also QMailMessage::messageType().
Returns a key that sorts messages by their parent accounts' identifiers, according to order.
See also QMailMessage::parentAccountId().
Returns a key that sorts messages by their parent folders' identifiers, according to order.
See also QMailMessage::parentFolderId().
Returns a key that sorts messages by their previous parent folders' identifiers, according to order.
See also QMailMessage::previousParentFolderId().
Returns a key that sorts messages by their reception timestamp, according to order.
See also QMailMessage::receivedDate().
Returns a key that sorts messages by the addresses to which they were sent, according to order.
See also QMailMessage::to().
Returns a key that sorts messages by their restore folder identifiers, according to order.
See also QMailMessage::restoreFolderId().
Returns a key that sorts messages by the address from which they were sent, according to order.
See also QMailMessage::from().
Writes the contents of a QMailMessageSortKey to a stream.
Returns a key that sorts messages by their server identifiers, according to order.
See also QMailMessage::serverUid().
Returns a key that sorts messages by their size, according to order.
See also QMailMessage::size().
Returns a key that sorts messages by comparing their status value bitwise ANDed with mask, according to order.
See also QMailMessage::status().
Returns a key that sorts messages by their subject, according to order.
See also QMailMessage::subject().
Returns a key that sorts messages by their origination timestamp, according to order.
See also QMailMessage::date().
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 QMailMessageSortKey other to this.
Returns true if the value of this key is the same as the key other. Returns false otherwise.
Copyright © 2010 QtSoftware | Messaging Framework |