The QMessageFilter class defines the parameters used for querying a subset of all available messages from the messaging store. More...
#include <QMessageFilter>
QMessageFilter () | |
QMessageFilter ( const QMessageFilter & other ) | |
virtual | ~QMessageFilter () |
bool | isEmpty () const |
bool | isSupported () const |
QMessageDataComparator::MatchFlags | matchFlags () const |
void | setMatchFlags ( QMessageDataComparator::MatchFlags matchFlags ) |
QMessageFilter | operator& ( const QMessageFilter & other ) const |
const QMessageFilter & | operator&= ( const QMessageFilter & other ) |
QMessageFilter | operator| ( const QMessageFilter & other ) const |
const QMessageFilter & | operator|= ( const QMessageFilter & other ) |
QMessageFilter | operator~ () const |
QMessageFilter | byAncestorFolderIds ( const QMessageFolderId & id, QMessageDataComparator::InclusionComparator cmp = QMessageDataComparator::Includes ) |
QMessageFilter | byAncestorFolderIds ( const QMessageFolderFilter & filter, QMessageDataComparator::InclusionComparator cmp = QMessageDataComparator::Includes ) |
QMessageFilter | byId ( const QMessageId & id, QMessageDataComparator::EqualityComparator cmp = QMessageDataComparator::Equal ) |
QMessageFilter | byId ( const QMessageIdList & ids, QMessageDataComparator::InclusionComparator cmp = QMessageDataComparator::Includes ) |
QMessageFilter | byId ( const QMessageFilter & filter, QMessageDataComparator::InclusionComparator cmp = QMessageDataComparator::Includes ) |
QMessageFilter | byParentAccountId ( const QMessageAccountId & id, QMessageDataComparator::EqualityComparator cmp = QMessageDataComparator::Equal ) |
QMessageFilter | byParentAccountId ( const QMessageAccountFilter & filter, QMessageDataComparator::InclusionComparator cmp = QMessageDataComparator::Includes ) |
QMessageFilter | byParentFolderId ( const QMessageFolderId & id, QMessageDataComparator::EqualityComparator cmp = QMessageDataComparator::Equal ) |
QMessageFilter | byParentFolderId ( const QMessageFolderFilter & filter, QMessageDataComparator::InclusionComparator cmp = QMessageDataComparator::Includes ) |
QMessageFilter | byPriority ( QMessage::Priority value, QMessageDataComparator::EqualityComparator cmp = QMessageDataComparator::Equal ) |
QMessageFilter | byReceptionTimeStamp ( const QDateTime & value, QMessageDataComparator::EqualityComparator cmp = QMessageDataComparator::Equal ) |
QMessageFilter | byReceptionTimeStamp ( const QDateTime & value, QMessageDataComparator::RelationComparator cmp ) |
QMessageFilter | byRecipients ( const QString & value, QMessageDataComparator::InclusionComparator cmp = QMessageDataComparator::Includes ) |
QMessageFilter | bySender ( const QString & value, QMessageDataComparator::EqualityComparator cmp ) |
QMessageFilter | bySender ( const QString & value, QMessageDataComparator::InclusionComparator cmp = QMessageDataComparator::Includes ) |
QMessageFilter | bySize ( int value, QMessageDataComparator::EqualityComparator cmp = QMessageDataComparator::Equal ) |
QMessageFilter | bySize ( int value, QMessageDataComparator::RelationComparator cmp ) |
QMessageFilter | byStandardFolder ( QMessage::StandardFolder folder, QMessageDataComparator::EqualityComparator cmp = QMessageDataComparator::Equal ) |
QMessageFilter | byStatus ( QMessage::Status value, QMessageDataComparator::EqualityComparator cmp ) |
QMessageFilter | byStatus ( QMessage::StatusFlags mask, QMessageDataComparator::InclusionComparator cmp = QMessageDataComparator::Includes ) |
QMessageFilter | bySubject ( const QString & value, QMessageDataComparator::EqualityComparator cmp ) |
QMessageFilter | bySubject ( const QString & value, QMessageDataComparator::InclusionComparator cmp = QMessageDataComparator::Includes ) |
QMessageFilter | byTimeStamp ( const QDateTime & value, QMessageDataComparator::EqualityComparator cmp = QMessageDataComparator::Equal ) |
QMessageFilter | byTimeStamp ( const QDateTime & value, QMessageDataComparator::RelationComparator cmp ) |
QMessageFilter | byType ( QMessage::Type type, QMessageDataComparator::EqualityComparator cmp = QMessageDataComparator::Equal ) |
QMessageFilter | byType ( QMessage::TypeFlags type, QMessageDataComparator::InclusionComparator cmp ) |
The QMessageFilter class defines the parameters used for querying a subset of all available messages from the messaging store.
A QMessageFilter is composed of a message property, an optional comparison operator and a comparison value. The QMessageFilter class is used in conjunction with the QMessageManager::queryMessages(), QMessageManager::countMessages(), QMessageService::queryMessages(), and QMessageService::countMessages() functions to filter results which meet the criteria defined by the filter.
QMessageFilters 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":
QMessageFilter subjectFilter(QMessageFilter::bySubject("meeting")); QMessageFilter senderFilter(QMessageFilter::bySender("joe@user.com")); QMessageIdList results = QMessageManager().queryMessages(subjectFilter & senderFilter);
See also QMessageManager and QMessage.
Creates a QMessageFilter without specifying matching parameters.
A default-constructed filter (one for which isEmpty() returns true) matches all messages.
See also isEmpty().
Constructs a copy of other.
Destroys the filter.
Returns a filter matching messages whose ancestor folders' identifiers contain id, according to cmp.
See also QMessage::parentFolderId().
Returns a filter matching messages whose ancestor folders' identifiers contain a member of the set yielded by filter, according to cmp.
See also QMessage::parentFolderId().
Returns a filter matching messages whose identifier matches id, according to cmp.
See also QMessage::id().
Returns a filter matching messages whose identifier is a member of ids, according to cmp.
See also QMessage::id().
Returns a filter matching messages whose identifier is a member of the set yielded by filter, according to cmp.
See also QMessage::id().
Returns a filter matching messages whose parent account's identifier matches id, according to cmp.
See also QMessage::parentAccountId().
Returns a filter matching messages whose parent account's identifier is a member of the set yielded by filter, according to cmp.
See also QMessage::parentAccountId().
Returns a filter matching messages whose parent folder's identifier matches id, according to cmp.
See also QMessage::parentFolderId().
Returns a filter matching messages whose parent folder's identifier is a member of the set yielded by filter, according to cmp.
See also QMessage::parentFolderId().
Returns a filter matching messages whose priority matches value, according to cmp.
See also QMessage::priority().
Returns a filter matching messages whose reception timestamp matches value, according to cmp.
See also QMessage::receivedDate().
Returns a filter matching messages whose reception timestamp has the relation to value that is specified by cmp.
See also QMessage::receivedDate().
Returns a filter matching messages whose recipients include the substring value, according to cmp.
See also QMessage::to(), QMessage::cc(), and QMessage::bcc().
Returns a filter matching messages whose sender matches value, according to cmp.
See also QMessage::from().
Returns a filter matching messages whose sender matches the substring value, according to cmp.
See also QMessage::from().
Returns a filter matching messages whose size matches value, according to cmp.
See also QMessage::size().
Returns a filter matching messages whose size matches value, according to cmp.
See also QMessage::size().
Returns a filter matching messages whose standard folder location matches folder, according to cmp.
See also QMessage::parentAccountId().
Returns a filter matching messages whose status matches value, according to cmp.
See also QMessage::status().
Returns a filter matching messages whose status is a bitwise match to mask, according to cmp.
See also QMessage::status().
Returns a filter matching messages whose subject matches value, according to cmp.
See also QMessage::subject().
Returns a filter matching messages whose subject matches the substring value, according to cmp.
See also QMessage::subject().
Returns a filter matching messages whose timestamp matches value, according to cmp.
See also QMessage::date().
Returns a filter matching messages whose timestamp has the relation to value that is specified by cmp.
See also QMessage::date().
Returns a filter matching messages whose type matches type, according to cmp.
See also QMessage::type().
Returns a filter matching accounts whose type is a bitwise match to type, according to cmp.
See also QMessage::type().
Returns true if the filter remains empty after default construction; otherwise returns false.
An empty filter matches all messages.
The result of combining an empty filter with a non-empty filter using an AND operation is the original non-empty filter.
The result of combining an empty filter with a non-empty filter using an OR operation is the empty filter.
The result of combining two empty filters is an empty filter.
Returns true if the filter is supported on the current platform; otherwise returns false.
Return the match flags for the search filter.
Default is no match flags set.
See also setMatchFlags().
Set the match flags for the search filter to matchFlags.
See also matchFlags().
Returns a filter that is the logical AND of this filter and the value of filter other.
Performs a logical AND with this filter and the filter other and assigns the result to this filter.
Returns a filter that is the logical OR of this filter and the value of filter other.
Performs a logical OR with this filter and the filter other and assigns the result to this filter.
Returns a filter that is the logical NOT of the value of this filter (ignoring any matchFlags() set on the filter).
If this filter is empty, the result will be a non-matching filter; if this filter is non-matching, the result will be an empty filter.
See also isEmpty().