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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
|
//
// 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_SESSION_HPP_INCLUDED
#define VMIME_NET_SESSION_HPP_INCLUDED
#include "vmime/config.hpp"
#if VMIME_HAVE_MESSAGING_FEATURES
#include "vmime/security/authenticator.hpp"
#if VMIME_HAVE_TLS_SUPPORT
# include "vmime/net/tls/TLSProperties.hpp"
#endif // VMIME_HAVE_TLS_SUPPORT
#include "vmime/utility/url.hpp"
#include "vmime/propertySet.hpp"
namespace vmime {
namespace net {
class store;
class transport;
/** An object that contains all the information needed
* for connection to a service.
*/
class VMIME_EXPORT session : public object, public enable_shared_from_this <session> {
public:
/** Construct a new session.
*
* @return pointer to a new session
*/
static shared_ptr <session> create();
/** Construct a new session given properties.
*
* @param props session properties
* @return pointer to a new session
*/
static shared_ptr <session> create(const propertySet& props);
~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, or NULL if no service is registered for this
* protocol or is not a transport protocol
*/
shared_ptr <transport> getTransport(
const shared_ptr <security::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, or NULL if no service is registered for this
* protocol or is not a transport protocol
*/
shared_ptr <transport> getTransport(
const string& protocol,
const shared_ptr <security::authenticator>& auth = null
);
/** Return a transport service instance for the specified URL.
*
* @param url full URL with at least the protocol to use (eg: "smtp://myserver.com/")
* @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, or NULL if no service is registered for this
* protocol or is not a transport protocol
*/
shared_ptr <transport> getTransport(
const utility::url& url,
const shared_ptr <security::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 store service, or NULL if no service is registered for this
* protocol or is not a store protocol
*/
shared_ptr <store> getStore(
const shared_ptr <security::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 store service, or NULL if no service is registered for this
* protocol or is not a store protocol
*/
shared_ptr <store> getStore(
const string& protocol,
const shared_ptr <security::authenticator>& auth = null
);
/** Return a store service instance for the specified URL.
*
* @param url full URL with at least the protocol to use (eg: "imap://username:password@myserver.com/")
* @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 store service, or NULL if no service is registered for this
* protocol or is not a store protocol
*/
shared_ptr <store> getStore(
const utility::url& url,
const shared_ptr <security::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();
#if VMIME_HAVE_TLS_SUPPORT
/** Set properties for SSL/TLS secured connections in this session.
*
* @param tlsProps SSL/TLS properties
*/
void setTLSProperties(const shared_ptr <tls::TLSProperties>& tlsProps);
/** Get properties for SSL/TLS secured connections in this session.
*
* @return SSL/TLS properties
*/
shared_ptr <tls::TLSProperties> getTLSProperties() const;
#endif // VMIME_HAVE_TLS_SUPPORT
private:
session();
session(const propertySet& props);
propertySet m_props;
#if VMIME_HAVE_TLS_SUPPORT
shared_ptr <tls::TLSProperties> m_tlsProps;
#endif // VMIME_HAVE_TLS_SUPPORT
};
} // net
} // vmime
#endif // VMIME_HAVE_MESSAGING_FEATURES
#endif // VMIME_NET_SESSION_HPP_INCLUDED
|
