Home

QMailStorageAction Class Reference

The QMailStorageAction class provides the interface for requesting operations on the storage of messages within external message services. More...

    #include <QMailStorageAction>

This class is under development and is subject to change.

Inherits QMailServiceAction.

Public Functions

QMailStorageAction ( QObject * parent = 0 )
QMailMessageIdList messagesAdded () const
QMailMessageIdList messagesUpdated () const

Public Slots

void addMessages ( const QMailMessageList & messages )
void deleteMessages ( const QMailMessageIdList & mailList )
void discardMessages ( const QMailMessageIdList & ids )
void flagMessages ( const QMailMessageIdList & ids, quint64 setMask, quint64 unsetMask )
void moveToFolder ( const QMailMessageIdList & ids, const QMailFolderId & folderId )
void moveToStandardFolder ( const QMailMessageIdList & ids, QMailFolder::StandardFolder standardFolder )
void onlineCopyMessages ( const QMailMessageIdList & ids, const QMailFolderId & destinationId )
void onlineCreateFolder ( const QString & name, const QMailAccountId & accountId, const QMailFolderId & parentId )
void onlineDeleteFolder ( const QMailFolderId & folderId )
void onlineDeleteMessages ( const QMailMessageIdList & ids )
void onlineFlagMessagesAndMoveToStandardFolder ( const QMailMessageIdList & ids, quint64 setMask, quint64 unsetMask )
void onlineMoveMessages ( const QMailMessageIdList & ids, const QMailFolderId & destinationId )
void onlineRenameFolder ( const QMailFolderId & folderId, const QString & name )
void restoreToPreviousFolder ( const QMailMessageKey & key )
void rollBackUpdates ( const QMailAccountId & mailAccountId )
void updateMessages ( const QMailMessageList & messages )
void updateMessages ( const QMailMessageMetaDataList & messages )

Additional Inherited Members

Detailed Description

The QMailStorageAction class provides the interface for requesting operations on the storage of messages within external message services.

QMailStorageAction provides the mechanism for messaging clients to request that the message server move or copy messages within an external message service. The storage action object reports on the progress and outcome of its activities via the signals inherited from QMailServiceAction.

The onlineCopyMessages() slot requests that the message server create a copy of each identified message in the nominated destination folder. The onlineMoveMessages() slot requests that the message server move each identified message from its current location to the nominated destination folder. Messages cannot be moved or copied between accounts.

A QMailStorageAction instance supports only a single request at any time. Attempting to initiate an operation on a QMailStorageAction instace while another operation is already in progress for that action is not supported.

An application may however use multiple QMailStorageAction instances to send independent requests concurrently. Each QMailServiceAction instance will report only the changes pertaining to the request that instance delivered. Whether or not concurrent requests are concurrently serviced by the messageserver depends on whether those requests must be serviced by the same QMailMessageService instance.

Member Function Documentation

QMailStorageAction::QMailStorageAction ( QObject * parent = 0 )

Constructs a new transmit action object with the supplied parent.

void QMailStorageAction::addMessages ( const QMailMessageList & messages )   [slot]

Requests that the message server add messages to the mail store.

The messages will be added asynchronously.

All messages must use the same content scheme.

See also QMailStorageAction::messagesAdded() and QMailMessageMetaData::contentScheme().

void QMailStorageAction::deleteMessages ( const QMailMessageIdList & mailList )   [slot]

Asynchronously deletes the messages in mailList, messages will be removed locally from the device, and if necessary information needed to delete messages from an external server is recorded.

Deleting messages using this slot does not initiate communication with any external server; Deletion from the external server will occur when QMailRetrievalAction::exportUpdates is called successfully.

See also QMailStore::removeMessage().

void QMailStorageAction::discardMessages ( const QMailMessageIdList & ids )   [slot]

Requests that the message server delete the messages listed in ids from the local device only.

void QMailStorageAction::flagMessages ( const QMailMessageIdList & ids, quint64 setMask, quint64 unsetMask )   [slot]

Asynchronous version of QMailDisconnected::flagMessages()

Disconnected flags the list of messages identified by ids, setting the flags specified by the bit mask setMask to on and setting the flags set by the bit mask unsetMask to off.

For example this function may be used to mark messages as important.

The flagging operation will be propagated to the server by a successful call to QMailRetrievalAction::exportUpdates().

See also QMailDisconnected::flagMessages(), QMailStorageAction::moveToFolder(), and QMailStorageAction::moveToStandardFolder().

QMailMessageIdList QMailStorageAction::messagesAdded () const

Returns the ids of the messages added to the mail store.

QMailMessageIdList QMailStorageAction::messagesUpdated () const

Returns the ids of the messages updated in the mail store.

void QMailStorageAction::moveToFolder ( const QMailMessageIdList & ids, const QMailFolderId & folderId )   [slot]

Asynchronous version of QMailDisconnected::moveToFolder()

Disconnected moves the list of messages identified by ids into the folder identified by folderId, setting standard folder flags as appropriate.

Moving to another account is not supported.

The move operation will be propagated to the server by a successful call to QMailRetrievalAction::exportUpdates().

See also QMailDisconnected::moveToFolder().

void QMailStorageAction::moveToStandardFolder ( const QMailMessageIdList & ids, QMailFolder::StandardFolder standardFolder )   [slot]

Asynchronous version of QMailDisconnected::moveToStandardFolder()

Disconnected moves the list of messages identified by ids into the standard folder standardFolder, setting standard folder flags as appropriate.

The move operation will be propagated to the server by a successful call to QMailRetrievalAction::exportUpdates().

See also QMailDisconnected::moveToStandardFolder().

void QMailStorageAction::onlineCopyMessages ( const QMailMessageIdList & ids, const QMailFolderId & destinationId )   [slot]

Requests that the message server create a new copy of each message listed in ids within the folder identified by destinationId.

This function requires the device to be online, it may initiate communication with external servers.

void QMailStorageAction::onlineCreateFolder ( const QString & name, const QMailAccountId & accountId, const QMailFolderId & parentId )   [slot]

Requests that the message server create a new folder named name, created in the account identified by accountId. If parentId is a valid folder identifier the new folder will be a child of the parent; otherwise the folder will be have no parent and will be created at the highest level.

This function requires the device to be online, it may initiate communication with external servers.

See also onlineDeleteFolder().

void QMailStorageAction::onlineDeleteFolder ( const QMailFolderId & folderId )   [slot]

Requests that the message server delete the folder identified by folderId. Any existing folders or messages contained by the folder will also be deleted.

This function requires the device to be online, it may initiate communication with external servers.

See also onlineCreateFolder() and onlineRenameFolder().

void QMailStorageAction::onlineDeleteMessages ( const QMailMessageIdList & ids )   [slot]

Requests that the message server delete the messages listed in ids, both from the local device and the external message source. Whether the external messages resources are actually removed is at the discretion of the relevant QMailMessageSource object.

This function requires the device to be online, it may initiate communication with external servers.

void QMailStorageAction::onlineFlagMessagesAndMoveToStandardFolder ( const QMailMessageIdList & ids, quint64 setMask, quint64 unsetMask )   [slot]

Requests that the message server flag each message listed in ids, by setting any status flags set in the setMask, and unsetting any status flags set in the unsetMask. The status flag values should correspond to those of QMailMessage::status().

The service implementing the account may choose to take further actions in response to flag changes, such as moving or deleting messages.

This function requires the device to be online, it may initiate communication with external servers.

See also QMailMessage::setStatus() and QMailStore::updateMessagesMetaData().

void QMailStorageAction::onlineMoveMessages ( const QMailMessageIdList & ids, const QMailFolderId & destinationId )   [slot]

Requests that the message server move each message listed in ids from its current location to the folder identified by destinationId.

This function requires the device to be online, it may initiate communication with external servers.

void QMailStorageAction::onlineRenameFolder ( const QMailFolderId & folderId, const QString & name )   [slot]

Requests that the message server rename the folder identified by folderId to name.

This function requires the device to be online, it may initiate communication with external servers.

See also onlineCreateFolder().

void QMailStorageAction::restoreToPreviousFolder ( const QMailMessageKey & key )   [slot]

Asynchronous version of QMailDisconnected::restoreToPreviousFolder()

Updates all QMailMessages identified by the key key to move the messages back to the previous folder they were contained by.

See also QMailDisconnected::restoreToPreviousFolder().

void QMailStorageAction::rollBackUpdates ( const QMailAccountId & mailAccountId )   [slot]

Asynchronous version of QMailDisconnected::rollBackUpdates()

Rolls back all disconnected move and copy operations that have been applied to the message store since the most recent synchronization of the message with the account specified by mailAccountId.

See also QMailDisconnected::updatesOutstanding().

void QMailStorageAction::updateMessages ( const QMailMessageList & messages )   [slot]

Requests that the message server update messages in the mail store.

The messages will be updated asynchronously.

All messages must use the same content scheme.

See also QMailStorageAction::messagesUpdated() and QMailMessageMetaData::contentScheme().

void QMailStorageAction::updateMessages ( const QMailMessageMetaDataList & messages )   [slot]

Requests that the message server updates the meta data of the existing messages in the message store, to match each of the messages listed in messages.

The messages will be updated asynchronously.

All messages must use the same content scheme.

See also QMailStorageAction::messagesUpdated() and QMailMessageMetaData::contentScheme().

Copyright © 2010 QtSoftware
Messaging Framework