X-Git-Url: http://git.maemo.org/git/?p=modest;a=blobdiff_plain;f=src%2Fmodest-account-mgr.h;h=6e6bff4b87c25e63a46c0aeb689b234e055bc74f;hp=912bbb84dc1f6de65fa7dcb733a7101a11e2e944;hb=fd44d68efc59bf8d3f70e70bb1df7e6885228188;hpb=702b748360f6de61e0780c36a98065d19a495c83 diff --git a/src/modest-account-mgr.h b/src/modest-account-mgr.h index 912bbb8..6e6bff4 100644 --- a/src/modest-account-mgr.h +++ b/src/modest-account-mgr.h @@ -28,22 +28,20 @@ */ -/* modest-account-mgr.h */ - #ifndef __MODEST_ACCOUNT_MGR_H__ #define __MODEST_ACCOUNT_MGR_H__ #include -#include "modest-conf.h" -#include "modest-account-keys.h" -#include "modest-proto.h" +#include +#include +#include G_BEGIN_DECLS /* convenience macros */ #define MODEST_TYPE_ACCOUNT_MGR (modest_account_mgr_get_type()) #define MODEST_ACCOUNT_MGR(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_ACCOUNT_MGR,ModestAccountMgr)) -#define MODEST_ACCOUNT_MGR_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_ACCOUNT_MGR,GObject)) +#define MODEST_ACCOUNT_MGR_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_ACCOUNT_MGR,ModestAccountMgrClass)) #define MODEST_IS_ACCOUNT_MGR(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_ACCOUNT_MGR)) #define MODEST_IS_ACCOUNT_MGR_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_ACCOUNT_MGR)) #define MODEST_ACCOUNT_MGR_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_ACCOUNT_MGR,ModestAccountMgrClass)) @@ -52,21 +50,22 @@ typedef struct _ModestAccountMgr ModestAccountMgr; typedef struct _ModestAccountMgrClass ModestAccountMgrClass; - struct _ModestAccountMgr { GObject parent; - /* insert public members, if any */ }; struct _ModestAccountMgrClass { GObjectClass parent_class; - /* insert signal callback declarations, eg. */ - /* void (* my_event) (ModestAccountMgr* obj); */ -}; + void (* account_removed) (ModestAccountMgr *obj, const gchar* account, + gboolean server_account, gpointer user_data); + void (* account_changed) (ModestAccountMgr *obj, const gchar* account, + const gchar* key, gboolean server_account, + gpointer user_data); +}; /** - * modest_ui_get_type: + * modest_account_mgr_get_type: * * get the GType for ModestAccountMgr * @@ -81,14 +80,14 @@ GType modest_account_mgr_get_type (void) G_GNUC_CONST; * * Returns: a new ModestAccountMgr, or NULL in case of error */ -GObject* modest_account_mgr_new (ModestConf *modest_conf); +ModestAccountMgr* modest_account_mgr_new (ModestConf *modest_conf); /** * modest_account_mgr_add_account: * @self: a ModestAccountMgr instance - * @name: the name of the account to create + * @name: name (id) of the account, which is a valid UTF8 string that does not contain '/' * @store_name: the store account (ie. POP/IMAP) * @transport_name: the transport account (ie. sendmail/SMTP) * @err: a GError ptr, or NULL to ignore. @@ -101,32 +100,18 @@ GObject* modest_account_mgr_new (ModestConf *modest_conf); gboolean modest_account_mgr_add_account (ModestAccountMgr *self, const gchar* name, const gchar* store_name, - const gchar* transport_name, - GError **err); -/** - * modest_account_mgr_remove_account: - * @self: a ModestAccountMgr instance - * @name: the name of the account to remove - * @err: a GError ptr, or NULL to ignore. - * - * remove an existing account. the account with @name should already exist - * - * Returns: TRUE if the creation succeeded, FALSE otherwise, - * @err gives details in case of error - */ -gboolean modest_account_mgr_remove_account (ModestAccountMgr *self, - const gchar* name, - GError **err); - + const gchar* transport_name); /** * modest_account_mgr_add_server_account: * @self: a ModestAccountMgr instance - * @name: name (id) of the account + * @name: name (id) of the account, which is a valid UTF8 string that does not contain '/' * @hostname: the hostname * @username: the username * @password: the password * @proto: the protocol (imap, smtp, ...) used for this account + * @security: the security options, (SSL, TLS ...) used to access the server + * @auth: the authentication method (password, none ...) used to access the server * * add a server account to the configuration. * the server account with @name should not already exist @@ -138,36 +123,54 @@ gboolean modest_account_mgr_add_server_account (ModestAccountMgr *self, const gchar *hostname, const gchar *username, const gchar *password, - const gchar *proto); + ModestProtocol proto, + ModestProtocol security, + ModestProtocol auth); + /** - * modest_account_mgr_remove_server_account: + * modest_account_mgr_add_server_account_uri: * @self: a ModestAccountMgr instance - * @name: the name for the server account to remove - * @err: a GError ptr, or NULL to ignore. + * @name: name (id) of the account, which is a valid UTF8 string that does not contain '/' + * @proto: the protocol (imap, smtp, ...) used for this account + * @uri: the URI + * + * add a server account to the configuration, based on the account-URI + * + * Returns: TRUE if succeeded, FALSE otherwise, + */ +gboolean modest_account_mgr_add_server_account_uri (ModestAccountMgr *self, + const gchar *name, + ModestProtocol proto, + const gchar* uri); + +/** + * modest_account_mgr_remove_account: + * @self: a ModestAccountMgr instance + * @name: the name of the account to remove + * @server_account: TRUE if the account to remove is a server account + * @err: a #GError ptr, or NULL to ignore. * - * remove a server account from the configuration - * the server account with @name should exist + * remove an existing account. the account with @name should already exist * - * Returns: TRUE if the removal succeeded, FALSE otherwise, + * Returns: TRUE if the creation succeeded, FALSE otherwise, * @err gives details in case of error */ -gboolean modest_account_mgr_remove_server_account (ModestAccountMgr *self, - const gchar *name, - GError **err); +gboolean modest_account_mgr_remove_account (ModestAccountMgr *self, + const gchar* name, + gboolean server_account); + /** * modest_account_mgr_account_names: * @self: a ModestAccountMgr instance - * @err: a GError ptr, or NULL to ignore. * * list all account names * * Returns: a newly allocated list of account names, or NULL in case of error or * if there are no accounts. The caller must free the returned GSList - * @err gives details in case of error */ -GSList* modest_account_mgr_account_names (ModestAccountMgr *self, GError **err); +GSList* modest_account_mgr_account_names (ModestAccountMgr *self); /** @@ -183,169 +186,220 @@ GSList* modest_account_mgr_account_names (ModestAccountMgr *self, GEr * Returns: a newly allocated list of server account names, or NULL in case of * error or if there are no server accounts. The caller must free the returned GSList */ -GSList* modest_account_mgr_server_account_names (ModestAccountMgr *self, - const gchar* account_name, - ModestProtoType type, - const gchar* proto, - gboolean only_enabled); +GSList* modest_account_mgr_search_server_accounts (ModestAccountMgr *self, + const gchar* account_name, + ModestProtocolType type, + ModestProtocol proto); /** * modest_account_mgr_account_exists: * @self: a ModestAccountMgr instance * @name: the account name to check - * @err: a GError ptr, or NULL to ignore. + * @server_account: if TRUE, this is a server account * * check whether account @name exists * * Returns: TRUE if the account with name @name exists, FALSE otherwise (or in case of error) - * @err gives details in case of error */ gboolean modest_account_mgr_account_exists (ModestAccountMgr *self, const gchar *name, - GError **err); - -gboolean modest_account_mgr_server_account_exists (ModestAccountMgr *self, - const gchar *name, - GError **err); + gboolean server_account); - -/* account specific functions */ - /** - * modest_account_mgr_get_account_string: + * modest_account_mgr_get_string: * @self: self a ModestAccountMgr instance * @name: the name of the account * @key: the key of the value to retrieve - * @err: a GError ptr, or NULL to ignore. + * @server_account: if TRUE, this is a server account * * get a config string from an account * * Returns: a newly allocated string with the value for the key, - * or NULL in case of error. @err gives details in case of error + * or NULL in case of error. */ -gchar* modest_account_mgr_get_account_string (ModestAccountMgr *self, - const gchar *name, - const gchar *key, GError **err); +gchar* modest_account_mgr_get_string (ModestAccountMgr *self, + const gchar *name, + const gchar *key, + gboolean server_account); -gchar* modest_account_mgr_get_server_account_string (ModestAccountMgr *self, - const gchar *name, - const gchar *key, GError **err); /** - * modest_account_mgr_get_account_int: + * modest_account_mgr_get_password: + * @self: self a ModestAccountMgr instance + * @name: the name of the account + * @key: the key of the value to retrieve + * @server_account: if TRUE, this is a server account + * + * get a password from an account + * + * Returns: a newly allocated string with the value for the key, + * or NULL in case of error. + */ +gchar* modest_account_mgr_get_password (ModestAccountMgr *self, + const gchar *name, + const gchar *key, + gboolean server_account); + +/** + * modest_account_mgr_get_int: * @self: a ModestAccountMgr instance * @name: the name of the account * @key: the key of the value to retrieve - * @err: a GError ptr, or NULL to ignore. + * @server_account: if TRUE, this is a server account * * get a config int from an account * * Returns: an integer with the value for the key, or -1 in case of * error (but of course -1 does not necessarily imply an error) - * @err gives details in case of error */ -gint modest_account_mgr_get_account_int (ModestAccountMgr *self, - const gchar *name, - const gchar *key, GError **err); - -gint modest_account_mgr_get_server_account_int (ModestAccountMgr *self, - const gchar *name, - const gchar *key, GError **err); - +gint modest_account_mgr_get_int (ModestAccountMgr *self, + const gchar *name, + const gchar *key, + gboolean server_account); /** - * modest_account_mgr_get_account_bool: + * modest_account_mgr_get_bool: * @self: a ModestAccountMgr instance * @name: the name of the account * @key: the key of the value to retrieve - * @err: a GError ptr, or NULL to ignore. + * @server_account: if TRUE, this is a server account * * get a config boolean from an account * * Returns: an boolean with the value for the key, or FALSE in case of * error (but of course FALSE does not necessarily imply an error) - * @err gives details in case of error */ -gboolean modest_account_mgr_get_account_bool (ModestAccountMgr *self, - const gchar *name, - const gchar *key, GError **err); +gboolean modest_account_mgr_get_bool (ModestAccountMgr *self, + const gchar *name, + const gchar *key, + gboolean server_account); -gboolean modest_account_mgr_get_server_account_bool (ModestAccountMgr *self, - const gchar *name, - const gchar *key, GError **err); +/** + * modest_account_mgr_get_list: + * @self: a ModestAccountMgr instance + * @name: the name of the account + * @key: the key of the value to get + * @list_type: the type of the members of the list + * @server_account: if TRUE, this is a server account + * + * get a config list of values of type @list_type of an account + * + * Returns: a newly allocated list of elements + */ +GSList* modest_account_mgr_get_list (ModestAccountMgr *self, + const gchar *name, + const gchar *key, + ModestConfValueType list_type, + gboolean server_account); /** - * modest_account_mgr_set_account_string: + * modest_account_mgr_set_string: * @self: a ModestAccountMgr instance * @name: the name of the account * @key: the key of the value to set * @val: the value to set - * @err: a GError ptr, or NULL to ignore. + * @server_account: if TRUE, this is a server account * - * set a config string for an account + * set a config string for an account. * * Returns: TRUE if setting the value succeeded, or FALSE in case of error. - * @err gives details in case of error */ -gboolean modest_account_mgr_set_account_string (ModestAccountMgr *self, - const gchar *name, - const gchar *key, const gchar* val, - GError **err); +gboolean modest_account_mgr_set_string (ModestAccountMgr *self, + const gchar *name, + const gchar *key, const gchar* val, + gboolean server_account); -gboolean modest_account_mgr_set_server_account_string (ModestAccountMgr *self, - const gchar *name, - const gchar *key, const gchar* val, - GError **err); +/** + * modest_account_mgr_set_password: + * @self: a ModestAccountMgr instance + * @name: the name of the account + * @key: the key of the value to set + * @val: the value to set + * @server_account: if TRUE, this is a server account + * + * set a password for an account. + * + * Returns: TRUE if setting the value succeeded, or FALSE in case of error. +* @err gives details in case of error + */ +gboolean modest_account_mgr_set_password (ModestAccountMgr *self, + const gchar *name, + const gchar *key, const gchar* val, + gboolean server_account); /** - * modest_account_mgr_set_account_int: + * modest_account_mgr_set_int: * @self: a ModestAccountMgr instance * @name: the name of the account * @key: the key of the value to set * @val: the value to set - * @err: a GError ptr, or NULL to ignore. + * @server_account: if TRUE, this is a server account * * set a config int for an account * * Returns: TRUE if setting the value succeeded, or FALSE in case of error. - * @err gives details in case of error */ -gboolean modest_account_mgr_set_account_int (ModestAccountMgr *self, - const gchar *name, - const gchar *key, gint val, - GError **err); - -gboolean modest_account_mgr_set_server_account_int (ModestAccountMgr *self, - const gchar *name, - const gchar *key, gint val, - GError **err); - +gboolean modest_account_mgr_set_int (ModestAccountMgr *self, + const gchar *name, + const gchar *key, gint val, + gboolean server_account); /** - * modest_account_mgr_set_account_bool: + * modest_account_mgr_set_bool: * @self: a ModestAccountMgr instance * @name: the name of the account * @key: the key of the value to set * @val: the value to set - * @err: a GError ptr, or NULL to ignore. + * @server_account: if TRUE, this is a server account * * set a config bool for an account * * Returns: TRUE if setting the value succeeded, or FALSE in case of error. - * @err gives details in case of error */ -gboolean modest_account_mgr_set_account_bool (ModestAccountMgr *self, - const gchar *name, - const gchar *key, gboolean val, - GError **err); +gboolean modest_account_mgr_set_bool (ModestAccountMgr *self, + const gchar *name, + const gchar *key, gboolean val, + gboolean server_account); -gboolean modest_account_mgr_set_server_account_bool (ModestAccountMgr *self, - const gchar *name, - const gchar *key, gboolean val, - GError **err); +/** + * modest_account_mgr_set_list: + * @self: a ModestAccountMgr instance + * @name: the name of the account + * @key: the key of the value to set + * @val: the list with the values to set + * @list_type: the type of the members of the list + * @server_account: if TRUE, this is a server account + * + * * set a config list of values of type @list_type of an account + * + * returns TRUE if this succeeded, FALSE otherwise + */ +gboolean modest_account_mgr_set_list (ModestAccountMgr *self, + const gchar *name, + const gchar *key, + GSList *val, + ModestConfValueType list_type, + gboolean server_account); +/** + * modest_account_mgr_unset: + * @self: a ModestAccountMgr instance + * @name: the name of the account + * @key: the key of the value to unset + * @server_account: if TRUE, this is a server account + * @err: a GError ptr, or NULL to ignore. + * + * unsets the config value of an account and all their children keys + * + * Returns: TRUE if unsetting the value succeeded, or FALSE in case of error. + * @err gives details in case of error + */ +gboolean modest_account_mgr_unset (ModestAccountMgr *self, + const gchar *name, + const gchar *key, + gboolean server_account); G_END_DECLS