MailCommon::MDNStateAttribute

MailCommon::MDNStateAttribute Class Reference

#include <mdnstateattribute.h>

Inheritance diagram for MailCommon::MDNStateAttribute:

Public Types

enum  MDNSentState {
  MDNStateUnknown, MDNNone, MDNIgnore, MDNDisplayed,
  MDNDeleted, MDNDispatched, MDNProcessed, MDNDenied,
  MDNFailed
}
 
- Public Types inherited from Akonadi::Attribute
typedef QList< Attribute * > List
 

Public Member Functions

 MDNStateAttribute (MDNSentState state=MDNStateUnknown)
 
 MDNStateAttribute (const QByteArray &state)
 
 ~MDNStateAttribute () override
 
MDNStateAttributeclone () const override
 
void deserialize (const QByteArray &data) override
 
MDNStateAttribute::MDNSentState mdnState () const
 
bool operator== (const MDNStateAttribute &other) const
 
QByteArray serialized () const override
 
void setMDNState (MDNSentState state)
 
QByteArray type () const override
 

Detailed Description

An Attribute that keeps track of the MDN state of a mail message.

Once a mail that contains a Message Disposition Notification is processed, the outcome of the user action will be stored in this attribute.

Author
Leo Franchi lfran[email protected][email protected][email protected]kde.o[email protected]rg
See also
Akonadi::Attribute
Since
4.6

Definition at line 41 of file mdnstateattribute.h.

Member Enumeration Documentation

Describes the "MDN sent" state.

Enumerator
MDNStateUnknown 

The state is unknown.

MDNNone 

No MDN has been set.

MDNIgnore 

Ignore sending a MDN.

MDNDisplayed 

The message has been displayed by the UA to someone reading the recipient's mailbox.

MDNDeleted 

The message has been deleted.

MDNDispatched 

The message has been sent somewhere in some manner without necessarily having been previously displayed to the user.

MDNProcessed 

The message has been processed in some manner without being displayed to the user.

MDNDenied 

The recipient does not wish the sender to be informed of the message's disposition.

MDNFailed 

A failure occurred that prevented the proper generation of an MDN.

Definition at line 47 of file mdnstateattribute.h.

Constructor & Destructor Documentation

MDNStateAttribute::MDNStateAttribute ( MDNSentState  state = MDNStateUnknown)
explicit

Creates a new MDN state attribute.

Parameters
stateThe state the attribute will have.

Definition at line 117 of file mdnstateattribute.cpp.

MDNStateAttribute::MDNStateAttribute ( const QByteArray state)
explicit

Creates a new MDN state attribute.

Parameters
stateThe string representation of the state the attribute will have.

Definition at line 123 of file mdnstateattribute.cpp.

MDNStateAttribute::~MDNStateAttribute ( )
override

Destroys the MDN state attribute.

Definition at line 129 of file mdnstateattribute.cpp.

Member Function Documentation

MDNStateAttribute * MDNStateAttribute::clone ( ) const
overridevirtual

Reimplemented from Attribute.

Implements Akonadi::Attribute.

Definition at line 134 of file mdnstateattribute.cpp.

void MDNStateAttribute::deserialize ( const QByteArray data)
overridevirtual

Reimplemented from Attribute.

Implements Akonadi::Attribute.

Definition at line 150 of file mdnstateattribute.cpp.

MDNStateAttribute::MDNSentState MDNStateAttribute::mdnState ( ) const

Returns the MDN state.

Definition at line 160 of file mdnstateattribute.cpp.

QByteArray MDNStateAttribute::serialized ( ) const
overridevirtual

Reimplemented from Attribute.

Implements Akonadi::Attribute.

Definition at line 145 of file mdnstateattribute.cpp.

void MDNStateAttribute::setMDNState ( MDNSentState  state)

Sets the MDN state.

Definition at line 155 of file mdnstateattribute.cpp.

QByteArray MDNStateAttribute::type ( ) const
overridevirtual

Reimplemented from Attribute.

Implements Akonadi::Attribute.

Definition at line 139 of file mdnstateattribute.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 Wed Jul 1 2020 23:15:51 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.