Akonadi::SentBehaviourAttribute

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
 
- Public Member Functions inherited from Akonadi::Attribute

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 exit3.nosp@m.219@.nosp@m.gmail.nosp@m..com
Since
4.4

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.

Enumerator
Delete 

Delete the item from the outbox.

MoveToCollection 

Move the item to a custom collection.

MoveToDefaultSentCollection 

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 )
explicit

Creates a new SentBehaviourAttribute.

Definition at line 21 of file sentbehaviourattribute.cpp.

◆ ~SentBehaviourAttribute()

SentBehaviourAttribute::~SentBehaviourAttribute ( )
overridedefault

Destroys the SentBehaviourAttribute.

Member Function Documentation

◆ clone()

SentBehaviourAttribute * SentBehaviourAttribute::clone ( ) const
overridevirtual

Implements Akonadi::Attribute.

Definition at line 31 of file sentbehaviourattribute.cpp.

◆ deserialize()

void SentBehaviourAttribute::deserialize ( const QByteArray & data)
overridevirtual

Implements Akonadi::Attribute.

Definition at line 68 of file sentbehaviourattribute.cpp.

◆ moveToCollection()

Collection SentBehaviourAttribute::moveToCollection ( ) const
nodiscard

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
nodiscard

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

Since
5.4

Definition at line 112 of file sentbehaviourattribute.cpp.

◆ sentBehaviour()

SentBehaviourAttribute::SentBehaviour SentBehaviourAttribute::sentBehaviour ( ) const
nodiscard

Returns the sent-behaviour of the message.

See also
SentBehaviour.

Definition at line 92 of file sentbehaviourattribute.cpp.

◆ serialized()

QByteArray SentBehaviourAttribute::serialized ( ) const
nodiscardoverridevirtual

Implements Akonadi::Attribute.

Definition at line 42 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.

Parameters
moveToCollectiontarget collection for "move to" operation
See also
setSentBehaviour.

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.

Since
5.4

Definition at line 117 of file sentbehaviourattribute.cpp.

◆ setSentBehaviour()

void SentBehaviourAttribute::setSentBehaviour ( SentBehaviour beh)

Sets the sent-behaviour of the message.

Parameters
behthe sent-behaviour to set
See also
SentBehaviour.

Definition at line 97 of file sentbehaviourattribute.cpp.

◆ type()

QByteArray SentBehaviourAttribute::type ( ) const
nodiscardoverridevirtual

Implements Akonadi::Attribute.

Definition at line 36 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-2024 The KDE developers.
Generated on Fri Dec 6 2024 12:12:56 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.