importanceHelper Class Reference

#include <importanceHelper.hpp>

Public Types
enum	Importance {   IMPORTANCE_HIGHEST , IMPORTANCE_HIGH , IMPORTANCE_NORMAL , IMPORTANCE_LOW ,   IMPORTANCE_LOWEST }

Static Public Member Functions
static void	resetImportance (shared_ptr< message > msg)
static void	resetImportanceHeader (shared_ptr< header > hdr)
static Importance	getImportance (shared_ptr< const message > msg)
static Importance	getImportanceHeader (shared_ptr< const header > hdr)
static void	setImportance (shared_ptr< message > msg, const Importance i)
static void	setImportanceHeader (shared_ptr< header > hdr, const Importance i)

Detailed Description

Deals with setting and retrieving message importance (also known as priority).

Basically, it wraps the use of the 'X-Priority' (non standard) and 'Importance' (RFC-1327, RFC-1911) fields.

Member Enumeration Documentation

Importance

enum Importance

Different levels of importance.

Enumerator
IMPORTANCE_HIGHEST
IMPORTANCE_HIGH
IMPORTANCE_NORMAL
IMPORTANCE_LOW
IMPORTANCE_LOWEST

Member Function Documentation

getImportance()

importanceHelper::Importance getImportance ( shared_ptr< const message > msg )

static

Return the importance of the specified message.

Parameters

msg	message from which to retrieve importance

Returns

importance of the message, or default importance is no information about importance is given in the message

References getImportanceHeader().

getImportanceHeader()

importanceHelper::Importance getImportanceHeader ( shared_ptr< const header > hdr )

static

Return the importance of a message, given its header.

Parameters

hdr	message header from which to retrieve importance

Returns

importance of the message, or default importance is no information about importance is given in the message

References text::getWholeBuffer(), IMPORTANCE_HIGH, IMPORTANCE_HIGHEST, IMPORTANCE_LOW, IMPORTANCE_LOWEST, IMPORTANCE_NORMAL, stringUtils::toLower(), and stringUtils::trim().

Referenced by getImportance().

resetImportance()

void resetImportance ( shared_ptr< message > msg )

static

Reset the importance of the message to the default importance.

Parameters

msg	message on which to reset importance

References resetImportanceHeader().

resetImportanceHeader()

void resetImportanceHeader ( shared_ptr< header > hdr )

static

Reset the importance of a message to the default importance.

Parameters

hdr	message header on which to reset importance

Referenced by resetImportance().

setImportance()

void setImportance ( shared_ptr< message > msg, const Importance i )

static

Set the importance of the specified message.

Parameters

msg	message on which to set importance
i	new message importance

References setImportanceHeader().

setImportanceHeader()

void setImportanceHeader ( shared_ptr< header > hdr, const Importance i )

static

Set the importance of a message, given its header.

Parameters

hdr	message header on which to set importance
i	new message importance

References IMPORTANCE_HIGH, IMPORTANCE_HIGHEST, IMPORTANCE_LOW, IMPORTANCE_LOWEST, and IMPORTANCE_NORMAL.

Referenced by setImportance().

---

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

• importanceHelper.hpp
• importanceHelper.cpp