X-Git-Url: http://git.maemo.org/git/?p=modest;a=blobdiff_plain;f=src%2Fmodest-account-mgr.h;h=aaf5c06dbecf0272f6fd458f98c9f6c7bc051ff9;hp=a7385ac139d57231bd3cb6b5b60fed0ab37fdd85;hb=6ebc23126acdfb8aec11416e4c197c6bee70bef0;hpb=c0d1c43e9e48abc7d867cabcd57ccc9a6917a41b diff --git a/src/modest-account-mgr.h b/src/modest-account-mgr.h index a7385ac..aaf5c06 100644 --- a/src/modest-account-mgr.h +++ b/src/modest-account-mgr.h @@ -49,7 +49,6 @@ G_BEGIN_DECLS typedef struct _ModestAccountMgr ModestAccountMgr; typedef struct _ModestAccountMgrClass ModestAccountMgrClass; - struct _ModestAccountMgr { GObject parent; }; @@ -57,11 +56,20 @@ struct _ModestAccountMgr { struct _ModestAccountMgrClass { GObjectClass parent_class; - 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, + void (* account_removed) (ModestAccountMgr *obj, + const gchar* account, + gboolean server_account, + gpointer user_data); + void (* account_changed) (ModestAccountMgr *obj, + const gchar* account, + const GSList* key, + gboolean server_account, + gpointer user_data); + void (* account_busy_changed) (ModestAccountMgr *obj, + const gchar* account, + gboolean busy, gpointer user_data); + }; /** @@ -90,26 +98,30 @@ ModestAccountMgr* modest_account_mgr_new (ModestConf *modest_c * @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. + * @enabled: Whether the account should be enabled initially. * - * create a new account. the account with @name should not already exist + * Create a new account. The account with @name should not already exist. The @name will + * be used as the initial display name of the new account. * * Returns: TRUE if the creation succeeded, FALSE otherwise, - * @err gives details in case of error */ gboolean modest_account_mgr_add_account (ModestAccountMgr *self, const gchar* name, const gchar* store_name, - const gchar* transport_name); + const gchar* transport_name, + gboolean enabled); /** * modest_account_mgr_add_server_account: * @self: a ModestAccountMgr instance * @name: name (id) of the account, which is a valid UTF8 string that does not contain '/' * @hostname: the hostname + * @portnumber: the portnumber, or 0 for default * @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 @@ -119,9 +131,12 @@ gboolean modest_account_mgr_add_account (ModestAccountMgr *self, gboolean modest_account_mgr_add_server_account (ModestAccountMgr *self, const gchar *name, const gchar *hostname, + const guint portnumber, const gchar *username, const gchar *password, - ModestProtocol proto); + ModestTransportStoreProtocol proto, + ModestConnectionProtocol security, + ModestAuthProtocol auth); /** @@ -137,7 +152,7 @@ gboolean modest_account_mgr_add_server_account (ModestAccountMgr *self, */ gboolean modest_account_mgr_add_server_account_uri (ModestAccountMgr *self, const gchar *name, - ModestProtocol proto, + ModestTransportStoreProtocol proto, const gchar* uri); /** @@ -147,7 +162,9 @@ gboolean modest_account_mgr_add_server_account_uri (ModestAccountMgr *self, * @server_account: TRUE if the account to remove is a server account * @err: a #GError ptr, or NULL to ignore. * - * remove an existing account. the account with @name should already exist + * remove an existing account. the account with @name should already exist; note + * that when deleting an account, also the corresponding server accounts will + * be deleted * * Returns: TRUE if the creation succeeded, FALSE otherwise, * @err gives details in case of error @@ -160,24 +177,30 @@ gboolean modest_account_mgr_remove_account (ModestAccountMgr *sel /** * modest_account_mgr_account_names: * @self: a ModestAccountMgr instance + * @only_enabled: Whether only enabled accounts should be returned. * * 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 + * if there are no accounts. The caller must free the returned GSList. + * + * TODO: I believe that the caller must free the strings in the GSList items too, + * because this is implemented via gconf_client_all_dirs() which also requires a deep free, + * though that's not documented. murrayc. */ -GSList* modest_account_mgr_account_names (ModestAccountMgr *self); - +GSList* modest_account_mgr_account_names (ModestAccountMgr *self, + gboolean only_enabled); +#if 0 +/* Not used. */ /** - * modest_account_mgr_server_account_names: + * modest_account_mgr_search_server_account: * @self: a ModestAccountMgr instance * @account_name: get only server accounts for @account_name, or NULL for any - * @type: get only server accounts from protocol type @type, or MODEST_PROTO_TYPE_ANY - * @proto: get only server account with protocol @proto, or NULL for any - * @only_enabled: get only enabled server accounts if TRUE + * @type: get only server accounts from protocol type @type, or MODEST_PROTOCOL_TYPE_UNKNOWN + * @proto: get only server account with protocol @proto, or MODEST_PROTOCOL_TRANSPORT_STORE_UNKNOWN for any * - * list all the server account names + * List all the server account names, optionally narrowing the result down to one account. * * 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 @@ -185,7 +208,8 @@ GSList* modest_account_mgr_account_names (ModestAccountMgr *self); GSList* modest_account_mgr_search_server_accounts (ModestAccountMgr *self, const gchar* account_name, ModestProtocolType type, - ModestProtocol proto); + ModestTransportStoreProtocol proto); +#endif /** * modest_account_mgr_account_exists: @@ -193,7 +217,7 @@ GSList* modest_account_mgr_search_server_accounts (ModestAccountMgr *self, * @name: the account name to check * @server_account: if TRUE, this is a server account * - * check whether account @name exists + * check whether account @name exists. Note that this does not check the display name. * * Returns: TRUE if the account with name @name exists, FALSE otherwise (or in case of error) */ @@ -201,6 +225,18 @@ gboolean modest_account_mgr_account_exists (ModestAccountMgr *self, const gchar *name, gboolean server_account); +/** + * modest_account_mgr_account_exists: + * @self: a ModestAccountMgr instance + * @name: the account name to check + * + * check whether a non-server account with the @display_name exists. + * + * Returns: TRUE if the account with name @name exists, FALSE otherwise (or in case of error) + */ +gboolean modest_account_mgr_account_with_display_name_exists (ModestAccountMgr *self, + const gchar *display_name); + /** * modest_account_mgr_get_string: @@ -397,6 +433,43 @@ gboolean modest_account_mgr_unset (ModestAccountMgr *self, const gchar *key, gboolean server_account); +/** + * modest_account_mgr_has_accounts: + * @self: a ModestAccountMgr instance + * @enabled: TRUE to search for enabled accounts only + * + * Checks if any accounts exist + * + * Returns: TRUE if accounts exist, FALSE otherwise + */ + +gboolean modest_account_mgr_has_accounts (ModestAccountMgr* self, gboolean enabled); + +/** + * modest_account_mgr_set_account_busy + * @self: a ModestAccountMgr instance + * @account_name: name of the account + * @busy: whether to set busy or not busy + * + * Changes the busy flag of an account + * + */ + +void modest_account_mgr_set_account_busy(ModestAccountMgr* self, const gchar* account_name, + gboolean busy); + +/** + * modest_account_mgr_account_is_busy + * @self: a ModestAccountMgr instance + * @account_name: name of the account + * + * Returns: If the account is currently busy or not + * + */ +gboolean +modest_account_mgr_account_is_busy(ModestAccountMgr* self, const gchar* account_name); + + G_END_DECLS #endif /* __MODEST_ACCOUNT_MGR_H__ */