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
|
/* -*- 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 1999, 2000 Ximian, Inc. (www.ximian.com)
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of version 2 of the GNU 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 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307
* USA
*/
#ifndef CAMEL_SESSION_H
#define CAMEL_SESSION_H 1
#ifdef __cplusplus
extern "C" {
#pragma }
#endif /* __cplusplus }*/
#include <camel/camel-object.h>
#include <camel/camel-provider.h>
#include <camel/camel-junk-plugin.h>
#include <e-util/e-msgport.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))
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,
};
struct _CamelSession
{
CamelObject parent_object;
struct _CamelSessionPrivate *priv;
char *storage_path;
GHashTable *providers, *modules;
gboolean online;
CamelJunkPlugin *junk_plugin;
gboolean check_junk;
};
#ifdef ENABLE_THREADS
typedef struct _CamelSessionThreadOps CamelSessionThreadOps;
typedef struct _CamelSessionThreadMsg CamelSessionThreadMsg;
#endif
typedef struct {
CamelObjectClass parent_class;
void (*register_provider) (CamelSession *session,
CamelProvider *provider);
GList * (*list_providers) (CamelSession *session,
gboolean load);
CamelProvider * (*get_provider) (CamelSession *session,
const char *url_string,
CamelException *ex);
CamelService * (*get_service) (CamelSession *session,
const char *url_string,
CamelProviderType type,
CamelException *ex);
char * (*get_storage_path) (CamelSession *session,
CamelService *service,
CamelException *ex);
char * (*get_password) (CamelSession *session,
const char *prompt,
guint32 flags,
CamelService *service,
const char *item,
CamelException *ex);
void (*forget_password) (CamelSession *session,
CamelService *service,
const char *item,
CamelException *ex);
gboolean (*alert_user) (CamelSession *session,
CamelSessionAlertType type,
const char *prompt,
gboolean cancel);
CamelFilterDriver * (*get_filter_driver) (CamelSession *session,
const char *type,
CamelException *ex);
#ifdef ENABLE_THREADS
/* mechanism for creating and maintaining multiple threads of control */
void *(*thread_msg_new)(CamelSession *session, CamelSessionThreadOps *ops, unsigned int size);
void (*thread_msg_free)(CamelSession *session, CamelSessionThreadMsg *msg);
int (*thread_queue)(CamelSession *session, CamelSessionThreadMsg *msg, int flags);
void (*thread_wait)(CamelSession *session, int id);
void (*thread_status)(CamelSession *session, CamelSessionThreadMsg *msg, const char *text, int pc);
#endif
} CamelSessionClass;
/* public methods */
/* Standard Camel function */
CamelType camel_session_get_type (void);
void camel_session_construct (CamelSession *session,
const char *storage_path);
void camel_session_register_provider (CamelSession *session,
CamelProvider *provider);
GList * camel_session_list_providers (CamelSession *session,
gboolean load);
CamelProvider * camel_session_get_provider (CamelSession *session,
const char *url_string,
CamelException *ex);
CamelService * camel_session_get_service (CamelSession *session,
const char *url_string,
CamelProviderType type,
CamelException *ex);
CamelService * camel_session_get_service_connected (CamelSession *session,
const char *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))
char * camel_session_get_storage_path (CamelSession *session,
CamelService *service,
CamelException *ex);
char * camel_session_get_password (CamelSession *session,
const char *prompt,
guint32 flags,
CamelService *service,
const char *item,
CamelException *ex);
void camel_session_forget_password (CamelSession *session,
CamelService *service,
const char *item,
CamelException *ex);
gboolean camel_session_alert_user (CamelSession *session,
CamelSessionAlertType type,
const char *prompt,
gboolean cancel);
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 char *type,
CamelException *ex);
gboolean camel_session_check_junk (CamelSession *session);
void camel_session_set_check_junk (CamelSession *session, gboolean check_junk);
#ifdef ENABLE_THREADS
struct _CamelSessionThreadOps {
void (*receive)(CamelSession *session, struct _CamelSessionThreadMsg *m);
void (*free)(CamelSession *session, struct _CamelSessionThreadMsg *m);
};
struct _CamelSessionThreadMsg {
EMsg msg;
int id;
CamelException ex;
CamelSessionThreadOps *ops;
struct _CamelOperation *op;
CamelSession *session;
void *data; /* free for implementation to define, not used by camel, do not use in client code */
/* user fields follow */
};
void *camel_session_thread_msg_new(CamelSession *session, CamelSessionThreadOps *ops, unsigned int size);
void camel_session_thread_msg_free(CamelSession *session, CamelSessionThreadMsg *msg);
int camel_session_thread_queue(CamelSession *session, CamelSessionThreadMsg *msg, int flags);
void camel_session_thread_wait(CamelSession *session, int id);
#endif
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif /* CAMEL_SESSION_H */
|
