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
|
//
// 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_STORE_HPP_INCLUDED
#define VMIME_NET_STORE_HPP_INCLUDED
#include "vmime/config.hpp"
#if VMIME_HAVE_MESSAGING_FEATURES
#include "vmime/net/service.hpp"
#include "vmime/net/folder.hpp"
namespace vmime {
namespace net {
/** A store service.
* Encapsulate protocols that provide access to user's mail drop.
*/
class VMIME_EXPORT store : public service {
protected:
store(
const shared_ptr <session>& sess,
const serviceInfos& infos,
const shared_ptr <security::authenticator>& auth
);
public:
/** Return the default folder. This is protocol dependent
* and usually is the INBOX folder.
*
* @return default folder
*/
virtual shared_ptr <folder> getDefaultFolder() = 0;
/** Return the root folder. This is protocol dependent
* and usually is the user's mail drop root folder.
*
* @return root folder
*/
virtual shared_ptr <folder> getRootFolder() = 0;
/** Return the folder specified by the path.
*
* @param path absolute folder path
* @return folder at the specified path
*/
virtual shared_ptr <folder> getFolder(const folder::path& path) = 0;
/** Test whether the specified folder name is a syntactically
* a valid name.
*
* @return true if the specified folder name is valid, false otherwise
*/
virtual bool isValidFolderName(const folder::path::component& name) const = 0;
/** Store capabilities. */
enum Capabilities {
CAPABILITY_CREATE_FOLDER = (1 << 0), /**< Can create folders. */
CAPABILITY_RENAME_FOLDER = (1 << 1), /**< Can rename folders. */
CAPABILITY_ADD_MESSAGE = (1 << 2), /**< Can append message to folders. */
CAPABILITY_COPY_MESSAGE = (1 << 3), /**< Can copy messages from a folder to another one. */
CAPABILITY_DELETE_MESSAGE = (1 << 4), /**< Can delete messages. */
CAPABILITY_PARTIAL_FETCH = (1 << 5), /**< Is partial fetch supported? */
CAPABILITY_MESSAGE_FLAGS = (1 << 6), /**< Can set flags on messages. */
CAPABILITY_EXTRACT_PART = (1 << 7) /**< Can extract a specific part of the message. */
};
/** Return the features supported by this service. This is
* a combination of store::CAPABILITY_xxx flags.
*
* @return features supported by this service
*/
virtual int getCapabilities() const = 0;
Type getType() const;
};
} // net
} // vmime
#endif // VMIME_HAVE_MESSAGING_FEATURES
#endif // VMIME_NET_STORE_HPP_INCLUDED
|
