KMime::MDN Namespace

namespace KMime::MDN

Header:	`#include <KMime/MDN>`
CMake:	`find_package(KPim6 REQUIRED COMPONENTS Mime)` `target_link_libraries(mytarget PRIVATE KPim6::Mime)`

Types

enum	ActionMode { ManualAction, AutomaticAction }
enum	DispositionModifier { Error, Warning, Superseded, Expired, MailboxTerminated }
enum	DispositionType { Displayed, Read, Dispatched, Forwarded, Processed, …, Failed }
enum	SendingMode { SentManually, SentAutomatically }

Functions

QString descriptionFor(KMime::MDN::DispositionType d, const QList<KMime::MDN::DispositionModifier> &m = QList<DispositionModifier>())

QByteArray dispositionNotificationBodyContent(const QString &finalRecipient, const QByteArray &originalRecipient, const QByteArray &originalMsgID, KMime::MDN::DispositionType disposition, KMime::MDN::ActionMode actionMode, KMime::MDN::SendingMode sendingMode, const QList<KMime::MDN::DispositionModifier> &dispositionModifers = QList<DispositionModifier>(), const QString &special = QString())

Detailed Description

Type Documentation

enum MDN::ActionMode

Constant	Value	Description
`KMime::MDN::ManualAction`	`0`	The disposition described by the disposition type was a result of an explicit instruction by the user rather than some sort of automatically performed action.
`KMime::MDN::AutomaticAction`	`1`	The disposition described by the disposition type was a result of an automatic action, rather than an explicit instruction by the user for this message.

enum MDN::DispositionModifier

Constant	Value	Description
`KMime::MDN::Error`	`0`	An error of some sort occurred that prevented successful processing of the message. Further information is contained in an Error field.
`KMime::MDN::Warning`	`1`	The message was successfully processed but some sort of exceptional condition occurred. Further information is contained in a Warning field.
`KMime::MDN::Superseded`	`2`	The message has been automatically rendered obsolete by another message received. The recipient may still access and read the message later.
`KMime::MDN::Expired`	`3`	The message has reached its expiration date and has been automatically removed from the recipient's mailbox.
`KMime::MDN::MailboxTerminated`	`4`	The recipient's mailbox has been terminated and all message in it automatically removed.

enum MDN::DispositionType

Constant	Value	Description
`KMime::MDN::Displayed`	`0`	The message has been displayed by the UA to someone reading the recipient's mailbox. There is no guarantee that the content has been read or understood.
`KMime::MDN::Read`	`Displayed`
`KMime::MDN::Dispatched`	`2`	The message has been sent somewhere in some manner (e.g., printed, faxed, forwarded) without necessarily having been previously displayed to the user. The user may or may not see the message later.
`KMime::MDN::Forwarded`	`Dispatched`
`KMime::MDN::Processed`	`3`	The message has been processed in some manner (i.e., by some sort of rules or server) without being displayed to the user. The user may or may not see the message later, or there may not even be a human user associated with the mailbox.
`KMime::MDN::Deleted`	`1`	The message has been deleted. The recipient may or may not have seen the message. The recipient might "undelete" the message at a later time and read the message.
`KMime::MDN::Denied`	`4`	The recipient does not wish the sender to be informed of the message's disposition. A UA may also silently ignore message disposition requests in this situation.
`KMime::MDN::Failed`	`5`	on Disposition-Notification-Options containing unknown required options. ( == any required options )
`KMime::MDN::Failed`	`5`	A failure occurred that prevented the proper generation of an MDN. More information about the cause of the failure may be contained in a Failure field. The "failed" disposition type is not to be used for the situation in which there is is some problem in processing the message other than interpreting the request for an MDN. The "processed" or other disposition type with appropriate disposition modifiers is to be used in such situations.

enum MDN::SendingMode

Constant	Value	Description
`KMime::MDN::SentManually`	`0`	The user explicitly gave permission for this particular MDN to be sent.
`KMime::MDN::SentAutomatically`	`1`	The MDN was sent because the MUA had previously been configured to do so automatically.

Function Documentation

QString MDN::descriptionFor(KMime::MDN::DispositionType d, const QList<KMime::MDN::DispositionModifier> &m = QList<DispositionModifier>())

QByteArray MDN::dispositionNotificationBodyContent(const QString &finalRecipient, const QByteArray &originalRecipient, const QByteArray &originalMsgID, KMime::MDN::DispositionType disposition, KMime::MDN::ActionMode actionMode, KMime::MDN::SendingMode sendingMode, const QList<KMime::MDN::DispositionModifier> &dispositionModifers = QList<DispositionModifier>(), const QString &special = QString())

Generates the content of the message/disposition-notification body part.

Contents