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
|
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/* camel-store.h : Abstract class for an email store */
/*
*
* Authors: Bertrand Guiheneuf <bertrand@helixcode.com>
* Michael Zucchi <NotZed@ximian.com>
* Jeffrey Stedfast <fejj@ximian.com>
*
* Copyright 1999, 2003 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_STORE_H
#define CAMEL_STORE_H 1
#ifdef __cplusplus
extern "C" {
#pragma }
#endif /* __cplusplus */
/* for mode_t */
#include <sys/types.h>
#include <camel/camel-object.h>
#include <camel/camel-service.h>
enum {
CAMEL_STORE_ARG_FIRST = CAMEL_SERVICE_ARG_FIRST + 100,
};
typedef struct _CamelFolderInfo {
struct _CamelFolderInfo *next;
struct _CamelFolderInfo *parent;
struct _CamelFolderInfo *child;
char *uri;
char *name;
char *full_name;
char *path;
guint32 flags;
guint32 unread;
guint32 total;
} CamelFolderInfo;
/* Note: these are abstractions (duh), its upto the provider to make them make sense */
/* a folder which can't contain messages */
#define CAMEL_FOLDER_NOSELECT (1<<0)
/* a folder which cannot have children */
#define CAMEL_FOLDER_NOINFERIORS (1<<1)
/* a folder which has children (not yet fully implemented) */
#define CAMEL_FOLDER_CHILDREN (1<<2)
/* a folder which does not have any children (not yet fully implemented) */
#define CAMEL_FOLDER_NOCHILDREN (1<<3)
/* a folder which is subscribed */
#define CAMEL_FOLDER_SUBSCRIBED (1<<4)
/* a virtual folder, cannot copy/move messages here */
#define CAMEL_FOLDER_VIRTUAL (1<<5)
/* a system folder, cannot be renamed/deleted */
#define CAMEL_FOLDER_SYSTEM (1<<6)
/* a virtual folder that can't be copied to, and can only be moved to if in an existing folder */
#define CAMEL_FOLDER_VTRASH (1<<7)
/* Structure of rename event's event_data */
typedef struct _CamelRenameInfo {
char *old_base;
struct _CamelFolderInfo *new;
} CamelRenameInfo;
#define CAMEL_STORE_TYPE (camel_store_get_type ())
#define CAMEL_STORE(obj) (CAMEL_CHECK_CAST((obj), CAMEL_STORE_TYPE, CamelStore))
#define CAMEL_STORE_CLASS(k) (CAMEL_CHECK_CLASS_CAST ((k), CAMEL_STORE_TYPE, CamelStoreClass))
#define CAMEL_IS_STORE(o) (CAMEL_CHECK_TYPE((o), CAMEL_STORE_TYPE))
/* Flags for store flags */
#define CAMEL_STORE_SUBSCRIPTIONS (1 << 0)
#define CAMEL_STORE_VTRASH (1 << 1)
#define CAMEL_STORE_FILTER_INBOX (1 << 2)
#define CAMEL_STORE_VJUNK (1 << 3)
struct _CamelStore
{
CamelService parent_object;
struct _CamelStorePrivate *priv;
CamelObjectBag *folders;
int flags;
/* FIXME: This is a temporary measure until IMAP namespaces are properly implemented,
after that, all external folder api's will assume a dir separator of '/' */
/* This is always a copy of IMAP_STORE()->dir_sep, or '/' */
char dir_sep;
};
/* open mode for folder */
#define CAMEL_STORE_FOLDER_CREATE (1<<0)
#define CAMEL_STORE_FOLDER_EXCL (1<<1)
#define CAMEL_STORE_FOLDER_BODY_INDEX (1<<2)
#define CAMEL_STORE_FOLDER_PRIVATE (1<<3) /* a private folder, that shouldn't show up in unmatched/folder info's, etc */
#define CAMEL_STORE_FOLDER_CREATE_EXCL (CAMEL_STORE_FOLDER_CREATE | CAMEL_STORE_FOLDER_EXCL)
#define CAMEL_STORE_FOLDER_INFO_FAST (1 << 0)
#define CAMEL_STORE_FOLDER_INFO_RECURSIVE (1 << 1)
#define CAMEL_STORE_FOLDER_INFO_SUBSCRIBED (1 << 2)
#define CAMEL_STORE_FOLDER_INFO_NO_VIRTUAL (1 << 3) /* don't include vTrash/vJunk folders */
typedef struct {
CamelServiceClass parent_class;
GHashFunc hash_folder_name;
GCompareFunc compare_folder_name;
CamelFolder * (*get_folder) (CamelStore *store,
const char *folder_name,
guint32 flags,
CamelException *ex);
CamelFolder * (*get_inbox) (CamelStore *store, CamelException *ex);
CamelFolder * (*get_trash) (CamelStore *store, CamelException *ex);
CamelFolder * (*get_junk) (CamelStore *store, CamelException *ex);
CamelFolderInfo *(*create_folder) (CamelStore *store,
const char *parent_name,
const char *folder_name,
CamelException *ex);
void (*delete_folder) (CamelStore *store,
const char *folder_name,
CamelException *ex);
void (*rename_folder) (CamelStore *store,
const char *old_name,
const char *new_name,
CamelException *ex);
void (*sync) (CamelStore *store, int expunge, CamelException *ex);
CamelFolderInfo *(*get_folder_info) (CamelStore *store,
const char *top,
guint32 flags,
CamelException *ex);
void (*free_folder_info) (CamelStore *store,
CamelFolderInfo *fi);
gboolean (*folder_subscribed) (CamelStore *store,
const char *folder_name);
void (*subscribe_folder) (CamelStore *store,
const char *folder_name,
CamelException *ex);
void (*unsubscribe_folder) (CamelStore *store,
const char *folder_name,
CamelException *ex);
void (*noop) (CamelStore *store,
CamelException *ex);
} CamelStoreClass;
/* Standard Camel function */
CamelType camel_store_get_type (void);
/* public methods */
CamelFolder * camel_store_get_folder (CamelStore *store,
const char *folder_name,
guint32 flags,
CamelException *ex);
CamelFolder * camel_store_get_inbox (CamelStore *store,
CamelException *ex);
CamelFolder * camel_store_get_trash (CamelStore *store,
CamelException *ex);
CamelFolder * camel_store_get_junk (CamelStore *store,
CamelException *ex);
CamelFolderInfo *camel_store_create_folder (CamelStore *store,
const char *parent_name,
const char *folder_name,
CamelException *ex);
void camel_store_delete_folder (CamelStore *store,
const char *folder_name,
CamelException *ex);
void camel_store_rename_folder (CamelStore *store,
const char *old_name,
const char *new_name,
CamelException *ex);
void camel_store_sync (CamelStore *store, int expunge, CamelException *ex);
CamelFolderInfo *camel_store_get_folder_info (CamelStore *store,
const char *top,
guint32 flags,
CamelException *ex);
void camel_store_free_folder_info (CamelStore *store,
CamelFolderInfo *fi);
void camel_store_free_folder_info_full (CamelStore *store,
CamelFolderInfo *fi);
void camel_store_free_folder_info_nop (CamelStore *store,
CamelFolderInfo *fi);
void camel_folder_info_free (CamelFolderInfo *fi);
void camel_folder_info_build_path (CamelFolderInfo *fi,
char separator);
CamelFolderInfo *camel_folder_info_build (GPtrArray *folders,
const char *namespace,
char separator,
gboolean short_names);
CamelFolderInfo *camel_folder_info_clone (CamelFolderInfo *fi);
gboolean camel_store_supports_subscriptions (CamelStore *store);
gboolean camel_store_folder_subscribed (CamelStore *store,
const char *folder_name);
void camel_store_subscribe_folder (CamelStore *store,
const char *folder_name,
CamelException *ex);
void camel_store_unsubscribe_folder (CamelStore *store,
const char *folder_name,
CamelException *ex);
void camel_store_noop (CamelStore *store,
CamelException *ex);
int camel_store_folder_uri_equal (CamelStore *store,
const char *uri0,
const char *uri1);
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif /* CAMEL_STORE_H */
|
