X-Git-Url: http://git.maemo.org/git/?p=modest;a=blobdiff_plain;f=src%2Fmodest-account-mgr-helpers.h;h=037859717e67072a4e10513fbe08e00bb08118c5;hp=d5b020e88dd48e68137ff045f7d9d3c86bfa44d6;hb=0727def97bea123c219228b34de3842cb777dc15;hpb=47b04b1e03f3599c7c77b5040baf7ad58aa3802b diff --git a/src/modest-account-mgr-helpers.h b/src/modest-account-mgr-helpers.h index d5b020e..0378597 100644 --- a/src/modest-account-mgr-helpers.h +++ b/src/modest-account-mgr-helpers.h @@ -15,7 +15,7 @@ * 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 + * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMIT * 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, @@ -37,83 +37,25 @@ #include #include #include +#include G_BEGIN_DECLS -typedef struct { - gchar *account_name; - gchar *hostname; - gchar *username; - gchar *uri; /*< Only for mbox and maildir accounts. */ - ModestTransportStoreProtocol proto; /*< The store or transport. Not ORed. */ - gchar *password; - time_t last_updated; - gint port; /* Or 0, if the default should be used. */ - ModestAuthProtocol secure_auth; - ModestConnectionProtocol security; -} ModestServerAccountData; - -typedef struct { - gchar *account_name; - gchar *display_name; - gchar *fullname; - gchar *email; - gboolean is_enabled; - gboolean is_default; - ModestServerAccountData *transport_account; - ModestServerAccountData *store_account; -} ModestAccountData; - - - /** - * modest_account_mgr_get_account_data: + * modest_account_mgr_load_account_settings: * @self: a ModestAccountMgr instance * @name: the name of the account * * get information about an account * - * Returns: a ModestAccountData structure with information about the account. - * the data should not be changed, and be freed with modest_account_mgr_free_account_data - * The function does a sanity check, an if it's not returning NULL, - * it is a valid account - */ -ModestAccountData *modest_account_mgr_get_account_data (ModestAccountMgr *self, - const gchar* name); - -/** - * modest_account_mgr_get_default_account: - * @self: a ModestAccountMgr instance - * - * get the default account name, or NULL if none is found - * - * Returns: the default account name (as newly allocated string, which - * must be g_free'd), or NULL + * Returns: a ModestAccountSettings instance with information about the account, + * or NULL if the account is not valid or does not exist. */ -gchar* modest_account_mgr_get_default_account (ModestAccountMgr *self); +ModestAccountSettings *modest_account_mgr_load_account_settings (ModestAccountMgr *self, + const gchar* name); -/** - * modest_account_mgr_set_default_account: - * @self: a ModestAccountMgr instance - * @account: the name of an existing account - * - * set the default account name (which must be valid account) - * - * Returns: TRUE if succeeded, FALSE otherwise - */ -gboolean modest_account_mgr_set_default_account (ModestAccountMgr *self, - const gchar* account); - -/** - * modest_account_mgr_unset_default_account: - * @self: a ModestAccountMgr instance - * @account: the name of an account - * - * Unset the default account name, so that no account is the default. - * - * Returns: TRUE if succeeded, FALSE otherwise - */ -gboolean modest_account_mgr_unset_default_account (ModestAccountMgr *self); +void modest_account_mgr_save_account_settings (ModestAccountMgr *self, + ModestAccountSettings *settings); /** * modest_account_mgr_set_first_account_as_default: @@ -128,15 +70,10 @@ gboolean modest_account_mgr_unset_default_account (ModestAccountMgr *self); gboolean modest_account_mgr_set_first_account_as_default (ModestAccountMgr *self); -/** - * modest_account_mgr_free_account_data: - * @self: a ModestAccountMgr instance - * @data: a ModestAccountData instance - * - * free the account data structure - */ -void modest_account_mgr_free_account_data (ModestAccountMgr *self, - ModestAccountData *data); +/** Get the first one, alphabetically, by title. */ +gchar* +modest_account_mgr_get_first_account_name (ModestAccountMgr *self); + /** * modest_account_mgr_set_enabled @@ -163,17 +100,6 @@ gboolean modest_account_mgr_set_enabled (ModestAccountMgr *self, const gchar* na gboolean modest_account_mgr_get_enabled (ModestAccountMgr *self, const gchar* name); /** - * 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); - - -/** * modest_account_mgr_set_signature * @self: a ModestAccountMgr instance * @name: the account name to check @@ -214,54 +140,62 @@ ModestTransportStoreProtocol modest_account_mgr_get_store_protocol (ModestAccoun /** * modest_account_mgr_set_connection_specific_smtp * @self: a ModestAccountMgr instance - * @name: the account name - * @connection_name: A libconic IAP connection name + * @connection_id: A libconic IAP connection name * @server_account_name: a server account name to use for this connection. * * Specify a server account to use with the specific connection for this account. * * Returns: TRUE if it worked, FALSE otherwise */ -gboolean modest_account_mgr_set_connection_specific_smtp (ModestAccountMgr *self, const gchar* name, - const gchar* connection_name, const gchar* server_account_name); +gboolean modest_account_mgr_set_connection_specific_smtp (ModestAccountMgr *self, + const gchar* connection_id, const gchar* server_account_name); /** * modest_account_mgr_remove_connection_specific_smtp * @self: a ModestAccountMgr instance - * @name: the account name - * @connection_name: A libconic IAP connection name + * @connection_id: A libconic IAP connection name * - * Disassacoiate a server account to use with the specific connection for this account. + * Disassociate a server account to use with the specific connection for this account. * * Returns: TRUE if it worked, FALSE otherwise */ -gboolean modest_account_mgr_remove_connection_specific_smtp (ModestAccountMgr *self, const gchar* name, - const gchar* connection_name); +gboolean modest_account_mgr_remove_connection_specific_smtp (ModestAccountMgr *self, + const gchar* connection_id); /** - * modest_account_mgr_get_has_connection_specific_smtp + * modest_account_mgr_get_use_connection_specific_smtp * @self: a ModestAccountMgr instance - * @name: the account name - * @result: Whether this account uses any connection-specific smtp server accounts. - */ -gboolean modest_account_mgr_get_has_connection_specific_smtp (ModestAccountMgr *self, const gchar* account_name); + * @account_name: the account name + * @result: Whether this account should use connection-specific smtp server accounts. + */ +gboolean modest_account_mgr_get_use_connection_specific_smtp (ModestAccountMgr *self, const gchar* account_name); + +/** + * modest_account_mgr_set_use_connection_specific_smtp + * @self: a ModestAccountMgr instance + * @account_name: the account name + * @new_value: New value that indicates if if this account should use connection-specific smtp server accounts. + * @result: TRUE if it succeeded, FALSE otherwise + */ +gboolean modest_account_mgr_set_use_connection_specific_smtp (ModestAccountMgr *self, + const gchar* account_name, + gboolean new_value); /** * modest_account_mgr_get_connection_specific_smtp * @self: a ModestAccountMgr instance - * @name: the account name - * @connection_name: A libconic IAP connection name + * @connection_id: A libconic IAP connection id * * Retrieve a server account to use with this specific connection for this account. * * Returns: a server account name to use for this connection, or NULL if none is specified. */ -gchar* modest_account_mgr_get_connection_specific_smtp (ModestAccountMgr *self, const gchar* name, - const gchar* connection_name); +gchar* modest_account_mgr_get_connection_specific_smtp (ModestAccountMgr *self, + const gchar* connection_id); /** - * modest_server_account_get_username: + * modest_account_mgr_get_server_account_username: * @self: a ModestAccountMgr instance * @account_name: The name of a server account. * @@ -269,23 +203,23 @@ gchar* modest_account_mgr_get_connection_specific_smtp (ModestAccountMgr *self, * * Returns: The username. */ -gchar* -modest_server_account_get_username (ModestAccountMgr *self, const gchar* account_name); +gchar* modest_account_mgr_get_server_account_username (ModestAccountMgr *self, + const gchar* account_name); /** - * modest_server_account_set_username: + * modest_account_mgr_set_server_account_username: * @self: a ModestAccountMgr instance * @account_name: The name of a server account. * @username: The new username. * * Sets the username this server account. */ -void -modest_server_account_set_username (ModestAccountMgr *self, const gchar* account_name, - const gchar* username); +void modest_account_mgr_set_server_account_username (ModestAccountMgr *self, + const gchar* account_name, + const gchar* username); /** - * modest_server_account_get_username_has_succeeded: + * modest_account_mgr_get_server_account_username_has_succeeded: * @self: a ModestAccountMgr instance * @account_name: The name of a server account. * @@ -295,55 +229,55 @@ modest_server_account_set_username (ModestAccountMgr *self, const gchar* account * * Returns: TRUE if the username is known to be correct. */ -gboolean -modest_server_account_get_username_has_succeeded (ModestAccountMgr *self, const gchar* account_name); +gboolean modest_account_mgr_get_server_account_username_has_succeeded (ModestAccountMgr *self, + const gchar* account_name); /** - * modest_server_account_set_username_has_succeeded: + * modest_account_mgr_set_server_account_username_has_succeeded: * @self: a ModestAccountMgr instance * @account_name: The name of a server account. * @succeeded: Whether the username has succeeded * * Sets whether the username is known to be correct. */ -void -modest_server_account_set_username_has_succeeded (ModestAccountMgr *self, const gchar* account_name, - gboolean succeeded); +void modest_account_mgr_set_server_account_username_has_succeeded (ModestAccountMgr *self, + const gchar* account_name, + gboolean succeeded); /** - * modest_server_account_set_password: + * modest_account_mgr_set_server_account_password: * @self: a ModestAccountMgr instance * @account_name: The name of a server account. * @password: The new password. * * Sets the password for this server account. */ -void -modest_server_account_set_password (ModestAccountMgr *self, const gchar* account_name, - const gchar* password); +void modest_account_mgr_set_server_account_password (ModestAccountMgr *self, + const gchar* account_name, + const gchar* password); /** - * modest_server_account_get_password: + * modest_account_mgr_get_server_account_password: * @self: a ModestAccountMgr instance * @account_name: The name of a server account. * * Gets the password for this server account from the account settings. */ -gchar* -modest_server_account_get_password (ModestAccountMgr *self, const gchar* account_name); +gchar* modest_account_mgr_get_server_account_password (ModestAccountMgr *self, + const gchar* account_name); /** - * modest_server_account_get_has_password: + * modest_account_mgr_get_server_account_has_password: * @self: a ModestAccountMgr instance * @account_name: The name of a server account. * * Gets whether a password has been set for this server account in the account settings. */ -gboolean -modest_server_account_get_has_password (ModestAccountMgr *self, const gchar* account_name); +gboolean modest_account_mgr_get_server_account_has_password (ModestAccountMgr *self, + const gchar* account_name); /** - * modest_server_account_modest_server_account_get_hostnameget_username: + * modest_server_account_modest_account_mgr_get_server_account_hostname: * @self: a ModestAccountMgr instance * @account_name: The name of a server account. * @@ -351,12 +285,23 @@ modest_server_account_get_has_password (ModestAccountMgr *self, const gchar* acc * * Returns: The hostname. */ -gchar* -modest_server_account_get_hostname (ModestAccountMgr *self, const gchar* account_name); +gchar* modest_account_mgr_get_server_account_hostname (ModestAccountMgr *self, + const gchar* account_name); +/** + * modest_server_account_modest_account_mgr_set_server_account_hostname: + * @self: a ModestAccountMgr instance + * @account_name: The name of a server account. + * @hostname: The new hostname + * + * Sets the hostname this server account. + */ +void modest_account_mgr_set_server_account_hostname (ModestAccountMgr *self, + const gchar* account_name, + const gchar *hostname); /** - * modest_server_account_get_secure_auth: + * modest_account_mgr_get_server_account_secure_auth: * @self: a ModestAccountMgr instance * @account_name: The name of a server account. * @@ -364,8 +309,8 @@ modest_server_account_get_hostname (ModestAccountMgr *self, const gchar* account * * Returns: The secure authentication enum value. */ -ModestAuthProtocol -modest_server_account_get_secure_auth (ModestAccountMgr *self, const gchar* account_name); +ModestAuthProtocol modest_account_mgr_get_server_account_secure_auth (ModestAccountMgr *self, + const gchar* account_name); /** * modest_server_account_data_get_secure_auth: @@ -375,9 +320,9 @@ modest_server_account_get_secure_auth (ModestAccountMgr *self, const gchar* acco * * Gets the secure authentication method for this server account. */ -void -modest_server_account_set_secure_auth (ModestAccountMgr *self, const gchar* account_name, - ModestAuthProtocol secure_auth); +void modest_account_mgr_set_server_account_secure_auth (ModestAccountMgr *self, + const gchar* account_name, + ModestAuthProtocol secure_auth); /** * modest_server_account_data_get_security: @@ -388,33 +333,32 @@ modest_server_account_set_secure_auth (ModestAccountMgr *self, const gchar* acco * * Returns: The security enum value. */ -ModestConnectionProtocol -modest_server_account_get_security (ModestAccountMgr *self, const gchar* account_name); +ModestConnectionProtocol modest_account_mgr_get_server_account_security (ModestAccountMgr *self, + const gchar* account_name); /** - * modest_server_account_set_security: + * modest_account_mgr_set_server_account_security: * @self: a ModestAccountMgr instance * @secure_auth: The security enum value. * * Gets the security method for this server account. */ -void -modest_server_account_set_security (ModestAccountMgr *self, const gchar* account_name, - ModestConnectionProtocol security); +void modest_account_mgr_set_server_account_security (ModestAccountMgr *self, + const gchar* account_name, + ModestConnectionProtocol security); -ModestServerAccountData* -modest_account_mgr_get_server_account_data (ModestAccountMgr *self, const gchar* name); +gboolean modest_account_mgr_save_server_settings (ModestAccountMgr *self, + ModestServerAccountSettings *settings); -void -modest_account_mgr_free_server_account_data (ModestAccountMgr *self, - ModestServerAccountData* data); +ModestServerAccountSettings *modest_account_mgr_load_server_settings (ModestAccountMgr *self, + const gchar *account_name); /** * modest_account_mgr_get_from_string * @self: a #ModestAccountMgr instance * @name: the account name * - * get the From: string for some account; ie. "Foo Bar" " + * get the From: string for some account; ie. "Foo Bar" <foo.bar@cuux.yy>" * * Returns: the newly allocated from-string, or NULL in case of error */ @@ -430,9 +374,9 @@ gchar * modest_account_mgr_get_from_string (ModestAccountMgr *self, const gchar* * * Returns: the newly allocated name. */ -gchar* -modest_account_mgr_get_unused_account_name (ModestAccountMgr *self, const gchar* starting_name, - gboolean server_account); +gchar* modest_account_mgr_get_unused_account_name (ModestAccountMgr *self, + const gchar* starting_name, + gboolean server_account); /** * modest_account_mgr_get_unused_account_display name @@ -443,8 +387,62 @@ modest_account_mgr_get_unused_account_name (ModestAccountMgr *self, const gchar* * * Returns: the newly allocated name. */ -gchar* -modest_account_mgr_get_unused_account_display_name (ModestAccountMgr *self, const gchar* starting_name); +gchar* modest_account_mgr_get_unused_account_display_name (ModestAccountMgr *self, + const gchar* starting_name); + +/** + * modest_account_mgr_set_server_account_security: + * @self: a ModestAccountMgr instance + * @secure_auth: The security enum value. + * + * Gets the security method for this server account. + */ +void modest_account_mgr_set_leave_on_server (ModestAccountMgr *self, + const gchar* account_name, + gboolean leave_on_server); + +gboolean modest_account_mgr_get_leave_on_server (ModestAccountMgr *self, + const gchar* account_name); + +gint modest_account_mgr_get_last_updated (ModestAccountMgr *self, + const gchar* account_name); + +void modest_account_mgr_set_last_updated (ModestAccountMgr *self, + const gchar* account_name, + gint time); + +gint modest_account_mgr_get_retrieve_limit (ModestAccountMgr *self, + const gchar* account_name); + +void modest_account_mgr_set_retrieve_limit (ModestAccountMgr *self, + const gchar* account_name, + gint limit_retrieve); + +gint modest_account_mgr_get_server_account_port (ModestAccountMgr *self, + const gchar* account_name); + +void modest_account_mgr_set_server_account_port (ModestAccountMgr *self, + const gchar *account_name, + gint port_num); + +gchar* modest_account_mgr_get_server_account_name (ModestAccountMgr *self, + const gchar *account_name, + TnyAccountType account_type); + +ModestAccountRetrieveType modest_account_mgr_get_retrieve_type (ModestAccountMgr *self, + const gchar *account_name); + +void modest_account_mgr_set_retrieve_type (ModestAccountMgr *self, + const gchar *account_name, + ModestAccountRetrieveType retrieve_type); + +void modest_account_mgr_set_user_fullname (ModestAccountMgr *self, + const gchar *account_name, + const gchar *fullname); + +void modest_account_mgr_set_user_email (ModestAccountMgr *self, + const gchar *account_name, + const gchar *email); G_END_DECLS