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

QMailMessageRemovalRecord Class Reference
[QtMessagingModule]

The QMailMessageRemovalRecord class represents the record of a message which has been removed from the mail store. More...

    #include <QMailMessageRemovalRecord>

This class is under development and is subject to change.

• List of all members, including inherited members

Public Functions

• QMailMessageRemovalRecord ( const QMailAccountId & parentAccountId, const QString & serverUid, const QString & fromMailbox = QString() )
• QMailMessageRemovalRecord ( const QMailMessageRemovalRecord & other )
• QString fromMailbox () const
• QMailAccountId parentAccountId () const
• QString serverUid () const
• void setFromMailbox ( const QString & fromMailbox )
• void setParentAccountId ( const QMailAccountId & id )
• void setServerUid ( const QString & serverUid )

Detailed Description

The QMailMessageRemovalRecord class represents the record of a message which has been removed from the mail store.

QMailMessageRemovalRecord represents messages that have been previously removed, so that the message server can finalize its interest in the message with an external service, after the message has been removed locally. The removal record contains only the information needed to identify the message to the external service.

Message removal records should be purged from the mail store once the message server has finalized its interest in the message with the external service.

See also QMailStore::messageRemovalRecords() and QMailStore::purgeMessageRemovalRecords().

Member Function Documentation

QMailMessageRemovalRecord::QMailMessageRemovalRecord ( const QMailAccountId & parentAccountId, const QString & serverUid, const QString & fromMailbox = QString() )

Constructs a removal record for the message identified by the UID serverUid in the mailbox fromMailbox, in the account identified by parentAccountId.

QMailMessageRemovalRecord::QMailMessageRemovalRecord ( const QMailMessageRemovalRecord & other )

Constructs a removal record which is a copy of other.

QString QMailMessageRemovalRecord::fromMailbox () const

Returns the name of the mailbox at the external service in which the removed message was located.

See also setFromMailbox().

QMailAccountId QMailMessageRemovalRecord::parentAccountId () const

Returns the identifier of the account owning this removal record.

See also setParentAccountId().

QString QMailMessageRemovalRecord::serverUid () const

Returns the UID at the external service of the removed message.

See also setServerUid().

void QMailMessageRemovalRecord::setFromMailbox ( const QString & fromMailbox )

Set the name of the mailbox at the external service in which the removed message was located, to fromMailbox.

See also fromMailbox().

void QMailMessageRemovalRecord::setParentAccountId ( const QMailAccountId & id )

Sets the identifier of the message removal record's owner account to id.

See also parentAccountId().

void QMailMessageRemovalRecord::setServerUid ( const QString & serverUid )

Sets the UID at the external service of the removed message to serverUid.

See also serverUid().