libkmime

KMime::MDN Namespace Reference


Enumerations

enum  DispositionType {
  Displayed, Read = Displayed, Deleted, Dispatched,
  Forwarded = Dispatched, Processed, Denied, Failed
}
enum  DispositionModifier {
  Error, Warning, Superseded, Expired,
  MailboxTerminated
}
enum  ActionMode { ManualAction, AutomaticAction }
enum  SendingMode { SentManually, SentAutomatically }
enum  ReturnContent { Nothing, All, HeadersOnly }

Functions

static const char * stringFor (DispositionType d)
static const char * stringFor (DispositionModifier m)
static const char * stringFor (ActionMode a)
static const char * stringFor (SendingMode s)
static QCString dispositionField (DispositionType d, ActionMode a, SendingMode s, const QValueList< DispositionModifier > &m)
static QCString finalRecipient (const QString &recipient)
static QCString orginalRecipient (const QCString &recipient)
static QCString originalMessageID (const QCString &msgid)
static QCString reportingUAField ()
QCString dispositionNotificationBodyContent (const QString &finalRecipient, const QCString &originalRecipient, const QCString &originalMsgID, DispositionType disposition, ActionMode actionMode, SendingMode sendingMode, const QValueList< DispositionModifier > &dispositionModifers=QValueList< DispositionModifier >(), const QString &special=QString::null)
QString descriptionFor (DispositionType d, const QValueList< DispositionModifier > &)

Variables

struct {
   DispositionType   KMime::MDN::dispositionType
   const char *   KMime::MDN::string
   const char *   KMime::MDN::description
dispositionTypes []
static const int numDispositionTypes = sizeof dispositionTypes / sizeof *dispositionTypes
struct {
   DispositionModifier   KMime::MDN::dispositionModifier
   const char *   KMime::MDN::string
dispositionModifiers []
static const int numDispositionModifiers = sizeof dispositionModifiers / sizeof * dispositionModifiers
struct {
   ActionMode   KMime::MDN::actionMode
   const char *   KMime::MDN::string
actionModes []
static const int numActionModes = sizeof actionModes / sizeof *actionModes
struct {
   SendingMode   KMime::MDN::sendingMode
   const char *   KMime::MDN::string
sendingModes []
static const int numSendingModes = sizeof sendingModes / sizeof *sendingModes

Enumeration Type Documentation

The following disposition modes are defined:.

  • ManualAction 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.
  • AutomaticAction 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.
IOW: ManualAction for user-driven actions, AutomanticAction for filtering.

Definition at line 158 of file kmime_mdn.h.

The following disposition modifiers are defined:.

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

Definition at line 135 of file kmime_mdn.h.

The following disposition-types are defined:.

  • Displayed 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.
  • Dispatched 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.
  • Processed 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.
  • Deleted 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.
  • Denied The recipient does not wish the sender to be informed of the message's disposition. A UA may also siliently ignore message disposition requests in this situation.
  • Failed 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.
IOW: Displayed when - well -displayed Dispatched when forwarding unseen ( == new ) Processed (maybe) when piping unseen, but probably never used Deleted when deleting unseen Denied on user command Failed on Disposition-Notification-Options containing unknown required options. ( == any required options ) Failed needs a description in the special parameter.

Definition at line 98 of file kmime_mdn.h.

  • SentManually The user explicitly gave permission for this particular MDN to be sent.

  • SentAutomatically The MDN was sent because the MUA had previously been configured to do so automatically.
IOW: SentManually for when we have asked the user SentAutomatically when we use the default specified by the user

Definition at line 174 of file kmime_mdn.h.


Function Documentation

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

Main function.

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

Definition at line 217 of file kmime_mdn.cpp.

KDE Home | KDE Accessibility Home | Description of Access Keys