MailTransport::SentBehaviourAttribute

MailTransport::SentBehaviourAttribute Class Reference

#include <sentbehaviourattribute.h>

Inheritance diagram for MailTransport::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.

Author
Constantin Berzan exit3[email protected][email protected][email protected]gmail[email protected].com
Since
4.4

Definition at line 24 of file sentbehaviourattribute.h.

Member Enumeration Documentation

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 30 of file sentbehaviourattribute.h.

Constructor & Destructor Documentation

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

Creates a new SentBehaviourAttribute.

Definition at line 26 of file sentbehaviourattribute.cpp.

SentBehaviourAttribute::~SentBehaviourAttribute ( )
override

Destroys the SentBehaviourAttribute.

Definition at line 34 of file sentbehaviourattribute.cpp.

Member Function Documentation

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 110 of file sentbehaviourattribute.cpp.

bool SentBehaviourAttribute::sendSilently ( ) const

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

Since
5.4

Definition at line 120 of file sentbehaviourattribute.cpp.

SentBehaviourAttribute::SentBehaviour SentBehaviourAttribute::sentBehaviour ( ) const

Returns the sent-behaviour of the message.

See also
SentBehaviour.

Definition at line 100 of file sentbehaviourattribute.cpp.

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 115 of file sentbehaviourattribute.cpp.

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 125 of file sentbehaviourattribute.cpp.

void SentBehaviourAttribute::setSentBehaviour ( SentBehaviour  beh)

Sets the sent-behaviour of the message.

Parameters
behthe sent-behaviour to set
See also
SentBehaviour.

Definition at line 105 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-2020 The KDE developers.
Generated on Sat Jul 11 2020 23:17:56 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.