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
|
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/* camel-service.h : Abstract class for an email service
*
* 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>
*/
#if !defined (__CAMEL_H_INSIDE__) && !defined (CAMEL_COMPILATION)
#error "Only <camel/camel.h> can be included directly."
#endif
#ifndef CAMEL_SERVICE_H
#define CAMEL_SERVICE_H
#include <camel/camel-enums.h>
#include <camel/camel-object.h>
#include <camel/camel-url.h>
#include <camel/camel-provider.h>
#include <camel/camel-operation.h>
#include <camel/camel-settings.h>
/* Standard GObject macros */
#define CAMEL_TYPE_SERVICE \
(camel_service_get_type ())
#define CAMEL_SERVICE(obj) \
(G_TYPE_CHECK_INSTANCE_CAST \
((obj), CAMEL_TYPE_SERVICE, CamelService))
#define CAMEL_SERVICE_CLASS(cls) \
(G_TYPE_CHECK_CLASS_CAST \
((cls), CAMEL_TYPE_SERVICE, CamelServiceClass))
#define CAMEL_IS_SERVICE(obj) \
(G_TYPE_CHECK_INSTANCE_TYPE \
((obj), CAMEL_TYPE_SERVICE))
#define CAMEL_IS_SERVICE_CLASS(obj) \
(G_TYPE_CHECK_CLASS_TYPE \
((cls), CAMEL_TYPE_SERVICE))
#define CAMEL_SERVICE_GET_CLASS(obj) \
(G_TYPE_INSTANCE_GET_CLASS \
((obj), CAMEL_TYPE_SERVICE, CamelServiceClass))
/**
* CAMEL_SERVICE_ERROR:
*
* Since: 2.32
**/
#define CAMEL_SERVICE_ERROR \
(camel_service_error_quark ())
G_BEGIN_DECLS
struct _CamelSession;
typedef struct _CamelService CamelService;
typedef struct _CamelServiceClass CamelServiceClass;
typedef struct _CamelServicePrivate CamelServicePrivate;
/**
* CamelServiceError:
*
* Since: 2.32
**/
typedef enum {
CAMEL_SERVICE_ERROR_INVALID,
CAMEL_SERVICE_ERROR_URL_INVALID,
CAMEL_SERVICE_ERROR_UNAVAILABLE,
CAMEL_SERVICE_ERROR_CANT_AUTHENTICATE,
CAMEL_SERVICE_ERROR_NOT_CONNECTED
} CamelServiceError;
struct _CamelService {
CamelObject parent;
CamelServicePrivate *priv;
};
struct _CamelServiceClass {
CamelObjectClass parent_class;
GType settings_type;
/* Non-Blocking Methods */
gchar * (*get_name) (CamelService *service,
gboolean brief);
/* Synchronous I/O Methods */
gboolean (*connect_sync) (CamelService *service,
GCancellable *cancellable,
GError **error);
gboolean (*disconnect_sync) (CamelService *service,
gboolean clean,
GCancellable *cancellable,
GError **error);
CamelAuthenticationResult
(*authenticate_sync) (CamelService *service,
const gchar *mechanism,
GCancellable *cancellable,
GError **error);
GList * (*query_auth_types_sync)
(CamelService *service,
GCancellable *cancellable,
GError **error);
/* Reserved slots. */
gpointer reserved[8];
};
/* query_auth_types returns a GList of these */
typedef struct {
const gchar *name; /* user-friendly name */
const gchar *description;
const gchar *authproto;
gboolean need_password; /* needs a password to authenticate */
} CamelServiceAuthType;
GType camel_service_get_type (void);
GQuark camel_service_error_quark (void) G_GNUC_CONST;
void camel_service_migrate_files (CamelService *service);
CamelURL * camel_service_new_camel_url (CamelService *service);
CamelServiceConnectionStatus
camel_service_get_connection_status
(CamelService *service);
const gchar * camel_service_get_display_name (CamelService *service);
gchar * camel_service_dup_display_name (CamelService *service);
void camel_service_set_display_name (CamelService *service,
const gchar *display_name);
const gchar * camel_service_get_password (CamelService *service);
gchar * camel_service_dup_password (CamelService *service);
void camel_service_set_password (CamelService *service,
const gchar *password);
const gchar * camel_service_get_user_data_dir (CamelService *service);
const gchar * camel_service_get_user_cache_dir
(CamelService *service);
gchar * camel_service_get_name (CamelService *service,
gboolean brief);
CamelProvider * camel_service_get_provider (CamelService *service);
GProxyResolver *
camel_service_ref_proxy_resolver
(CamelService *service);
void camel_service_set_proxy_resolver
(CamelService *service,
GProxyResolver *proxy_resolver);
struct _CamelSession *
camel_service_ref_session (CamelService *service);
CamelSettings * camel_service_ref_settings (CamelService *service);
void camel_service_set_settings (CamelService *service,
CamelSettings *settings);
const gchar * camel_service_get_uid (CamelService *service);
void camel_service_queue_task (CamelService *service,
GTask *task,
GTaskThreadFunc task_func);
gboolean camel_service_connect_sync (CamelService *service,
GCancellable *cancellable,
GError **error);
void camel_service_connect (CamelService *service,
gint io_priority,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
gboolean camel_service_connect_finish (CamelService *service,
GAsyncResult *result,
GError **error);
gboolean camel_service_disconnect_sync (CamelService *service,
gboolean clean,
GCancellable *cancellable,
GError **error);
void camel_service_disconnect (CamelService *service,
gboolean clean,
gint io_priority,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
gboolean camel_service_disconnect_finish (CamelService *service,
GAsyncResult *result,
GError **error);
CamelAuthenticationResult
camel_service_authenticate_sync (CamelService *service,
const gchar *mechanism,
GCancellable *cancellable,
GError **error);
void camel_service_authenticate (CamelService *service,
const gchar *mechanism,
gint io_priority,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
CamelAuthenticationResult
camel_service_authenticate_finish
(CamelService *service,
GAsyncResult *result,
GError **error);
GList * camel_service_query_auth_types_sync
(CamelService *service,
GCancellable *cancellable,
GError **error);
void camel_service_query_auth_types (CamelService *service,
gint io_priority,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
GList * camel_service_query_auth_types_finish
(CamelService *service,
GAsyncResult *result,
GError **error);
G_END_DECLS
#endif /* CAMEL_SERVICE_H */
|
