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
|
//
// VMime library (http://vmime.sourceforge.net)
// Copyright (C) 2002-2004 Vincent Richard <[email protected]>
//
// 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_SESSION_HPP_INCLUDED
#define VMIME_MESSAGING_SESSION_HPP_INCLUDED
#include "authenticator.hpp"
#include "progressionListener.hpp"
#include "../propertySet.hpp"
namespace vmime {
namespace messaging {
class store;
class transport;
/** An object that contains all the information needed
* for connection to a service.
*/
class session
{
public:
session();
session(const propertySet& props);
virtual ~session();
/** Return a transport service instance for the protocol specified
* in the session properties.
*
* The property "transport.protocol" specify the protocol to use.
*
* @param auth authenticator object to use for the new transport service. If
* NULL, a default one is used. The default authenticator simply return user
* credentials by reading the session properties "auth.username" and "auth.password".
* @return a new transport service
*/
transport* getTransport(authenticator* auth = NULL);
/** Return a transport service instance for the specified protocol.
*
* @param protocol transport protocol to use (eg. "smtp")
* @param auth authenticator object to use for the new transport service. If
* NULL, a default one is used. The default authenticator simply return user
* credentials by reading the session properties "auth.username" and "auth.password".
* @return a new transport service
*/
transport* getTransport(const string& protocol, authenticator* auth = NULL);
/** Return a transport service instance for the protocol specified
* in the session properties.
*
* The property "store.protocol" specify the protocol to use.
*
* @param auth authenticator object to use for the new store service. If
* NULL, a default one is used. The default authenticator simply return user
* credentials by reading the session properties "auth.username" and "auth.password".
* @return a new transport service
*/
store* getStore(authenticator* auth = NULL);
/** Return a store service instance for the specified protocol.
*
* @param protocol store protocol to use (eg. "imap")
* @param auth authenticator object to use for the new store service. If
* NULL, a default one is used. The default authenticator simply return user
* credentials by reading the session properties "auth.username" and "auth.password".
* @return a new transport service
*/
store* getStore(const string& protocol, authenticator* auth = NULL);
/** Properties for the session and for the services.
*/
const propertySet& getProperties() const;
/** Properties for the session and for the services.
*/
propertySet& getProperties();
private:
propertySet m_props;
};
} // messaging
} // vmime
#endif // VMIME_MESSAGING_SESSION_HPP_INCLUDED
|
