1 /* Copyright (c) 2006, Nokia Corporation
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
8 * * Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * * Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * * Neither the name of the Nokia Corporation nor the names of its
14 * contributors may be used to endorse or promote products derived from
15 * this software without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
18 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
19 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
20 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
21 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
24 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
25 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
26 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 #ifndef __MODEST_ACCOUNT_MGR_H__
32 #define __MODEST_ACCOUNT_MGR_H__
34 #include <glib-object.h>
35 #include <modest-conf.h>
36 #include <modest-defs.h>
37 #include <modest-protocol-info.h>
41 /* convenience macros */
42 #define MODEST_TYPE_ACCOUNT_MGR (modest_account_mgr_get_type())
43 #define MODEST_ACCOUNT_MGR(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_ACCOUNT_MGR,ModestAccountMgr))
44 #define MODEST_ACCOUNT_MGR_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_ACCOUNT_MGR,ModestAccountMgrClass))
45 #define MODEST_IS_ACCOUNT_MGR(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_ACCOUNT_MGR))
46 #define MODEST_IS_ACCOUNT_MGR_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_ACCOUNT_MGR))
47 #define MODEST_ACCOUNT_MGR_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_ACCOUNT_MGR,ModestAccountMgrClass))
49 typedef struct _ModestAccountMgr ModestAccountMgr;
50 typedef struct _ModestAccountMgrClass ModestAccountMgrClass;
52 struct _ModestAccountMgr {
56 struct _ModestAccountMgrClass {
57 GObjectClass parent_class;
59 void (* account_removed) (ModestAccountMgr *obj,
61 gboolean server_account,
63 void (* account_changed) (ModestAccountMgr *obj,
66 gboolean server_account,
68 void (* account_busy_changed) (ModestAccountMgr *obj,
76 * modest_account_mgr_get_type:
78 * get the GType for ModestAccountMgr
82 GType modest_account_mgr_get_type (void) G_GNUC_CONST;
86 * modest_account_mgr_new:
87 * @modest_conf: a ModestConf instance
89 * Returns: a new ModestAccountMgr, or NULL in case of error
91 ModestAccountMgr* modest_account_mgr_new (ModestConf *modest_conf);
96 * modest_account_mgr_add_account:
97 * @self: a ModestAccountMgr instance
98 * @name: name (id) of the account, which is a valid UTF8 string that does not contain '/'
99 * @store_name: the store account (ie. POP/IMAP)
100 * @transport_name: the transport account (ie. sendmail/SMTP)
101 * @enabled: Whether the account should be enabled initially.
103 * Create a new account. The account with @name should not already exist. The @name will
104 * be used as the initial display name of the new account.
106 * Returns: TRUE if the creation succeeded, FALSE otherwise,
108 gboolean modest_account_mgr_add_account (ModestAccountMgr *self,
110 const gchar* store_name,
111 const gchar* transport_name,
115 * modest_account_mgr_add_server_account:
116 * @self: a ModestAccountMgr instance
117 * @name: name (id) of the account, which is a valid UTF8 string that does not contain '/'
118 * @hostname: the hostname
119 * @portnumber: the portnumber, or 0 for default
120 * @username: the username
121 * @password: the password
122 * @proto: the protocol (imap, smtp, ...) used for this account
123 * @security: the security options, (SSL, TLS ...) used to access the server
124 * @auth: the authentication method (password, none ...) used to access the server
126 * add a server account to the configuration.
127 * the server account with @name should not already exist
129 * Returns: TRUE if succeeded, FALSE otherwise,
131 gboolean modest_account_mgr_add_server_account (ModestAccountMgr *self,
133 const gchar *hostname,
134 const guint portnumber,
135 const gchar *username,
136 const gchar *password,
137 ModestTransportStoreProtocol proto,
138 ModestConnectionProtocol security,
139 ModestAuthProtocol auth);
143 * modest_account_mgr_add_server_account_uri:
144 * @self: a ModestAccountMgr instance
145 * @name: name (id) of the account, which is a valid UTF8 string that does not contain '/'
146 * @proto: the protocol (imap, smtp, ...) used for this account
149 * add a server account to the configuration, based on the account-URI
151 * Returns: TRUE if succeeded, FALSE otherwise,
153 gboolean modest_account_mgr_add_server_account_uri (ModestAccountMgr *self,
155 ModestTransportStoreProtocol proto,
159 * modest_account_mgr_remove_account:
160 * @self: a ModestAccountMgr instance
161 * @name: the name of the account to remove
162 * @server_account: TRUE if the account to remove is a server account
163 * @err: a #GError ptr, or NULL to ignore.
165 * remove an existing account. the account with @name should already exist; note
166 * that when deleting an account, also the corresponding server accounts will
169 * Returns: TRUE if the creation succeeded, FALSE otherwise,
170 * @err gives details in case of error
172 gboolean modest_account_mgr_remove_account (ModestAccountMgr *self,
174 gboolean server_account);
178 * modest_account_mgr_account_names:
179 * @self: a ModestAccountMgr instance
180 * @only_enabled: Whether only enabled accounts should be returned.
182 * list all account names
184 * Returns: a newly allocated list of account names, or NULL in case of error or
185 * if there are no accounts. The caller must free the returned GSList.
187 * TODO: I believe that the caller must free the strings in the GSList items too,
188 * because this is implemented via gconf_client_all_dirs() which also requires a deep free,
189 * though that's not documented. murrayc.
191 GSList* modest_account_mgr_account_names (ModestAccountMgr *self,
192 gboolean only_enabled);
197 * modest_account_mgr_search_server_account:
198 * @self: a ModestAccountMgr instance
199 * @account_name: get only server accounts for @account_name, or NULL for any
200 * @type: get only server accounts from protocol type @type, or MODEST_PROTOCOL_TYPE_UNKNOWN
201 * @proto: get only server account with protocol @proto, or MODEST_PROTOCOL_TRANSPORT_STORE_UNKNOWN for any
203 * List all the server account names, optionally narrowing the result down to one account.
205 * Returns: a newly allocated list of server account names, or NULL in case of
206 * error or if there are no server accounts. The caller must free the returned GSList
208 GSList* modest_account_mgr_search_server_accounts (ModestAccountMgr *self,
209 const gchar* account_name,
210 ModestProtocolType type,
211 ModestTransportStoreProtocol proto);
215 * modest_account_mgr_account_exists:
216 * @self: a ModestAccountMgr instance
217 * @name: the account name to check
218 * @server_account: if TRUE, this is a server account
220 * check whether account @name exists. Note that this does not check the display name.
222 * Returns: TRUE if the account with name @name exists, FALSE otherwise (or in case of error)
224 gboolean modest_account_mgr_account_exists (ModestAccountMgr *self,
226 gboolean server_account);
229 * modest_account_mgr_account_exists:
230 * @self: a ModestAccountMgr instance
231 * @name: the account name to check
233 * check whether a non-server account with the @display_name exists.
235 * Returns: TRUE if the account with name @name exists, FALSE otherwise (or in case of error)
237 gboolean modest_account_mgr_account_with_display_name_exists (ModestAccountMgr *self,
238 const gchar *display_name);
242 * modest_account_mgr_get_string:
243 * @self: self a ModestAccountMgr instance
244 * @name: the name of the account
245 * @key: the key of the value to retrieve
246 * @server_account: if TRUE, this is a server account
248 * get a config string from an account
250 * Returns: a newly allocated string with the value for the key,
251 * or NULL in case of error.
253 gchar* modest_account_mgr_get_string (ModestAccountMgr *self,
256 gboolean server_account);
260 * modest_account_mgr_get_password:
261 * @self: self a ModestAccountMgr instance
262 * @name: the name of the account
263 * @key: the key of the value to retrieve
264 * @server_account: if TRUE, this is a server account
266 * get a password from an account
268 * Returns: a newly allocated string with the value for the key,
269 * or NULL in case of error.
271 gchar* modest_account_mgr_get_password (ModestAccountMgr *self,
274 gboolean server_account);
277 * modest_account_mgr_get_int:
278 * @self: a ModestAccountMgr instance
279 * @name: the name of the account
280 * @key: the key of the value to retrieve
281 * @server_account: if TRUE, this is a server account
283 * get a config int from an account
285 * Returns: an integer with the value for the key, or -1 in case of
286 * error (but of course -1 does not necessarily imply an error)
288 gint modest_account_mgr_get_int (ModestAccountMgr *self,
291 gboolean server_account);
294 * modest_account_mgr_get_bool:
295 * @self: a ModestAccountMgr instance
296 * @name: the name of the account
297 * @key: the key of the value to retrieve
298 * @server_account: if TRUE, this is a server account
300 * get a config boolean from an account
302 * Returns: an boolean with the value for the key, or FALSE in case of
303 * error (but of course FALSE does not necessarily imply an error)
305 gboolean modest_account_mgr_get_bool (ModestAccountMgr *self,
308 gboolean server_account);
311 * modest_account_mgr_get_list:
312 * @self: a ModestAccountMgr instance
313 * @name: the name of the account
314 * @key: the key of the value to get
315 * @list_type: the type of the members of the list
316 * @server_account: if TRUE, this is a server account
318 * get a config list of values of type @list_type of an account
320 * Returns: a newly allocated list of elements
322 GSList* modest_account_mgr_get_list (ModestAccountMgr *self,
325 ModestConfValueType list_type,
326 gboolean server_account);
329 * modest_account_mgr_set_string:
330 * @self: a ModestAccountMgr instance
331 * @name: the name of the account
332 * @key: the key of the value to set
333 * @val: the value to set
334 * @server_account: if TRUE, this is a server account
336 * set a config string for an account.
338 * Returns: TRUE if setting the value succeeded, or FALSE in case of error.
340 gboolean modest_account_mgr_set_string (ModestAccountMgr *self,
342 const gchar *key, const gchar* val,
343 gboolean server_account);
347 * modest_account_mgr_set_password:
348 * @self: a ModestAccountMgr instance
349 * @name: the name of the account
350 * @key: the key of the value to set
351 * @val: the value to set
352 * @server_account: if TRUE, this is a server account
354 * set a password for an account.
356 * Returns: TRUE if setting the value succeeded, or FALSE in case of error.
357 * @err gives details in case of error
359 gboolean modest_account_mgr_set_password (ModestAccountMgr *self,
361 const gchar *key, const gchar* val,
362 gboolean server_account);
365 * modest_account_mgr_set_int:
366 * @self: a ModestAccountMgr instance
367 * @name: the name of the account
368 * @key: the key of the value to set
369 * @val: the value to set
370 * @server_account: if TRUE, this is a server account
372 * set a config int for an account
374 * Returns: TRUE if setting the value succeeded, or FALSE in case of error.
376 gboolean modest_account_mgr_set_int (ModestAccountMgr *self,
378 const gchar *key, gint val,
379 gboolean server_account);
382 * modest_account_mgr_set_bool:
383 * @self: a ModestAccountMgr instance
384 * @name: the name of the account
385 * @key: the key of the value to set
386 * @val: the value to set
387 * @server_account: if TRUE, this is a server account
389 * set a config bool for an account
391 * Returns: TRUE if setting the value succeeded, or FALSE in case of error.
393 gboolean modest_account_mgr_set_bool (ModestAccountMgr *self,
395 const gchar *key, gboolean val,
396 gboolean server_account);
399 * modest_account_mgr_set_list:
400 * @self: a ModestAccountMgr instance
401 * @name: the name of the account
402 * @key: the key of the value to set
403 * @val: the list with the values to set
404 * @list_type: the type of the members of the list
405 * @server_account: if TRUE, this is a server account
407 * * set a config list of values of type @list_type of an account
409 * returns TRUE if this succeeded, FALSE otherwise
411 gboolean modest_account_mgr_set_list (ModestAccountMgr *self,
415 ModestConfValueType list_type,
416 gboolean server_account);
419 * modest_account_mgr_unset:
420 * @self: a ModestAccountMgr instance
421 * @name: the name of the account
422 * @key: the key of the value to unset
423 * @server_account: if TRUE, this is a server account
424 * @err: a GError ptr, or NULL to ignore.
426 * unsets the config value of an account and all their children keys
428 * Returns: TRUE if unsetting the value succeeded, or FALSE in case of error.
429 * @err gives details in case of error
431 gboolean modest_account_mgr_unset (ModestAccountMgr *self,
434 gboolean server_account);
437 * modest_account_mgr_has_accounts:
438 * @self: a ModestAccountMgr instance
439 * @enabled: TRUE to search for enabled accounts only
441 * Checks if any accounts exist
443 * Returns: TRUE if accounts exist, FALSE otherwise
446 gboolean modest_account_mgr_has_accounts (ModestAccountMgr* self, gboolean enabled);
449 * modest_account_mgr_set_account_busy
450 * @self: a ModestAccountMgr instance
451 * @account_name: name of the account
452 * @busy: whether to set busy or not busy
454 * Changes the busy flag of an account
458 void modest_account_mgr_set_account_busy(ModestAccountMgr* self, const gchar* account_name,
462 * modest_account_mgr_account_is_busy
463 * @self: a ModestAccountMgr instance
464 * @account_name: name of the account
466 * Returns: If the account is currently busy or not
470 modest_account_mgr_account_is_busy(ModestAccountMgr* self, const gchar* account_name);
475 #endif /* __MODEST_ACCOUNT_MGR_H__ */