aboutsummaryrefslogtreecommitdiffstats
path: root/src/messaging/store.hpp
blob: 438909772eb9926fc197d3c04e9c8063811e3f42 (plain)
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
//
// VMime library (http://vmime.sourceforge.net)
// Copyright (C) 2002-2004 Vincent Richard <vincent@vincent-richard.net>
//
// 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 2 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., 675 Mass Ave, Cambridge, MA 02139, USA.
//

#ifndef VMIME_MESSAGING_STORE_HPP_INCLUDED
#define VMIME_MESSAGING_STORE_HPP_INCLUDED


#include "service.hpp"
#include "folder.hpp"


namespace vmime {
namespace messaging {


/** A store service.
  * Encapsulate protocols that provide access to user's mail drop.
  */

class store : public service
{
protected:

	store(session* sess, const serviceInfos& infos, authenticator* auth)
		: service(sess, infos, auth) { }

public:

	/** Return the default folder. This is protocol dependant
	  * and usually is the INBOX folder.
	  *
	  * @return default folder
	  */
	virtual folder* getDefaultFolder() = 0;

	/** Return the root folder. This is protocol dependant
	  * and usually is the user's mail drop root folder
	  *
	  * @return root folder
	  */
	virtual folder* getRootFolder() = 0;

	/** Return the folder specified by the path.
	  *
	  * @param path absolute folder path
	  * @return folder at the specified path
	  */
	virtual folder* getFolder(const folder::path& path) = 0;


	const Type getType() const { return (TYPE_STORE); }
};


} // messaging
} // vmime


#endif // VMIME_MESSAGING_STORE_HPP_INCLUDED