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
|
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/* camel-folder.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 <camel/camel-object.h>
#include <camel/camel-folder-summary.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))
struct _CamelFolder
{
CamelObject parent_object;
gchar *name;
gchar *full_name;
gchar *separator;
CamelStore *parent_store;
CamelFolder *parent_folder;
guint32 permanent_flags;
gboolean path_begins_with_sep;
gboolean can_hold_folders:1;
gboolean can_hold_messages:1;
gboolean has_summary_capability:1;
gboolean has_search_capability:1;
};
typedef struct {
CamelObjectClass parent_class;
/* signals */
void (*folder_changed) (CamelFolder *, int type);
void (*message_changed) (CamelFolder *,
const char *uid);
/* Virtual methods */
void (*init) (CamelFolder *folder, CamelStore *parent_store,
CamelFolder *parent_folder, const gchar *name,
gchar *separator, gboolean path_begins_with_sep,
CamelException *ex);
void (*sync) (CamelFolder *folder, gboolean expunge,
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);
CamelFolder * (*get_subfolder) (CamelFolder *folder,
const gchar *folder_name,
gboolean create,
CamelException *ex);
CamelFolder * (*get_parent_folder) (CamelFolder *folder,
CamelException *ex);
CamelStore * (*get_parent_store) (CamelFolder *folder,
CamelException *ex);
void (*expunge) (CamelFolder *folder,
CamelException *ex);
gint (*get_message_count) (CamelFolder *folder,
CamelException *ex);
void (*append_message) (CamelFolder *folder,
CamelMimeMessage *message,
CamelException *ex);
guint32 (*get_permanent_flags) (CamelFolder *folder,
CamelException *ex);
guint32 (*get_message_flags) (CamelFolder *folder,
const char *uid,
CamelException *ex);
void (*set_message_flags) (CamelFolder *folder,
const char *uid,
guint32 flags, guint32 set,
CamelException *ex);
gboolean (*get_message_user_flag) (CamelFolder *folder,
const char *uid,
const char *name,
CamelException *ex);
void (*set_message_user_flag) (CamelFolder *folder,
const char *uid,
const char *name,
gboolean value,
CamelException *ex);
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);
GPtrArray * (*get_uids) (CamelFolder *folder,
CamelException *ex);
void (*free_uids) (CamelFolder *folder,
GPtrArray *array);
GPtrArray * (*get_summary) (CamelFolder *folder,
CamelException *ex);
void (*free_summary) (CamelFolder *folder,
GPtrArray *summary);
GPtrArray * (*get_subfolder_names) (CamelFolder *folder,
CamelException *ex);
void (*free_subfolder_names) (CamelFolder *folder,
GPtrArray *subfolders);
gboolean (*has_search_capability) (CamelFolder *folder);
GList * (*search_by_expression) (CamelFolder *folder, const char *expression, CamelException *ex);
const CamelMessageInfo * (*summary_get_by_uid) (CamelFolder *, const char *uid);
} CamelFolderClass;
/* Standard Gtk function */
GtkType camel_folder_get_type (void);
/* public methods */
CamelFolder * camel_folder_get_subfolder (CamelFolder *folder,
const gchar *folder_name,
gboolean create,
CamelException *ex);
void camel_folder_sync (CamelFolder *folder,
gboolean expunge,
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 */
void 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 */
guint32 camel_folder_get_permanent_flags (CamelFolder *folder,
CamelException *ex);
guint32 camel_folder_get_message_flags (CamelFolder *folder,
const char *uid,
CamelException *ex);
void camel_folder_set_message_flags (CamelFolder *folder,
const char *uid,
guint32 flags,
guint32 set,
CamelException *ex);
gboolean camel_folder_get_message_user_flag (CamelFolder *folder,
const char *uid,
const char *name,
CamelException *ex);
void camel_folder_set_message_user_flag (CamelFolder *folder,
const char *uid,
const char *name,
gboolean value,
CamelException *ex);
/* message manipulation */
void camel_folder_append_message (CamelFolder *folder,
CamelMimeMessage *message,
CamelException *ex);
/* summary related operations */
gboolean camel_folder_has_summary_capability (CamelFolder *folder);
gint camel_folder_get_message_count (CamelFolder *folder,
CamelException *ex);
GPtrArray * camel_folder_get_summary (CamelFolder *folder,
CamelException *ex);
void camel_folder_free_summary (CamelFolder *folder,
GPtrArray *array);
GPtrArray * camel_folder_get_subfolder_names (CamelFolder *folder,
CamelException *ex);
void camel_folder_free_subfolder_names (CamelFolder *folder,
GPtrArray *array);
/* uid based access operations */
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);
GPtrArray * camel_folder_get_uids (CamelFolder *folder,
CamelException *ex);
void camel_folder_free_uids (CamelFolder *folder,
GPtrArray *array);
/* search api */
gboolean camel_folder_has_search_capability (CamelFolder *folder);
GList * camel_folder_search_by_expression (CamelFolder *folder, const char *expression, CamelException *ex);
/* summary info. FIXME: rename this slightly? */
const CamelMessageInfo *camel_folder_summary_get_by_uid (CamelFolder *summary,
const char *uid);
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif /* CAMEL_FOLDER_H */
|
