diff options
Diffstat (limited to 'vmime-master/src/vmime/misc/importanceHelper.hpp')
-rw-r--r-- | vmime-master/src/vmime/misc/importanceHelper.hpp | 103 |
1 files changed, 103 insertions, 0 deletions
diff --git a/vmime-master/src/vmime/misc/importanceHelper.hpp b/vmime-master/src/vmime/misc/importanceHelper.hpp new file mode 100644 index 0000000..45e0bcc --- /dev/null +++ b/vmime-master/src/vmime/misc/importanceHelper.hpp @@ -0,0 +1,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 |