|  | 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.

- List of all members, including inherited members

## Public Functions

| QMailStorageAction ( QObject * parent = 0 )

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

## Public Slots

void | copyMessages ( const QMailMessageIdList & ids, const QMailFolderId & destinationId )
void | createFolder ( const QString & name, const QMailAccountId & accountId, const QMailFolderId & parentId )
void | deleteFolder ( const QMailFolderId & folderId )
void | deleteMessages ( const QMailMessageIdList & ids )
void | discardMessages ( const QMailMessageIdList & ids )
void | flagMessages ( const QMailMessageIdList & ids, quint64 setMask, quint64 unsetMask )
void | moveMessages ( const QMailMessageIdList & ids, const QMailFolderId & destinationId )
void | renameFolder ( const QMailFolderId & folderId, const QString & name )

- 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 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 copyMessages() slot requests that the message server create a copy of each identified message in the nominated destination folder. The moveMessages() 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 QMailServiceAction instance supports only a single request at a time. Attempting to initiate an operation on a QMailServiceAction while another operation is already in progress for that action is not supported. Instead clients should use multiple QMailServiceAction instances to initiate a queue of requests.

## Member Function Documentation

### QMailStorageAction::QMailStorageAction ( QObject * parent = 0 )

Constructs a new transmit action object with the supplied parent.

### void QMailStorageAction::copyMessages ( 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.

### void QMailStorageAction::createFolder ( 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.

See also deleteFolder().

### void QMailStorageAction::deleteFolder ( 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.

See also createFolder() and renameFolder().

### void QMailStorageAction::deleteMessages ( 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.

### 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]`

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.

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

### void QMailStorageAction::moveMessages ( 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.

### void QMailStorageAction::renameFolder ( const QMailFolderId & folderId, const QString & name ) `[slot]`

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

See also createFolder().