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
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
|
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/* camel-store.h : Abstract class for an email store
*
* Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
*
* This library is free software: you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation.
*
* This library 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 library. If not, see <http://www.gnu.org/licenses/>.
*
* Authors: Bertrand Guiheneuf <bertrand@helixcode.com>
* Michael Zucchi <NotZed@ximian.com>
* Jeffrey Stedfast <fejj@ximian.com>
*/
#if !defined (__CAMEL_H_INSIDE__) && !defined (CAMEL_COMPILATION)
#error "Only <camel/camel.h> can be included directly."
#endif
#ifndef CAMEL_STORE_H
#define CAMEL_STORE_H
/* for mode_t */
#include <sys/types.h>
#include <camel/camel-enums.h>
#include <camel/camel-folder.h>
#include <camel/camel-service.h>
/* Standard GObject macros */
#define CAMEL_TYPE_STORE \
(camel_store_get_type ())
#define CAMEL_STORE(obj) \
(G_TYPE_CHECK_INSTANCE_CAST \
((obj), CAMEL_TYPE_STORE, CamelStore))
#define CAMEL_STORE_CLASS(cls) \
(G_TYPE_CHECK_CLASS_CAST \
((cls), CAMEL_TYPE_STORE, CamelStoreClass))
#define CAMEL_IS_STORE(obj) \
(G_TYPE_CHECK_INSTANCE_TYPE \
((obj), CAMEL_TYPE_STORE))
#define CAMEL_IS_STORE_CLASS(cls) \
(G_TYPE_CHECK_CLASS_TYPE \
((cls), CAMEL_TYPE_STORE))
#define CAMEL_STORE_GET_CLASS(obj) \
(G_TYPE_INSTANCE_GET_CLASS \
((obj), CAMEL_TYPE_STORE, CamelStoreClass))
/**
* CAMEL_STORE_ERROR:
*
* Since: 2.32
**/
#define CAMEL_STORE_ERROR \
(camel_store_error_quark ())
G_BEGIN_DECLS
/**
* CamelStoreError:
*
* Since: 2.32
**/
typedef enum {
CAMEL_STORE_ERROR_INVALID,
CAMEL_STORE_ERROR_NO_FOLDER
} CamelStoreError;
typedef struct _CamelFolderInfo {
struct _CamelFolderInfo *next;
struct _CamelFolderInfo *parent;
struct _CamelFolderInfo *child;
gchar *full_name;
gchar *display_name;
CamelFolderInfoFlags flags;
gint32 unread;
gint32 total;
} CamelFolderInfo;
struct _CamelDB;
typedef struct _CamelStore CamelStore;
typedef struct _CamelStoreClass CamelStoreClass;
typedef struct _CamelStorePrivate CamelStorePrivate;
/* open mode for folder */
typedef enum {
CAMEL_STORE_FOLDER_CREATE = 1 << 0,
CAMEL_STORE_FOLDER_EXCL = 1 << 1, /* deprecated, not honored */
CAMEL_STORE_FOLDER_BODY_INDEX = 1 << 2,
CAMEL_STORE_FOLDER_PRIVATE = 1 << 3 /* a private folder that
should not show up in
unmatched, folder
info's, etc. */
} CamelStoreGetFolderFlags;
struct _CamelStore {
CamelService parent;
CamelStorePrivate *priv;
CamelObjectBag *folders;
struct _CamelDB *cdb_r;
struct _CamelDB *cdb_w;
CamelStoreFlags flags;
/* XXX The default "mode" (read/write) is changed only by
* evolution-groupwise for non-writable proxy accounts.
* The mode is only checked by the account combo box in
* Evolution's composer window. */
CamelStorePermissionFlags mode;
/* Future ABI expansion */
gpointer later[4];
};
struct _CamelStoreClass {
CamelServiceClass parent_class;
GHashFunc hash_folder_name;
GEqualFunc equal_folder_name;
/* Non-Blocking Methods */
gboolean (*can_refresh_folder) (CamelStore *store,
CamelFolderInfo *info,
GError **error);
/* Synchronous I/O Methods */
CamelFolder * (*get_folder_sync) (CamelStore *store,
const gchar *folder_name,
CamelStoreGetFolderFlags flags,
GCancellable *cancellable,
GError **error);
CamelFolderInfo *
(*get_folder_info_sync) (CamelStore *store,
const gchar *top,
CamelStoreGetFolderInfoFlags flags,
GCancellable *cancellable,
GError **error);
CamelFolder * (*get_inbox_folder_sync)
(CamelStore *store,
GCancellable *cancellable,
GError **error);
CamelFolder * (*get_junk_folder_sync) (CamelStore *store,
GCancellable *cancellable,
GError **error);
CamelFolder * (*get_trash_folder_sync)
(CamelStore *store,
GCancellable *cancellable,
GError **error);
CamelFolderInfo *
(*create_folder_sync) (CamelStore *store,
const gchar *parent_name,
const gchar *folder_name,
GCancellable *cancellable,
GError **error);
gboolean (*delete_folder_sync) (CamelStore *store,
const gchar *folder_name,
GCancellable *cancellable,
GError **error);
gboolean (*rename_folder_sync) (CamelStore *store,
const gchar *old_name,
const gchar *new_name,
GCancellable *cancellable,
GError **error);
gboolean (*synchronize_sync) (CamelStore *store,
gboolean expunge,
GCancellable *cancellable,
GError **error);
/* Reserved slots for methods. */
gpointer reserved_for_methods[21];
/* Signals */
void (*folder_created) (CamelStore *store,
CamelFolderInfo *folder_info);
void (*folder_deleted) (CamelStore *store,
CamelFolderInfo *folder_info);
void (*folder_opened) (CamelStore *store,
CamelFolder *folder);
void (*folder_renamed) (CamelStore *store,
const gchar *old_name,
CamelFolderInfo *folder_info);
void (*folder_info_stale) (CamelStore *store);
};
GType camel_store_get_type (void);
GQuark camel_store_error_quark (void) G_GNUC_CONST;
void camel_store_folder_created (CamelStore *store,
CamelFolderInfo *folder_info);
void camel_store_folder_deleted (CamelStore *store,
CamelFolderInfo *folder_info);
void camel_store_folder_opened (CamelStore *store,
CamelFolder *folder);
void camel_store_folder_renamed (CamelStore *store,
const gchar *old_name,
CamelFolderInfo *folder_info);
void camel_store_folder_info_stale (CamelStore *store);
CamelFolderInfo *
camel_folder_info_new (void);
void camel_folder_info_free (CamelFolderInfo *fi);
#ifndef CAMEL_DISABLE_DEPRECATED
CamelFolderInfo *
camel_folder_info_build (GPtrArray *folders,
const gchar *namespace_,
gchar separator,
gboolean short_names);
#endif /* CAMEL_DISABLE_DEPRECATED */
CamelFolderInfo *
camel_folder_info_clone (CamelFolderInfo *fi);
gboolean camel_store_can_refresh_folder (CamelStore *store,
CamelFolderInfo *info,
GError **error);
CamelFolder * camel_store_get_folder_sync (CamelStore *store,
const gchar *folder_name,
CamelStoreGetFolderFlags flags,
GCancellable *cancellable,
GError **error);
void camel_store_get_folder (CamelStore *store,
const gchar *folder_name,
CamelStoreGetFolderFlags flags,
gint io_priority,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
CamelFolder * camel_store_get_folder_finish (CamelStore *store,
GAsyncResult *result,
GError **error);
CamelFolderInfo *
camel_store_get_folder_info_sync
(CamelStore *store,
const gchar *top,
CamelStoreGetFolderInfoFlags flags,
GCancellable *cancellable,
GError **error);
void camel_store_get_folder_info (CamelStore *store,
const gchar *top,
CamelStoreGetFolderInfoFlags flags,
gint io_priority,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
CamelFolderInfo *
camel_store_get_folder_info_finish
(CamelStore *store,
GAsyncResult *result,
GError **error);
CamelFolder * camel_store_get_inbox_folder_sync
(CamelStore *store,
GCancellable *cancellable,
GError **error);
void camel_store_get_inbox_folder (CamelStore *store,
gint io_priority,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
CamelFolder * camel_store_get_inbox_folder_finish
(CamelStore *store,
GAsyncResult *result,
GError **error);
CamelFolder * camel_store_get_junk_folder_sync
(CamelStore *store,
GCancellable *cancellable,
GError **error);
void camel_store_get_junk_folder (CamelStore *store,
gint io_priority,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
CamelFolder * camel_store_get_junk_folder_finish
(CamelStore *store,
GAsyncResult *result,
GError **error);
CamelFolder * camel_store_get_trash_folder_sync
(CamelStore *store,
GCancellable *cancellable,
GError **error);
void camel_store_get_trash_folder (CamelStore *store,
gint io_priority,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
CamelFolder * camel_store_get_trash_folder_finish
(CamelStore *store,
GAsyncResult *result,
GError **error);
CamelFolderInfo *
camel_store_create_folder_sync (CamelStore *store,
const gchar *parent_name,
const gchar *folder_name,
GCancellable *cancellable,
GError **error);
void camel_store_create_folder (CamelStore *store,
const gchar *parent_name,
const gchar *folder_name,
gint io_priority,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
CamelFolderInfo *
camel_store_create_folder_finish
(CamelStore *store,
GAsyncResult *result,
GError **error);
gboolean camel_store_delete_folder_sync (CamelStore *store,
const gchar *folder_name,
GCancellable *cancellable,
GError **error);
void camel_store_delete_folder (CamelStore *store,
const gchar *folder_name,
gint io_priority,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
gboolean camel_store_delete_folder_finish
(CamelStore *store,
GAsyncResult *result,
GError **error);
gboolean camel_store_rename_folder_sync (CamelStore *store,
const gchar *old_name,
const gchar *new_name,
GCancellable *cancellable,
GError **error);
void camel_store_rename_folder (CamelStore *store,
const gchar *old_name,
const gchar *new_name,
gint io_priority,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
gboolean camel_store_rename_folder_finish
(CamelStore *store,
GAsyncResult *result,
GError **error);
gboolean camel_store_synchronize_sync (CamelStore *store,
gboolean expunge,
GCancellable *cancellable,
GError **error);
void camel_store_synchronize (CamelStore *store,
gboolean expunge,
gint io_priority,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
gboolean camel_store_synchronize_finish (CamelStore *store,
GAsyncResult *result,
GError **error);
gboolean camel_store_maybe_run_db_maintenance
(CamelStore *store,
GError **error);
G_END_DECLS
#endif /* CAMEL_STORE_H */
|
