Akonadi::SentBehaviourAttribute Class

class Akonadi::SentBehaviourAttribute
Header: #include <Akonadi/SentBehaviourAttribute>
CMake: find_package(KPim6AkonadiMime REQUIRED)
target_link_libraries(mytarget PRIVATE KPim6::AkonadiMime)

Public Types

enum SentBehaviour { Delete, MoveToCollection, MoveToDefaultSentCollection }

Public Functions

SentBehaviourAttribute(Akonadi::SentBehaviourAttribute::SentBehaviour beh = MoveToDefaultSentCollection, const Akonadi::Collection &moveToCollection = Akonadi::Collection(-1), bool sendSilently = false)
virtual ~SentBehaviourAttribute() override
Akonadi::Collection moveToCollection() const
bool sendSilently() const
Akonadi::SentBehaviourAttribute::SentBehaviour sentBehaviour() const
void setMoveToCollection(const Akonadi::Collection &moveToCollection)
void setSendSilently(bool sendSilently)
void setSentBehaviour(Akonadi::SentBehaviourAttribute::SentBehaviour beh)

Reimplemented Public Functions

virtual Akonadi::SentBehaviourAttribute *clone() const override
virtual void deserialize(const QByteArray &data) override
virtual QByteArray serialized() const override
virtual QByteArray type() const override

Detailed Description

Attribute determining what will happen to a message after it is sent. The message can be deleted from the Outbox, moved to the default sent-mail collection, or moved to a custom collection.

Author: Constantin Berzan <exit3219@gmail.com>

Member Type Documentation

enum SentBehaviourAttribute::SentBehaviour

What to do with the item in the outbox after it has been sent successfully.

Member Function Documentation

[explicit] SentBehaviourAttribute::SentBehaviourAttribute(Akonadi::SentBehaviourAttribute::SentBehaviour beh = MoveToDefaultSentCollection, const Akonadi::Collection &moveToCollection = Akonadi::Collection(-1), bool sendSilently = false)

Creates a new SentBehaviourAttribute.

[override virtual noexcept] SentBehaviourAttribute::~SentBehaviourAttribute()

Destroys the SentBehaviourAttribute.

[override virtual] Akonadi::SentBehaviourAttribute *SentBehaviourAttribute::clone() const

Returns a copy of this attribute.

[override virtual] void SentBehaviourAttribute::deserialize(const QByteArray &data)

Deserializes the attribute from the given data. data the serialized data

Akonadi::Collection SentBehaviourAttribute::moveToCollection() const

Returns the collection to which the item should be moved after it is sent. Only valid if sentBehaviour() is MoveToCollection.

See also setMoveToCollection().

bool SentBehaviourAttribute::sendSilently() const

Returns whether a notification should be shown after the email is sent.

See also setSendSilently().

Akonadi::SentBehaviourAttribute::SentBehaviour SentBehaviourAttribute::sentBehaviour() const

Returns the sent-behaviour of the message.

See also setSentBehaviour() and SentBehaviour.

[override virtual] QByteArray SentBehaviourAttribute::serialized() const

Returns the serialized representation of the attribute.

void SentBehaviourAttribute::setMoveToCollection(const Akonadi::Collection &moveToCollection)

Sets the collection to which the item should be moved after it is sent. Make sure you set the SentBehaviour to MoveToCollection first. moveToCollection target collection for "move to" operation

See also moveToCollection() and setSentBehaviour.

void SentBehaviourAttribute::setSendSilently(bool sendSilently)

Set whether a notification should be shown after the email is sent.

Default is false.

See also sendSilently().

void SentBehaviourAttribute::setSentBehaviour(Akonadi::SentBehaviourAttribute::SentBehaviour beh)

Sets the sent-behaviour of the message. beh the sent-behaviour to set

See also sentBehaviour() and SentBehaviour.

[override virtual] QByteArray SentBehaviourAttribute::type() const

Returns the type of the attribute.