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
|
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/*
* 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/>.
*
*/
#ifndef CAMEL_IMAPX_SERVER_H
#define CAMEL_IMAPX_SERVER_H
#include <camel/camel.h>
#include "camel-imapx-command.h"
#include "camel-imapx-mailbox.h"
#include "camel-imapx-namespace-response.h"
#include "camel-imapx-store-summary.h"
/* Standard GObject macros */
#define CAMEL_TYPE_IMAPX_SERVER \
(camel_imapx_server_get_type ())
#define CAMEL_IMAPX_SERVER(obj) \
(G_TYPE_CHECK_INSTANCE_CAST \
((obj), CAMEL_TYPE_IMAPX_SERVER, CamelIMAPXServer))
#define CAMEL_IMAPX_SERVER_CLASS(cls) \
(G_TYPE_CHECK_CLASS_CAST \
((cls), CAMEL_TYPE_IMAPX_SERVER, CamelIMAPXServerClass))
#define CAMEL_IS_IMAPX_SERVER(obj) \
(G_TYPE_CHECK_INSTANCE_TYPE \
((obj), CAMEL_TYPE_IMAPX_SERVER))
#define CAMEL_IS_IMAPX_SERVER_CLASS(cls) \
(G_TYPE_CHECK_CLASS_TYPE \
((cls), CAMEL_TYPE_IMAPX_SERVER))
#define CAMEL_IMAPX_SERVER_GET_CLASS(obj) \
(G_TYPE_INSTANCE_GET_CLASS \
((obj), CAMEL_TYPE_IMAPX_SERVER, CamelIMAPXServerClass))
#define CAMEL_IMAPX_SERVER_ERROR (camel_imapx_server_error_quark ())
G_BEGIN_DECLS
typedef enum {
CAMEL_IMAPX_SERVER_ERROR_CONCURRENT_CONNECT_FAILED,
CAMEL_IMAPX_SERVER_ERROR_TRY_RECONNECT
} CamelIMAPXServerError;
GQuark camel_imapx_server_error_quark (void) G_GNUC_CONST;
/* Avoid a circular reference. */
struct _CamelIMAPXStore;
struct _CamelIMAPXSettings;
struct _CamelIMAPXJob;
typedef struct _CamelIMAPXServer CamelIMAPXServer;
typedef struct _CamelIMAPXServerClass CamelIMAPXServerClass;
typedef struct _CamelIMAPXServerPrivate CamelIMAPXServerPrivate;
/* untagged response handling */
typedef gboolean
(*CamelIMAPXUntaggedRespHandler)
(CamelIMAPXServer *server,
GInputStream *input_stream,
GCancellable *cancellable,
GError **error);
/**
* CamelIMAPXUntaggedRespHandlerDesc:
* @untagged_response: a string representation of the IMAP
* untagged response code. Must be
* all-uppercase with underscores allowed
* (see RFC 3501)
* @handler: an untagged response handler function for #CamelIMAPXServer
* @next_response: the IMAP untagged code to call a registered
* handler for directly after successfully
* running @handler. If not NULL, @skip_stream_when_done
* for the current handler has no effect
* @skip_stream_when_done: whether or not to skip the current IMAP
* untagged response in the #GInputStream.
* Set to TRUE if your handler does not eat
* the stream up to the next response token
*
* IMAP untagged response handler function descriptor. Use in conjunction
* with camel_imapx_server_register_untagged_handler() to register a new
* handler function for a given untagged response code
*
* Since: 3.6
*/
typedef struct _CamelIMAPXUntaggedRespHandlerDesc CamelIMAPXUntaggedRespHandlerDesc;
struct _CamelIMAPXUntaggedRespHandlerDesc {
const gchar *untagged_response;
const CamelIMAPXUntaggedRespHandler handler;
const gchar *next_response;
gboolean skip_stream_when_done;
};
struct _CamelIMAPXServer {
GObject parent;
CamelIMAPXServerPrivate *priv;
};
struct _CamelIMAPXServerClass {
GObjectClass parent_class;
/* Signals */
void (*refresh_mailbox) (CamelIMAPXServer *is,
CamelIMAPXMailbox *mailbox);
};
GType camel_imapx_server_get_type (void);
CamelIMAPXServer *
camel_imapx_server_new (struct _CamelIMAPXStore *store);
struct _CamelIMAPXStore *
camel_imapx_server_ref_store (CamelIMAPXServer *is);
struct _CamelIMAPXSettings *
camel_imapx_server_ref_settings (CamelIMAPXServer *is);
GInputStream * camel_imapx_server_ref_input_stream
(CamelIMAPXServer *is);
GOutputStream * camel_imapx_server_ref_output_stream
(CamelIMAPXServer *is);
CamelIMAPXMailbox *
camel_imapx_server_ref_selected (CamelIMAPXServer *is);
CamelIMAPXMailbox *
camel_imapx_server_ref_pending_or_selected
(CamelIMAPXServer *is);
const struct _capability_info *
camel_imapx_server_get_capability_info
(CamelIMAPXServer *is);
gboolean camel_imapx_server_have_capability
(CamelIMAPXServer *is,
guint32 capability);
gboolean camel_imapx_server_lack_capability
(CamelIMAPXServer *is,
guint32 capability);
gchar camel_imapx_server_get_tagprefix
(CamelIMAPXServer *is);
void camel_imapx_server_set_tagprefix
(CamelIMAPXServer *is,
gchar tagprefix);
CamelIMAPXCommand *
camel_imapx_server_ref_current_command
(CamelIMAPXServer *is);
gboolean camel_imapx_server_connect_sync (CamelIMAPXServer *is,
GCancellable *cancellable,
GError **error);
gboolean camel_imapx_server_disconnect_sync
(CamelIMAPXServer *is,
GCancellable *cancellable,
GError **error);
gboolean camel_imapx_server_is_connected (CamelIMAPXServer *imapx_server);
CamelAuthenticationResult
camel_imapx_server_authenticate_sync
(CamelIMAPXServer *is,
const gchar *mechanism,
GCancellable *cancellable,
GError **error);
gboolean camel_imapx_server_query_auth_types_sync
(CamelIMAPXServer *is,
GCancellable *cancellable,
GError **error);
gboolean camel_imapx_server_mailbox_selected
(CamelIMAPXServer *is,
CamelIMAPXMailbox *mailbox);
gboolean camel_imapx_server_ensure_selected_sync
(CamelIMAPXServer *is,
CamelIMAPXMailbox *mailbox,
GCancellable *cancellable,
GError **error);
gboolean camel_imapx_server_process_command_sync
(CamelIMAPXServer *is,
CamelIMAPXCommand *ic,
const gchar *error_prefix,
GCancellable *cancellable,
GError **error);
gboolean camel_imapx_server_list_sync (CamelIMAPXServer *is,
const gchar *pattern,
CamelStoreGetFolderInfoFlags flags,
GCancellable *cancellable,
GError **error);
gboolean camel_imapx_server_refresh_info_sync
(CamelIMAPXServer *is,
CamelIMAPXMailbox *mailbox,
GCancellable *cancellable,
GError **error);
gboolean camel_imapx_server_sync_changes_sync
(CamelIMAPXServer *is,
CamelIMAPXMailbox *mailbox,
gboolean can_influence_flags,
GCancellable *cancellable,
GError **error);
gboolean camel_imapx_server_expunge_sync (CamelIMAPXServer *is,
CamelIMAPXMailbox *mailbox,
GCancellable *cancellable,
GError **error);
gboolean camel_imapx_server_noop_sync (CamelIMAPXServer *is,
CamelIMAPXMailbox *mailbox,
GCancellable *cancellable,
GError **error);
CamelStream * camel_imapx_server_get_message_sync
(CamelIMAPXServer *is,
CamelIMAPXMailbox *mailbox,
CamelFolderSummary *summary,
CamelDataCache *message_cache,
const gchar *message_uid,
GCancellable *cancellable,
GError **error);
gboolean camel_imapx_server_copy_message_sync
(CamelIMAPXServer *is,
CamelIMAPXMailbox *mailbox,
CamelIMAPXMailbox *destination,
GPtrArray *uids,
gboolean delete_originals,
gboolean remove_deleted_flags,
GCancellable *cancellable,
GError **error);
gboolean camel_imapx_server_append_message_sync
(CamelIMAPXServer *is,
CamelIMAPXMailbox *mailbox,
CamelFolderSummary *summary,
CamelDataCache *message_cache,
CamelMimeMessage *message,
const CamelMessageInfo *mi,
gchar **append_uid,
GCancellable *cancellable,
GError **error);
gboolean camel_imapx_server_sync_message_sync
(CamelIMAPXServer *is,
CamelIMAPXMailbox *mailbox,
CamelFolderSummary *summary,
CamelDataCache *message_cache,
const gchar *message_uid,
GCancellable *cancellable,
GError **error);
gboolean camel_imapx_server_create_mailbox_sync
(CamelIMAPXServer *is,
const gchar *mailbox_name,
GCancellable *cancellable,
GError **error);
gboolean camel_imapx_server_delete_mailbox_sync
(CamelIMAPXServer *is,
CamelIMAPXMailbox *mailbox,
GCancellable *cancellable,
GError **error);
gboolean camel_imapx_server_rename_mailbox_sync
(CamelIMAPXServer *is,
CamelIMAPXMailbox *mailbox,
const gchar *new_mailbox_name,
GCancellable *cancellable,
GError **error);
gboolean camel_imapx_server_subscribe_mailbox_sync
(CamelIMAPXServer *is,
CamelIMAPXMailbox *mailbox,
GCancellable *cancellable,
GError **error);
gboolean camel_imapx_server_unsubscribe_mailbox_sync
(CamelIMAPXServer *is,
CamelIMAPXMailbox *mailbox,
GCancellable *cancellable,
GError **error);
gboolean camel_imapx_server_update_quota_info_sync
(CamelIMAPXServer *is,
CamelIMAPXMailbox *mailbox,
GCancellable *cancellable,
GError **error);
GPtrArray * camel_imapx_server_uid_search_sync
(CamelIMAPXServer *is,
CamelIMAPXMailbox *mailbox,
const gchar *criteria_prefix,
const gchar *search_key,
const gchar * const *words,
GCancellable *cancellable,
GError **error);
gboolean camel_imapx_server_can_use_idle (CamelIMAPXServer *is);
gboolean camel_imapx_server_is_in_idle (CamelIMAPXServer *is);
CamelIMAPXMailbox *
camel_imapx_server_ref_idle_mailbox
(CamelIMAPXServer *is);
gboolean camel_imapx_server_schedule_idle_sync
(CamelIMAPXServer *is,
CamelIMAPXMailbox *mailbox,
GCancellable *cancellable,
GError **error);
gboolean camel_imapx_server_stop_idle_sync
(CamelIMAPXServer *is,
GCancellable *cancellable,
GError **error);
const CamelIMAPXUntaggedRespHandlerDesc *
camel_imapx_server_register_untagged_handler
(CamelIMAPXServer *is,
const gchar *untagged_response,
const CamelIMAPXUntaggedRespHandlerDesc *desc);
G_END_DECLS
#endif /* CAMEL_IMAPX_SERVER_H */
|
