Search for usage in LXR

Akonadi::SentBehaviourAttribute Class Reference

#include <sentbehaviourattribute.h>

Inheritance diagram for Akonadi::SentBehaviourAttribute:

Public Types

enum  SentBehaviour { Delete, MoveToCollection, MoveToDefaultSentCollection }
- Public Types inherited from Akonadi::Attribute
typedef QList< Attribute * > List

Public Member Functions

 SentBehaviourAttribute (SentBehaviour beh=MoveToDefaultSentCollection, const Akonadi::Collection &moveToCollection=Akonadi::Collection(-1), bool sendSilently=false)
 ~SentBehaviourAttribute () override
SentBehaviourAttributeclone () const override
void deserialize (const QByteArray &data) override
Akonadi::Collection moveToCollection () const
bool sendSilently () const
SentBehaviour sentBehaviour () const
QByteArray serialized () const override
void setMoveToCollection (const Akonadi::Collection &moveToCollection)
void setSendSilently (bool sendSilently)
void setSentBehaviour (SentBehaviour beh)
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.

Constantin Berzan exit3.nosp@m.219@.nosp@m.gmail.nosp@m..com

Definition at line 28 of file sentbehaviourattribute.h.

Member Enumeration Documentation

◆ SentBehaviour

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


Delete the item from the outbox.


Move the item to a custom collection.


Move the item to the default sent-mail collection.

Definition at line 34 of file sentbehaviourattribute.h.

Constructor & Destructor Documentation

◆ SentBehaviourAttribute()

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

Creates a new SentBehaviourAttribute.

Definition at line 21 of file sentbehaviourattribute.cpp.

◆ ~SentBehaviourAttribute()

SentBehaviourAttribute::~SentBehaviourAttribute ( )

Destroys the SentBehaviourAttribute.

Member Function Documentation

◆ moveToCollection()

Collection SentBehaviourAttribute::moveToCollection ( ) const

Returns the collection to which the item should be moved after it is sent.

Only valid if sentBehaviour() is MoveToCollection.

Definition at line 102 of file sentbehaviourattribute.cpp.

◆ sendSilently()

bool SentBehaviourAttribute::sendSilently ( ) const

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


Definition at line 112 of file sentbehaviourattribute.cpp.

◆ sentBehaviour()

SentBehaviourAttribute::SentBehaviour SentBehaviourAttribute::sentBehaviour ( ) const

Returns the sent-behaviour of the message.

See also

Definition at line 92 of file sentbehaviourattribute.cpp.

◆ setMoveToCollection()

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.

moveToCollectiontarget collection for "move to" operation
See also

Definition at line 107 of file sentbehaviourattribute.cpp.

◆ setSendSilently()

void SentBehaviourAttribute::setSendSilently ( bool  sendSilently)

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

Default is false.


Definition at line 117 of file sentbehaviourattribute.cpp.

◆ setSentBehaviour()

void SentBehaviourAttribute::setSentBehaviour ( SentBehaviour  beh)

Sets the sent-behaviour of the message.

behthe sent-behaviour to set
See also

Definition at line 97 of file sentbehaviourattribute.cpp.

The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Sat Sep 30 2023 03:51:10 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.