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,
63 void (* account_changed) (ModestAccountMgr *obj,
66 gboolean server_account,
69 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 * @err: a #GError ptr, or NULL to ignore.
164 * remove an existing account. the account with @name should already exist; note
165 * that when deleting an account, also the corresponding server accounts will
168 * Returns: TRUE if the creation succeeded, FALSE otherwise,
169 * @err gives details in case of error
171 gboolean modest_account_mgr_remove_account (ModestAccountMgr *self,
175 * modest_account_mgr_account_names:
176 * @self: a ModestAccountMgr instance
177 * @only_enabled: Whether only enabled accounts should be returned.
179 * list all account names
181 * Returns: a newly allocated list of account names, or NULL in case of error or
182 * if there are no accounts. The caller must free the returned GSList.
185 GSList* modest_account_mgr_account_names (ModestAccountMgr *self,
186 gboolean only_enabled);
189 * modest_account_mgr_free_account_names:
190 * @account_name: a gslist of account names
192 * list all account names
194 * free the list of account names
196 void modest_account_mgr_free_account_names (GSList *account_names);
200 * modest_account_mgr_account_exists:
201 * @self: a ModestAccountMgr instance
202 * @name: the account name to check
203 * @server_account: if TRUE, this is a server account
205 * check whether account @name exists. Note that this does not check the display name.
207 * Returns: TRUE if the account with name @name exists, FALSE otherwise (or in case of error)
209 gboolean modest_account_mgr_account_exists (ModestAccountMgr *self,
211 gboolean server_account);
214 * modest_account_mgr_account_exists:
215 * @self: a ModestAccountMgr instance
216 * @name: the account name to check
218 * check whether a non-server account with the @display_name exists.
220 * Returns: TRUE if the account with name @name exists, FALSE otherwise (or in case of error)
222 gboolean modest_account_mgr_account_with_display_name_exists (ModestAccountMgr *self,
223 const gchar *display_name);
227 * modest_account_mgr_get_string:
228 * @self: self a ModestAccountMgr instance
229 * @name: the name of the account
230 * @key: the key of the value to retrieve
231 * @server_account: if TRUE, this is a server account
233 * get a config string from an account
235 * Returns: a newly allocated string with the value for the key,
236 * or NULL in case of error.
238 gchar* modest_account_mgr_get_string (ModestAccountMgr *self,
241 gboolean server_account);
245 * modest_account_mgr_get_password:
246 * @self: self a ModestAccountMgr instance
247 * @name: the name of the account
248 * @key: the key of the value to retrieve
249 * @server_account: if TRUE, this is a server account
251 * get a password from an account
253 * Returns: a newly allocated string with the value for the key,
254 * or NULL in case of error.
256 gchar* modest_account_mgr_get_password (ModestAccountMgr *self,
259 gboolean server_account);
262 * modest_account_mgr_get_int:
263 * @self: a ModestAccountMgr instance
264 * @name: the name of the account
265 * @key: the key of the value to retrieve
266 * @server_account: if TRUE, this is a server account
268 * get a config int from an account
270 * Returns: an integer with the value for the key, or -1 in case of
271 * error (but of course -1 does not necessarily imply an error)
273 gint modest_account_mgr_get_int (ModestAccountMgr *self,
276 gboolean server_account);
279 * modest_account_mgr_get_bool:
280 * @self: a ModestAccountMgr instance
281 * @name: the name of the account
282 * @key: the key of the value to retrieve
283 * @server_account: if TRUE, this is a server account
285 * get a config boolean from an account
287 * Returns: an boolean with the value for the key, or FALSE in case of
288 * error (but of course FALSE does not necessarily imply an error)
290 gboolean modest_account_mgr_get_bool (ModestAccountMgr *self,
293 gboolean server_account);
296 * modest_account_mgr_get_list:
297 * @self: a ModestAccountMgr instance
298 * @name: the name of the account
299 * @key: the key of the value to get
300 * @list_type: the type of the members of the list
301 * @server_account: if TRUE, this is a server account
303 * get a config list of values of type @list_type of an account
305 * Returns: a newly allocated list of elements
307 GSList* modest_account_mgr_get_list (ModestAccountMgr *self,
310 ModestConfValueType list_type,
311 gboolean server_account);
314 * modest_account_mgr_set_string:
315 * @self: a ModestAccountMgr instance
316 * @name: the name of the account
317 * @key: the key of the value to set
318 * @val: the value to set
319 * @server_account: if TRUE, this is a server account
321 * set a config string for an account.
323 * Returns: TRUE if setting the value succeeded, or FALSE in case of error.
325 gboolean modest_account_mgr_set_string (ModestAccountMgr *self,
327 const gchar *key, const gchar* val,
328 gboolean server_account);
332 * modest_account_mgr_set_password:
333 * @self: a ModestAccountMgr instance
334 * @name: the name of the account
335 * @key: the key of the value to set
336 * @val: the value to set
337 * @server_account: if TRUE, this is a server account
339 * set a password for an account.
341 * Returns: TRUE if setting the value succeeded, or FALSE in case of error.
342 * @err gives details in case of error
344 gboolean modest_account_mgr_set_password (ModestAccountMgr *self,
346 const gchar *key, const gchar* val,
347 gboolean server_account);
350 * modest_account_mgr_set_int:
351 * @self: a ModestAccountMgr instance
352 * @name: the name of the account
353 * @key: the key of the value to set
354 * @val: the value to set
355 * @server_account: if TRUE, this is a server account
357 * set a config int for an account
359 * Returns: TRUE if setting the value succeeded, or FALSE in case of error.
361 gboolean modest_account_mgr_set_int (ModestAccountMgr *self,
363 const gchar *key, gint val,
364 gboolean server_account);
367 * modest_account_mgr_set_bool:
368 * @self: a ModestAccountMgr instance
369 * @name: the name of the account
370 * @key: the key of the value to set
371 * @val: the value to set
372 * @server_account: if TRUE, this is a server account
374 * set a config bool for an account
376 * Returns: TRUE if setting the value succeeded, or FALSE in case of error.
378 gboolean modest_account_mgr_set_bool (ModestAccountMgr *self,
380 const gchar *key, gboolean val,
381 gboolean server_account);
384 * modest_account_mgr_set_list:
385 * @self: a ModestAccountMgr instance
386 * @name: the name of the account
387 * @key: the key of the value to set
388 * @val: the list with the values to set
389 * @list_type: the type of the members of the list
390 * @server_account: if TRUE, this is a server account
392 * * set a config list of values of type @list_type of an account
394 * returns TRUE if this succeeded, FALSE otherwise
396 gboolean modest_account_mgr_set_list (ModestAccountMgr *self,
400 ModestConfValueType list_type,
401 gboolean server_account);
404 * modest_account_mgr_unset:
405 * @self: a ModestAccountMgr instance
406 * @name: the name of the account
407 * @key: the key of the value to unset
408 * @server_account: if TRUE, this is a server account
409 * @err: a GError ptr, or NULL to ignore.
411 * unsets the config value of an account and all their children keys
413 * Returns: TRUE if unsetting the value succeeded, or FALSE in case of error.
414 * @err gives details in case of error
416 gboolean modest_account_mgr_unset (ModestAccountMgr *self,
419 gboolean server_account);
422 * modest_account_mgr_has_accounts:
423 * @self: a ModestAccountMgr instance
424 * @enabled: TRUE to search for enabled accounts only
426 * Checks if any accounts exist
428 * Returns: TRUE if accounts exist, FALSE otherwise
431 gboolean modest_account_mgr_has_accounts (ModestAccountMgr* self, gboolean enabled);
434 * modest_account_mgr_set_account_busy
435 * @self: a ModestAccountMgr instance
436 * @account_name: name of the account
437 * @busy: whether to set busy or not busy
439 * Changes the busy flag of an account
443 void modest_account_mgr_set_account_busy(ModestAccountMgr* self, const gchar* account_name,
447 * modest_account_mgr_account_is_busy
448 * @self: a ModestAccountMgr instance
449 * @account_name: name of the account
451 * Returns: If the account is currently busy or not
455 modest_account_mgr_account_is_busy(ModestAccountMgr* self, const gchar* account_name);
460 #endif /* __MODEST_ACCOUNT_MGR_H__ */