importanceHelper Class Reference

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

List of all members.

Public Types
enum	Importance {   IMPORTANCE_HIGHEST, IMPORTANCE_HIGH, IMPORTANCE_NORMAL, IMPORTANCE_LOW,   IMPORTANCE_LOWEST }
Static Public Member Functions
static void	resetImportance (ref< message > msg)
static void	resetImportanceHeader (ref< header > hdr)
static Importance	getImportance (ref< const message > msg)
static Importance	getImportanceHeader (ref< const header > hdr)
static void	setImportance (ref< message > msg, const Importance i)
static void	setImportanceHeader (ref< 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

enum Importance

Different levels of importance.

Enumerator:

IMPORTANCE_HIGHEST
IMPORTANCE_HIGH
IMPORTANCE_NORMAL
IMPORTANCE_LOW
IMPORTANCE_LOWEST

---

Member Function Documentation

importanceHelper::Importance getImportance

(

ref< 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

importanceHelper::Importance getImportanceHeader

(

ref< 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

void resetImportance

(

ref< message >

msg

)

[static]

Reset the importance of the message to the default importance.

Parameters:

msg

message on which to reset importance

void resetImportanceHeader

(

ref< header >

hdr

)

[static]

Reset the importance of a message to the default importance.

Parameters:

hdr

message header on which to reset importance

void setImportance	(	ref< 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

void setImportanceHeader	(	ref< 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

---

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

• importanceHelper.hpp
• importanceHelper.cpp