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
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
|
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/* camel-session.h : Abstract class for an email session */
/*
*
* Author :
* Bertrand Guiheneuf <bertrand@helixcode.com>
*
* Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of version 2 of the GNU Lesser General Public
* License as published by the Free Software Foundation.
*
* 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser 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
*/
#ifndef CAMEL_SESSION_H
#define CAMEL_SESSION_H 1
#include <camel/camel-msgport.h>
#include <camel/camel-object.h>
#include <camel/camel-provider.h>
#include <camel/camel-junk-plugin.h>
#define CAMEL_SESSION_TYPE (camel_session_get_type ())
#define CAMEL_SESSION(obj) (CAMEL_CHECK_CAST((obj), CAMEL_SESSION_TYPE, CamelSession))
#define CAMEL_SESSION_CLASS(k) (CAMEL_CHECK_CLASS_CAST ((k), CAMEL_SESSION_TYPE, CamelSessionClass))
#define CAMEL_IS_SESSION(o) (CAMEL_CHECK_TYPE((o), CAMEL_SESSION_TYPE))
G_BEGIN_DECLS
typedef gboolean (*CamelTimeoutCallback) (gpointer data);
typedef enum {
CAMEL_SESSION_ALERT_INFO,
CAMEL_SESSION_ALERT_WARNING,
CAMEL_SESSION_ALERT_ERROR
} CamelSessionAlertType;
enum {
CAMEL_SESSION_PASSWORD_REPROMPT = 1 << 0,
CAMEL_SESSION_PASSWORD_SECRET = 1 << 2,
CAMEL_SESSION_PASSWORD_STATIC = 1 << 3,
CAMEL_SESSION_PASSPHRASE = 1 << 4
};
struct _CamelSession
{
CamelObject parent_object;
struct _CamelSessionPrivate *priv;
gchar *storage_path;
CamelJunkPlugin *junk_plugin;
guint online:1;
guint check_junk:1;
guint network_state:1;
};
typedef struct _CamelSessionThreadOps CamelSessionThreadOps;
typedef struct _CamelSessionThreadMsg CamelSessionThreadMsg;
typedef struct {
CamelObjectClass parent_class;
CamelService * (*get_service) (CamelSession *session,
const gchar *url_string,
CamelProviderType type,
CamelException *ex);
gchar * (*get_storage_path) (CamelSession *session,
CamelService *service,
CamelException *ex);
gchar * (*get_password) (CamelSession *session,
CamelService *service,
const gchar *domain,
const gchar *prompt,
const gchar *item,
guint32 flags,
CamelException *ex);
void (*forget_password) (CamelSession *session,
CamelService *service,
const gchar *domain,
const gchar *item,
CamelException *ex);
gboolean (*alert_user) (CamelSession *session,
CamelSessionAlertType type,
const gchar *prompt,
gboolean cancel);
CamelFilterDriver * (*get_filter_driver) (CamelSession *session,
const gchar *type,
CamelException *ex);
/* mechanism for creating and maintaining multiple threads of control */
gpointer (*thread_msg_new) (CamelSession *session,
CamelSessionThreadOps *ops,
guint size);
void (*thread_msg_free) (CamelSession *session,
CamelSessionThreadMsg *msg);
gint (*thread_queue) (CamelSession *session,
CamelSessionThreadMsg *msg,
gint flags);
void (*thread_wait) (CamelSession *session,
gint id);
void (*thread_status) (CamelSession *session,
CamelSessionThreadMsg *msg,
const gchar *text,
gint pc);
gboolean (*lookup_addressbook)(CamelSession *session,
const gchar *name);
void (*forward_to) (CamelSession *session,
struct _CamelFolder *folder,
struct _CamelMimeMessage *message,
const gchar *address,
CamelException *ex);
} CamelSessionClass;
/* public methods */
/* Standard Camel function */
CamelType camel_session_get_type (void);
void camel_session_construct (CamelSession *session,
const gchar *storage_path);
void camel_session_set_socks_proxy (CamelSession *session,
const gchar *socks_host,
gint socks_port);
void camel_session_get_socks_proxy (CamelSession *session,
gchar **host_ret,
gint *port_ret);
CamelService * camel_session_get_service (CamelSession *session,
const gchar *url_string,
CamelProviderType type,
CamelException *ex);
CamelService * camel_session_get_service_connected (CamelSession *session,
const gchar *url_string,
CamelProviderType type,
CamelException *ex);
#define camel_session_get_store(session, url_string, ex) \
((CamelStore *) camel_session_get_service_connected \
(session, url_string, CAMEL_PROVIDER_STORE, ex))
#define camel_session_get_transport(session, url_string, ex) \
((CamelTransport *) camel_session_get_service_connected \
(session, url_string, CAMEL_PROVIDER_TRANSPORT, ex))
gchar * camel_session_get_storage_path (CamelSession *session,
CamelService *service,
CamelException *ex);
gchar * camel_session_get_password (CamelSession *session,
CamelService *service,
const gchar *domain,
const gchar *prompt,
const gchar *item,
guint32 flags,
CamelException *ex);
void camel_session_forget_password (CamelSession *session,
CamelService *service,
const gchar *domain,
const gchar *item,
CamelException *ex);
gboolean camel_session_alert_user (CamelSession *session,
CamelSessionAlertType type,
const gchar *prompt,
gboolean cancel);
gchar * camel_session_build_password_prompt
(const gchar *type,
const gchar *user,
const gchar *host);
gboolean camel_session_is_online (CamelSession *session);
void camel_session_set_online (CamelSession *session,
gboolean online);
CamelFilterDriver *camel_session_get_filter_driver (CamelSession *session,
const gchar *type,
CamelException *ex);
gboolean camel_session_check_junk (CamelSession *session);
void camel_session_set_check_junk (CamelSession *session,
gboolean check_junk);
struct _CamelSessionThreadOps {
void (*receive)(CamelSession *session, struct _CamelSessionThreadMsg *m);
void (*free)(CamelSession *session, struct _CamelSessionThreadMsg *m);
};
struct _CamelSessionThreadMsg {
CamelMsg msg;
gint id;
CamelException ex;
CamelSessionThreadOps *ops;
struct _CamelOperation *op;
CamelSession *session;
gpointer data; /* free for implementation to define, not used by camel, do not use in client code */
/* user fields follow */
};
gpointer camel_session_thread_msg_new (CamelSession *session,
CamelSessionThreadOps *ops,
guint size);
void camel_session_thread_msg_free (CamelSession *session,
CamelSessionThreadMsg *msg);
gint camel_session_thread_queue (CamelSession *session,
CamelSessionThreadMsg *msg,
gint flags);
void camel_session_thread_wait (CamelSession *session,
gint id);
gboolean camel_session_get_network_state (CamelSession *session);
void camel_session_set_network_state (CamelSession *session,
gboolean network_state);
const GHashTable * camel_session_get_junk_headers (CamelSession *session);
void camel_session_set_junk_headers (CamelSession *session,
const gchar **headers,
const gchar **values,
gint len);
gboolean camel_session_lookup_addressbook (CamelSession *session,
const gchar *name);
void camel_session_forward_to (CamelSession *session,
struct _CamelFolder *folder,
struct _CamelMimeMessage *message,
const gchar *address,
CamelException *ex);
G_END_DECLS
#endif /* CAMEL_SESSION_H */
|
