MDNHelper Class Reference

#include <MDNHelper.hpp>

Static Public Member Functions
static void	attachMDNRequest (shared_ptr< message > msg, const mailboxList &mailboxes)
static void	attachMDNRequest (shared_ptr< message > msg, const mailbox &mbox)
static const std::vector< sendableMDNInfos >	getPossibleMDNs (const shared_ptr< const message > msg)
static bool	isMDN (const shared_ptr< const message > msg)
static receivedMDNInfos	getReceivedMDN (const shared_ptr< const message > msg)
static bool	needConfirmation (const shared_ptr< const message > msg)
static shared_ptr< message >	buildMDN (const sendableMDNInfos &mdnInfos, const string &text, const charset &ch, const mailbox &expeditor, const disposition &dispo, const string &reportingUA=NULL_STRING, const std::vector< string > &reportingUAProducts=std::vector< string >(), const std::map< string, string > &fields=(std::map< string, string >()))

Detailed Description

Helper for creating or extracting Message Disposition Notifications (MDN), as defined in RFC-3798.

Member Function Documentation

attachMDNRequest() [1/2]

void attachMDNRequest ( shared_ptr< message >  msg, const mailbox &  mbox  )

static

Attach a MDN request to the specified message.

Parameters

msg	message in which to add a MDN request
mbox	mailbox to which the MDN will be sent

References mailboxList::appendMailbox(), MDNHelper::attachMDNRequest(), vmime::clone(), and vmime::dynamicCast().

attachMDNRequest() [2/2]

void attachMDNRequest ( shared_ptr< message >  msg, const mailboxList &  mailboxes  )

static

Attach a MDN request to the specified message.

Parameters

msg	message in which to add a MDN request
mailboxes	list of mailboxes to which the MDN will be sent

References vmime::dynamicCast().

Referenced by MDNHelper::attachMDNRequest().

buildMDN()

shared_ptr< message > buildMDN ( const sendableMDNInfos &  mdnInfos, const string &  text, const charset &  ch, const mailbox &  expeditor, const disposition &  dispo, const string &  reportingUA = NULL_STRING, const std::vector< string > &  reportingUAProducts = std::vector <string>(), const std::map< string, string > &  fields = (std::map <string, string>())  )

static

Build a new MDN for the message.

The resulting MDN can then be sent over SMTP transport service.

Parameters

mdnInfos	information about the MDN to construct
text	human readable message. The purpose of this message is to provide an easily-understood description of the condition(s) that caused the report to be generated.
ch	charset of the text
expeditor	expeditor of the MDN
dispo	disposition information
reportingUA	name of reporting user-agent (optional)
reportingUAProducts	list of products in the reporting user-agent (optional)
fields	additional MDN fields, like "Error", "Warning" or "Failure" (optional)

Returns

a new message object containing the MDN

References addressList::appendAddress(), vmime::dynamicCast(), vmime::mediaTypes::MULTIPART, vmime::mediaTypes::MULTIPART_REPORT, datetime::now(), and vmime::SUPPORTED_MIME_VERSION.

getPossibleMDNs()

const std::vector< sendableMDNInfos > getPossibleMDNs ( const shared_ptr< const message >  msg )

static

Return a list of possible MDNs that can be generated for the specified message.

Parameters

msg	message for which to send a MDN

Returns

list of possible MDNs

References vmime::fields::DISPOSITION_NOTIFICATION_TO, and vmime::dynamicCast().

getReceivedMDN()

receivedMDNInfos getReceivedMDN ( const shared_ptr< const message >  msg )

static

If the specified message is a MDN, return information about it.

Parameters

msg

message

Exceptions

exceptions::invalid_argument

if the message is not a MDN

Returns

information about the MDN

References vmime::dynamicCast(), and MDNHelper::isMDN().

isMDN()

bool isMDN ( const shared_ptr< const message >  msg )

static

Test whether the specified message is a MDN.

Parameters

msg

message

Returns

true if the message is a MDN, false otherwise

References vmime::fields::CONTENT_TYPE, vmime::dynamicCast(), mediaType::getSubType(), mediaType::getType(), vmime::mediaTypes::MULTIPART, and vmime::mediaTypes::MULTIPART_REPORT.

Referenced by MDNHelper::getReceivedMDN().

needConfirmation()

bool needConfirmation ( const shared_ptr< const message >  msg )

static

Check whether we need user confirmation for sending a MDN even if he/she explicitely allowed automatic send of MDNs.

This can happen in some situations, described in RFC-3798.

Parameters

msg	message for which to send a MDN

Returns

true if user confirmation should be asked, false otherwise

References vmime::fields::DISPOSITION_NOTIFICATION_TO, vmime::dynamicCast(), and vmime::fields::RETURN_PATH.

---

The documentation for this class was generated from the following files:

• MDNHelper.hpp
• MDNHelper.cpp