QMailRetrievalAction Class Reference
[QtMessagingModule]

Detailed Description

The QMailRetrievalAction class provides the interface for retrieving messages from external message services.

QMailRetrievalAction provides the mechanism for messaging clients to request that the message server retrieve messages from external services. The retrieval action object reports on the progress and outcome of its activities via the signals inherited from QMailServiceAction.

The retrieve() slot requests that the message server synchronize the set of known message identifiers with those available for the nominated account. The completeRetrieval() slot requests that the message server retrieve the content of each identified message. A client that requests the retrieve() action should subsequently request the completeRetrieval() action after the first operation is successful (possibly with an empty message list) to terminate any remaining connection.

The retrieveFolders() slot requests that the message server synchronize the folder structure of the account with that available from the external server.

Note: the slots exported by QMailRetrievalAction are expected to change in future releases, as the message server is extended to provide a finer-grained interface for message discovery and retrieval.

Member Function Documentation

QMailRetrievalAction::QMailRetrievalAction ( QObject * parent = 0 )

Constructs a new retrieval action object with the supplied parent.

void QMailRetrievalAction::completeRetrieval ( const QMailMessageIdList & ids )   [slot]

Requests that the message server retrieve the full content of each message listed in ids and terminate the connection. The message list may be empty.

It is possible to request completion for a message list without having previously requested the message server to perform a retrieve().

void QMailRetrievalAction::retrieve ( const QMailAccountId & accountId )   [slot]

Requests that the message server synchronize the set of known message identifiers with those currently available for the account identified by accountId.

New messages will be added to the mail store as they are discovered, and marked with the QMailMessage::New status flag. Messages that are no longer available will be marked with the QMailMessage::Removed status flag. The folder structure of the account will also be synchronized with that available from the external service.

After a retrieve operation is successfully completed, a client should request the completeRetrieval() operation to terminate any remaining connection.

void QMailRetrievalAction::retrieveFolders ( const QMailAccountId & accountId )   [slot]

Requests that the message server synchronize the folder structure of the account identified by accountId with that available from the external service.

It is not necessary to request the completeRetrieval() operation after retrieveFolders() is successfully completed.