X-Git-Url: http://git.maemo.org/git/?p=modest;a=blobdiff_plain;f=src%2Fmodest-account-mgr.h;h=679c97d1c17d68c5167a5e7d5e1328a12594445f;hp=f0506351f0339292467d37dd17033ffa00391e99;hb=60e5848997afb38e747c6750f2fc0d6639adaef4;hpb=434ec10090daec7d9d80c1f419b9113d15d58fd4 diff --git a/src/modest-account-mgr.h b/src/modest-account-mgr.h index f050635..679c97d 100644 --- a/src/modest-account-mgr.h +++ b/src/modest-account-mgr.h @@ -1,20 +1,47 @@ -/* modest-account-mgr.h */ -/* insert (c)/licensing information) */ +/* Copyright (c) 2006, Nokia Corporation + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are + * met: + * + * * Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * * Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * * Neither the name of the Nokia Corporation nor the names of its + * contributors may be used to endorse or promote products derived from + * this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS + * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED + * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A + * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER + * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, + * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, + * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR + * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF + * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING + * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS + * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + #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)) @@ -22,22 +49,44 @@ G_BEGIN_DECLS 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_inserted) (ModestAccountMgr *obj, + const gchar* account, + gpointer user_data); + + void (* account_removed) (ModestAccountMgr *obj, + const gchar* account, + gpointer user_data); + + void (* account_changed) (ModestAccountMgr *obj, + const gchar* account, + gpointer user_data); + + void (* account_busy_changed) (ModestAccountMgr *obj, + const gchar* account, + gboolean busy, + gpointer user_data); + + void (* default_account_changed)(ModestAccountMgr *obj, + gpointer user_data); + + void (* display_name_changed) (ModestAccountMgr *obj, + const gchar *account, + gpointer user_data); + + void (* account_updated) (ModestAccountMgr *obj, + const gchar *account, + gpointer user_data); +}; /** - * modest_ui_get_type: + * modest_account_mgr_get_type: * * get the GType for ModestAccountMgr * @@ -52,238 +101,280 @@ 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 - * @store: the store account (ie. POP/IMAP) - * @transport: the transport account (ie. sendmail/SMTP) - * @err: a GError ptr, or NULL to ignore. + * modest_account_mgr_add_account_from_settings: + * @self: a #ModestAccountMgr instance + * @self: a #ModestSettings * - * create a new account. the account with @name should not already exist + * Create a new account from a @settings instance. * * 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, - GError **err); +gboolean modest_account_mgr_add_account_from_settings (ModestAccountMgr *self, + ModestAccountSettings *settings); + /** - * modest_account_mgr_remove_account: + * modest_account_mgr_add_account: * @self: a ModestAccountMgr instance - * @name: the name of the 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 '/' + * @store_name: the store account (ie. POP/IMAP) + * @transport_name: the transport account (ie. sendmail/SMTP) + * @enabled: Whether the account should be enabled initially. * - * remove an existing account. the account with @name should 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_remove_account (ModestAccountMgr *self, const gchar* name, - GError **err); - - +gboolean modest_account_mgr_add_account (ModestAccountMgr *self, + const gchar *name, + const gchar *display_name, + const gchar *user_fullname, + const gchar *user_email, + ModestAccountRetrieveType retrieve_type, + const gchar* store_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 prototype - * @err: a GError ptr, or NULL to ignore. + * @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 + * add a server account to the configuration. * the server account with @name should not already exist - * - * Returns: TRUE if succeeded, FALSE otherwise, - * @err gives details in case of error + * + * Returns: TRUE if succeeded, FALSE otherwise, */ gboolean modest_account_mgr_add_server_account (ModestAccountMgr *self, const gchar *name, const gchar *hostname, + const guint portnumber, const gchar *username, const gchar *password, - const gchar *proto); + ModestProtocolType proto, + ModestProtocolType security, + ModestProtocolType 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 - * @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, + ModestProtocolType proto, + const gchar* uri); + +/** + * 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 a server account from the configuration - * the server account with @name should 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 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); +/** + * modest_account_mgr_remove_account: + * @self: a ModestAccountMgr instance + * @name: the name of the server account to remove + * + * remove an existing server account. This is only for internal use. + * + * Returns: TRUE if the operation succeeded, FALSE otherwise, + */ +gboolean modest_account_mgr_remove_server_account (ModestAccountMgr *self, + const gchar* name); /** * modest_account_mgr_account_names: * @self: a ModestAccountMgr instance - * @err: a GError ptr, or NULL to ignore. + * @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 - * @err gives details in case of error + * if there are no accounts. The caller must free the returned GSList. + * */ -GSList* modest_account_mgr_account_names (ModestAccountMgr *self, GError **err); - +GSList* modest_account_mgr_account_names (ModestAccountMgr *self, + gboolean only_enabled); /** - * modest_account_mgr_server_account_names: - * @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_enable: get only enable server account if TRUE + * modest_account_mgr_free_account_names: + * @account_name: a gslist of account names * - * list all the server account names + * list all account names * - * 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 + * free the list of account names */ -GSList* modest_account_mgr_server_account_names (ModestAccountMgr *self, - const gchar* account_name, - ModestProtoType type, - const gchar* proto, - gboolean only_enabled); +void modest_account_mgr_free_account_names (GSList *account_names); + /** * modest_account_mgr_account_exists: * @self: a ModestAccountMgr instance - * @err: a GError ptr, or NULL to ignore. + * @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 exists, FALSE otherwise (or in case of error) - * @err gives details in case of error + * Returns: TRUE if the account with name @name exists, FALSE otherwise (or in case of error) */ gboolean modest_account_mgr_account_exists (ModestAccountMgr *self, const gchar *name, - GError **err); - -/* account specific functions */ + 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_check_already_configured_account: + * @self: a #ModestAccountMgr + * @settings: a #ModestAccountSettings *settings + * + * Checks if there's already an active store account with the same settings + * + * Returns: %TRUE if account setup exists + */ +gboolean modest_account_mgr_check_already_configured_account (ModestAccountMgr * self, + ModestAccountSettings *settings); /** - * modest_account_mgr_get_account_string: - * @self: self a ModestAccountMgr instance + * modest_account_mgr_unset: + * @self: a ModestAccountMgr instance * @name: the name of the account - * @key: the key of the value to retrieve + * @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. * - * get a config string from some account + * unsets the config value of an account and all their children keys * - * Returns: a newly allocated string with the value for the key, - * or NULL in case of error. @err gives details in case of error + * Returns: TRUE if unsetting the value succeeded, or FALSE in case of error. + * @err gives details in case of error */ -gchar* modest_account_mgr_get_account_string (ModestAccountMgr *self, - const gchar *name, - const gchar *key, GError **err); +gboolean modest_account_mgr_unset (ModestAccountMgr *self, + const gchar *name, + const gchar *key, + gboolean server_account); + /** - * modest_account_mgr_get_account_int: - * @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. + * modest_account_mgr_has_accounts: + * @self: a ModestAccountMgr instance + * @enabled: TRUE to search for enabled accounts only * - * get a config int from some account + * Checks if any accounts exist * - * 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 + * Returns: TRUE if accounts exist, FALSE otherwise */ -gint modest_account_mgr_get_account_int (ModestAccountMgr *self, - const gchar *name, - const gchar *key, GError **err); +gboolean modest_account_mgr_has_accounts (ModestAccountMgr* self, gboolean enabled); /** - * modest_account_mgr_get_account_bool: - * @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. + * modest_account_mgr_set_account_busy + * @self: a ModestAccountMgr instance + * @account_name: name of the account + * @busy: whether to set busy or not busy * - * get a config boolean from some account + * Changes the busy flag of 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); +void modest_account_mgr_set_account_busy(ModestAccountMgr* self, const gchar* account_name, + gboolean busy); /** - * modest_account_mgr_set_account_string: - * @self: 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. + * modest_account_mgr_account_is_busy + * @self: a ModestAccountMgr instance + * @account_name: name of the account * - * set a config string for some account + * Returns: If the account is currently busy or not * - * 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_account_is_busy (ModestAccountMgr* self, + const gchar* account_name); + + +void modest_account_mgr_notify_account_update (ModestAccountMgr* self, + const gchar *server_account_name); + /** - * modest_account_mgr_set_account_int: - * @self: 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. + * modest_account_mgr_set_default_account: + * @self: a ModestAccountMgr instance + * @account: the name of an existing account * - * set a config int for some account + * set the default account name (which must be valid account) * - * Returns: TRUE if setting the value succeeded, or FALSE in case of error. - * @err gives details in case of error + * Returns: TRUE if succeeded, FALSE otherwise */ -gboolean modest_account_mgr_set_account_int (ModestAccountMgr *self, - const gchar *name, - const gchar *key, gint val, - GError **err); +gboolean modest_account_mgr_set_default_account (ModestAccountMgr *self, + const gchar* account); /** - * modest_account_mgr_set_account_bool: - * @self: 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. + * modest_account_mgr_get_default_account: + * @self: a ModestAccountMgr instance * - * set a config bool for some account + * get the default account name, or NULL if none is found * - * Returns: TRUE if setting the value succeeded, or FALSE in case of error. - * @err gives details in case of error + * Returns: the default account name (as newly allocated string, which + * must be g_free'd), or NULL */ -gboolean modest_account_mgr_set_account_bool (ModestAccountMgr *self, - const gchar *name, - const gchar *key, gboolean val, - GError **err); +gchar* modest_account_mgr_get_default_account (ModestAccountMgr *self); + +/** + * modest_account_mgr_get_display_name: + * @self: a ModestAccountMgr instance + * @name: the account name to check + * + * Return the human-readable account title for this account, or NULL. + */ +gchar* modest_account_mgr_get_display_name (ModestAccountMgr *self, + const gchar* name); + +void modest_account_mgr_set_display_name (ModestAccountMgr *self, + const gchar *account_name, + const gchar *display_name); + +gboolean modest_account_mgr_singleton_protocol_exists (ModestAccountMgr *mgr, + ModestProtocolType protocol_type); + +gchar * modest_account_mgr_get_string (ModestAccountMgr *self, const gchar *name, + const gchar *key, gboolean server_account); G_END_DECLS #endif /* __MODEST_ACCOUNT_MGR_H__ */ -