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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
|
//
// 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_NET_IMAP_IMAPUTILS_HPP_INCLUDED
#define VMIME_NET_IMAP_IMAPUTILS_HPP_INCLUDED
#include "vmime/config.hpp"
#if VMIME_HAVE_MESSAGING_FEATURES && VMIME_HAVE_MESSAGING_PROTO_IMAP
#include "vmime/types.hpp"
#include "vmime/dateTime.hpp"
#include "vmime/net/folder.hpp"
#include "vmime/net/message.hpp"
#include "vmime/net/imap/IMAPParser.hpp"
#include "vmime/net/imap/IMAPConnection.hpp"
#include "vmime/net/imap/IMAPCommand.hpp"
#include "vmime/mailboxList.hpp"
#include <vector>
namespace vmime {
namespace net {
namespace imap {
class VMIME_EXPORT IMAPUtils
{
public:
static const string pathToString(const char hierarchySeparator, const folder::path& path);
static const folder::path stringToPath(const char hierarchySeparator, const string& str);
static const string toModifiedUTF7(const char hierarchySeparator, const folder::path::component& text);
static const folder::path::component fromModifiedUTF7(const string& text);
/** Quote string if it contains IMAP-special characters.
*
* @param text string to quote
* @return quoted string
*/
static const string quoteString(const string& text);
/** Parse mailbox flags and fill in folder attributes.
*
* @param cnt reference to current IMAP connection (for testing capabilities)
* @param path folder full path
* @param list list of mailbox flags
* @param attribs reference to an object holding folder attributes
*/
static void mailboxFlagsToFolderAttributes(
const shared_ptr <const IMAPConnection>& cnt,
const folder::path &path,
const IMAPParser::mailbox_flag_list& list,
folderAttributes& attribs
);
static int messageFlagsFromFlags(const IMAPParser::flag_list& list);
static const std::vector <string> messageFlagList(const int flags);
/** Format a date/time to IMAP date/time format.
*
* @param date date/time to format
* @return IMAP-formatted date/time
*/
static const string dateTime(const vmime::datetime& date);
/** Construct a fetch request for the specified messages, designated
* either by their sequence numbers or their UIDs.
*
* @param cnt connection
* @param msgs message set
* @param options fetch options
* @return fetch request
*/
static shared_ptr <IMAPCommand> buildFetchCommand(
const shared_ptr <IMAPConnection>& cnt,
const messageSet& msgs,
const fetchAttributes& options
);
/** Convert a parser-style address list to a mailbox list.
*
* @param src input address list
* @param dest output mailbox list
*/
static void convertAddressList(const IMAPParser::address_list& src, mailboxList& dest);
/** Returns an IMAP-formatted sequence set given a message set.
*
* @param msgs message set
* @return IMAP sequence set (eg. "1:5,7,15:*")
*/
static const string messageSetToSequenceSet(const messageSet& msgs);
/** Constructs a message set from a parser 'uid_set' structure.
*
* @param uidSet UID set, as returned by the parser
* @return message set
*/
static messageSet buildMessageSet(const IMAPParser::uid_set& uidSet);
private:
static const string buildFetchRequestImpl
(const shared_ptr <IMAPConnection>& cnt, const string& mode, const string& set, const int options);
};
} // imap
} // net
} // vmime
#endif // VMIME_HAVE_MESSAGING_FEATURES && VMIME_HAVE_MESSAGING_PROTO_IMAP
#endif // VMIME_NET_IMAP_IMAPUTILS_HPP_INCLUDED
|
