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
|
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/* camelFolder.h : Abstract class for an email folder */
/*
*
* Author :
* Bertrand Guiheneuf <bertrand@helixcode.com>
*
* Copyright 1999, 2000 Helix Code, Inc. (http://www.helixcode.com)
*
* 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307
* USA
*/
#ifndef CAMEL_FOLDER_H
#define CAMEL_FOLDER_H 1
#ifdef __cplusplus
extern "C" {
#pragma }
#endif /* __cplusplus }*/
#include <gtk/gtk.h>
#include "camel-types.h"
#define CAMEL_FOLDER_TYPE (camel_folder_get_type ())
#define CAMEL_FOLDER(obj) (GTK_CHECK_CAST((obj), CAMEL_FOLDER_TYPE, CamelFolder))
#define CAMEL_FOLDER_CLASS(k) (GTK_CHECK_CLASS_CAST ((k), CAMEL_FOLDER_TYPE, CamelFolderClass))
#define CAMEL_IS_FOLDER(o) (GTK_CHECK_TYPE((o), CAMEL_FOLDER_TYPE))
typedef enum {
FOLDER_OPEN,
FOLDER_CLOSE
} CamelFolderState;
typedef enum {
FOLDER_OPEN_UNKNOWN = 0, /* folder open mode is unknown */
FOLDER_OPEN_READ = 1, /* folder is read only */
FOLDER_OPEN_WRITE = 2, /* folder is write only */
FOLDER_OPEN_RW = 3 /* folder is read/write */
} CamelFolderOpenMode;
typedef void (*CamelFolderAsyncCallback) ();
typedef void (CamelSearchFunc)(CamelFolder *folder, int id, gboolean complete, GList *matches, void *data);
struct _CamelFolder
{
GtkObject parent_object;
gboolean can_hold_folders;
gboolean can_hold_messages;
CamelFolderOpenMode open_mode;
CamelFolderState open_state;
gchar *name;
gchar *full_name;
gchar separator;
CamelStore *parent_store;
CamelFolder *parent_folder;
GList *permanent_flags;
gboolean has_summary_capability;
CamelFolderSummary *summary;
gboolean has_uid_capability;
gboolean has_search_capability;
};
typedef struct {
GtkObjectClass parent_class;
/* Virtual methods */
void (*init) (CamelFolder *folder, CamelStore *parent_store,
CamelFolder *parent_folder, const gchar *name,
gchar separator, CamelException *ex);
void (*open) (CamelFolder *folder,
CamelFolderOpenMode mode,
CamelException *ex);
void (*close) (CamelFolder *folder,
gboolean expunge,
CamelException *ex);
void (*open_async) (CamelFolder *folder,
CamelFolderOpenMode mode,
CamelFolderAsyncCallback callback,
gpointer user_data,
CamelException *ex);
void (*close_async) (CamelFolder *folder,
gboolean expunge,
CamelFolderAsyncCallback callback,
gpointer user_data,
CamelException *ex);
void (*set_name) (CamelFolder *folder,
const gchar *name,
CamelException *ex);
const gchar * (*get_name) (CamelFolder *folder);
const gchar * (*get_full_name) (CamelFolder *folder);
gboolean (*can_hold_folders) (CamelFolder *folder);
gboolean (*can_hold_messages) (CamelFolder *folder);
gboolean (*exists) (CamelFolder *folder,
CamelException *ex);
gboolean (*is_open) (CamelFolder *folder);
CamelFolder * (*get_subfolder) (CamelFolder *folder,
const gchar *folder_name,
CamelException *ex);
gboolean (*create) (CamelFolder *folder,
CamelException *ex);
gboolean (*delete) (CamelFolder *folder,
gboolean recurse,
CamelException *ex);
gboolean (*delete_messages) (CamelFolder *folder,
CamelException *ex);
CamelFolder * (*get_parent_folder) (CamelFolder *folder,
CamelException *ex);
CamelStore * (*get_parent_store) (CamelFolder *folder,
CamelException *ex);
CamelFolderOpenMode (*get_mode) (CamelFolder *folder,
CamelException *ex);
GList * (*list_subfolders) (CamelFolder *folder,
CamelException *ex);
GList * (*expunge) (CamelFolder *folder,
CamelException *ex);
gboolean (*has_message_number_capability) (CamelFolder *folder);
CamelMimeMessage * (*get_message_by_number) (CamelFolder *folder,
gint number,
CamelException *ex);
void (*delete_message_by_number) (CamelFolder *folder,
gint number,
CamelException *ex);
gint (*get_message_count) (CamelFolder *folder,
CamelException *ex);
void (*append_message) (CamelFolder *folder,
CamelMimeMessage *message,
CamelException *ex);
const GList * (*list_permanent_flags) (CamelFolder *folder,
CamelException *ex);
void (*copy_message_to) (CamelFolder *folder,
CamelMimeMessage *message,
CamelFolder *dest_folder,
CamelException *ex);
gboolean (*has_uid_capability) (CamelFolder *folder);
const gchar * (*get_message_uid) (CamelFolder *folder,
CamelMimeMessage *message,
CamelException *ex);
CamelMimeMessage * (*get_message_by_uid) (CamelFolder *folder,
const gchar *uid,
CamelException *ex);
void (*delete_message_by_uid) (CamelFolder *folder,
const gchar *uid,
CamelException *ex);
GList * (*get_uid_list) (CamelFolder *folder,
CamelException *ex);
gboolean (*has_search_capability) (CamelFolder *folder);
int (*search_by_expression) (CamelFolder *folder, const char *expression,
CamelSearchFunc *func, void *data, CamelException *ex);
gboolean (*search_complete)(CamelFolder *folder, int searchid, gboolean wait, CamelException *ex);
void (*search_cancel) (CamelFolder *folder, int searchid, CamelException *ex);
} CamelFolderClass;
/* Standard Gtk function */
GtkType camel_folder_get_type (void);
/* public methods */
CamelFolder * camel_folder_get_subfolder (CamelFolder *folder,
gchar *folder_name,
CamelException *ex);
void camel_folder_open (CamelFolder *folder,
CamelFolderOpenMode mode,
CamelException *ex);
void camel_folder_close (CamelFolder *folder,
gboolean expunge,
CamelException *ex);
gboolean camel_folder_create (CamelFolder *folder,
CamelException *ex);
CamelFolder * camel_folder_get_parent_folder (CamelFolder *folder,
CamelException *ex);
CamelStore * camel_folder_get_parent_store (CamelFolder *folder,
CamelException *ex);
GList * camel_folder_list_subfolders (CamelFolder *folder,
CamelException *ex);
/* delete operations */
gboolean camel_folder_delete (CamelFolder *folder,
gboolean recurse,
CamelException *ex);
gboolean camel_folder_delete_messages (CamelFolder *folder,
CamelException *ex);
GList * camel_folder_expunge (CamelFolder *folder,
CamelException *ex);
/* folder name operations */
const gchar * camel_folder_get_name (CamelFolder *folder);
const gchar * camel_folder_get_full_name (CamelFolder *folder);
/* various properties accessors */
gboolean camel_folder_exists (CamelFolder *folder,
CamelException *ex);
const GList * camel_folder_list_permanent_flags (CamelFolder *folder,
CamelException *ex);
CamelFolderOpenMode camel_folder_get_mode (CamelFolder *folder,
CamelException *ex);
gboolean camel_folder_is_open (CamelFolder *folder);
/* message manipulation */
void camel_folder_append_message (CamelFolder *folder,
CamelMimeMessage *message,
CamelException *ex);
void camel_folder_copy_message_to (CamelFolder *folder,
CamelMimeMessage *message,
CamelFolder *dest_folder,
CamelException *ex);
/* summary related operations */
gboolean camel_folder_has_summary_capability (CamelFolder *folder);
CamelFolderSummary *camel_folder_get_summary (CamelFolder *folder,
CamelException *ex);
/* number based access operations */
gboolean camel_folder_has_message_number_capability (CamelFolder *folder);
CamelMimeMessage * camel_folder_get_message_by_number (CamelFolder *folder,
gint number,
CamelException *ex);
void camel_folder_delete_message_by_number (CamelFolder *folder,
gint number,
CamelException *ex);
gint camel_folder_get_message_count (CamelFolder *folder,
CamelException *ex);
/* uid based access operations */
gboolean camel_folder_has_uid_capability (CamelFolder *folder);
const gchar * camel_folder_get_message_uid (CamelFolder *folder,
CamelMimeMessage *message,
CamelException *ex);
CamelMimeMessage * camel_folder_get_message_by_uid (CamelFolder *folder,
const gchar *uid,
CamelException *ex);
void camel_folder_delete_message_by_uid (CamelFolder *folder,
const gchar *uid,
CamelException *ex);
GList * camel_folder_get_uid_list (CamelFolder *folder,
CamelException *ex);
/* search api */
gboolean camel_folder_has_search_capability (CamelFolder *folder);
int camel_folder_search_by_expression(CamelFolder *folder, const char *expression,
CamelSearchFunc *func, void *data, CamelException *ex);
gboolean camel_folder_search_complete(CamelFolder *folder, int searchid, gboolean wait, CamelException *ex);
void camel_folder_search_cancel(CamelFolder *folder, int searchid, CamelException *ex);
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif /* CAMEL_FOLDER_H */
|
