Home · All Namespaces · All Classes · Grouped Classes · Modules · Functions

QMailSearchAction Class Reference
[QtMessagingModule]

The QMailSearchAction class provides the interface for identifying messages that match a set of search criteria. More...

    #include <QMailSearchAction>

This class is under development and is subject to change.

Inherits QMailServiceAction.

• List of all members, including inherited members

Public Functions

• QMailSearchAction ( QObject * parent = 0 )
• QMailMessageIdList matchingMessageIds () const

• 4 public functions inherited from QMailServiceAction
• 29 public functions inherited from QObject

Public Slots

• virtual void cancelOperation ()
• void searchMessages ( const QMailMessageKey & filter, const QString & bodyText )

• 1 public slot inherited from QMailServiceAction
• 1 public slot inherited from QObject

Additional Inherited Members

• 1 property inherited from QObject
• 4 signals inherited from QMailServiceAction
• 1 signal inherited from QObject
• 1 public type inherited from QObject
• 4 static public members inherited from QObject
• 2 protected functions inherited from QMailServiceAction
• 7 protected functions inherited from QObject
• 2 protected variables inherited from QObject

Detailed Description

The QMailSearchAction class provides the interface for identifying messages that match a set of search criteria.

QMailSearchAction provides the mechanism for messaging clients to request that the message server perform a search for messages that match the supplied search criteria. For criteria pertaining to message meta data, the message server will search within the locally held meta data. For a textual content criterion, the message server will search locally where the message content is held locally, and on the external server for messages whose content has not been retrieved (provided the external service provides a search facility).

Member Function Documentation

QMailSearchAction::QMailSearchAction ( QObject * parent = 0 )

Constructs a new search action object with the supplied parent.

void QMailSearchAction::cancelOperation ()   [virtual slot]

Attempts to cancel the last requested search operation.

Reimplemented from QMailServiceAction.

QMailMessageIdList QMailSearchAction::matchingMessageIds () const

Returns the list of message identifiers found to match the search criteria. Unless activity() returns Successful, an empty list is returned.

void QMailSearchAction::searchMessages ( const QMailMessageKey & filter, const QString & bodyText )   [slot]

Requests that the message server identify all messages that match the criteria specified by filter. If bodyText is non-empty, identified messages must also contain the supplied text in their content.

For messages whose content is not held locally, the external service will be requested to perform the content search, if that facility is available.