1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
|
//
// VMime library (http://www.vmime.org)
// Copyright (C) 2002 Vincent Richard <vincent@vmime.org>
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License as
// published by the Free Software Foundation; either version 3 of
// the License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// General Public License for more details.
//
// You should have received a copy of the GNU General Public License along
// with this program; if not, write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
//
// Linking this library statically or dynamically with other modules is making
// a combined work based on this library. Thus, the terms and conditions of
// the GNU General Public License cover the whole combination.
//
#ifndef VMIME_MISC_IMPORTANCEHELPER_HPP_INCLUDED
#define VMIME_MISC_IMPORTANCEHELPER_HPP_INCLUDED
#include "vmime/message.hpp"
namespace vmime {
namespace misc {
/** 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.
*/
class VMIME_EXPORT importanceHelper {
public:
/** Different levels of importance. */
enum Importance {
IMPORTANCE_HIGHEST,
IMPORTANCE_HIGH,
IMPORTANCE_NORMAL,
IMPORTANCE_LOW,
IMPORTANCE_LOWEST
};
/** Reset the importance of the message to the default importance.
*
* @param msg message on which to reset importance
*/
static void resetImportance(const shared_ptr <message>& msg);
/** Reset the importance of a message to the default importance.
*
* @param hdr message header on which to reset importance
*/
static void resetImportanceHeader(const shared_ptr <header>& hdr);
/** Return the importance of the specified message.
*
* @param msg message from which to retrieve importance
* @return importance of the message, or default importance is no
* information about importance is given in the message
*/
static Importance getImportance(const shared_ptr <const message>& msg);
/** Return the importance of a message, given its header.
*
* @param hdr message header from which to retrieve importance
* @return importance of the message, or default importance is no
* information about importance is given in the message
*/
static Importance getImportanceHeader(const shared_ptr <const header>& hdr);
/** Set the importance of the specified message.
*
* @param msg message on which to set importance
* @param i new message importance
*/
static void setImportance(const shared_ptr <message>& msg, const Importance i);
/** Set the importance of a message, given its header.
*
* @param hdr message header on which to set importance
* @param i new message importance
*/
static void setImportanceHeader(const shared_ptr <header>& hdr, const Importance i);
};
} // misc
} // vmime
#endif // VMIME_MISC_IMPORTANCEHELPER_HPP_INCLUDED
|
