X-Git-Url: http://git.maemo.org/git/?p=modest;a=blobdiff_plain;f=src%2Fmodest-account-mgr-helpers.h;h=be552b5eefea50789e19d38f29986b308685023d;hp=c4411ddef515ba755f0254b7eb7477c7343b6998;hb=027bd4e81f906263a15a732d2707b1fcec630872;hpb=b54ca9c03e98c7cf3baa11d452cee75f6bb79d9c diff --git a/src/modest-account-mgr-helpers.h b/src/modest-account-mgr-helpers.h index c4411dd..be552b5 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,82 +37,42 @@ #include #include #include +#include G_BEGIN_DECLS -typedef struct { - TnyAccount *tny_account; - gchar *account_name; - gchar *hostname; - gchar *username; - gchar *uri; - ModestProtocol proto; - gchar *password; - time_t last_updated; - GSList *options; -} 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 + * Returns: a ModestAccountSettings instance with information about the account, + * or NULL if the account is not valid or does not exist. */ -ModestAccountData *modest_account_mgr_get_account_data (ModestAccountMgr *self, - const gchar* name); +ModestAccountSettings *modest_account_mgr_load_account_settings (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 - */ -gchar* modest_account_mgr_get_default_account (ModestAccountMgr *self); +void modest_account_mgr_save_account_settings (ModestAccountMgr *self, + ModestAccountSettings *settings); /** - * modest_account_mgr_get_default_account: + * modest_account_mgr_set_first_account_as_default: * @self: a ModestAccountMgr instance - * @account: the name of an existing account * - * set the default account name (which must be valid account) + * Guarantees that at least one account, if there are any accounts, is the default, + * so that modest_account_mgr_get_default_account() will return non-NULL if there + * are any accounts. * * Returns: TRUE if succeeded, FALSE otherwise */ -gboolean modest_account_mgr_set_default_account (ModestAccountMgr *self, - const gchar* account); - -/** - * 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); +gboolean +modest_account_mgr_set_first_account_as_default (ModestAccountMgr *self); +/** Get the first one, alphabetically, by title. */ +gchar* +modest_account_mgr_get_first_account_name (ModestAccountMgr *self); /** @@ -139,35 +99,352 @@ 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_set_signature + * @self: a ModestAccountMgr instance + * @name: the account name to check + * @signature: the signature text + * @use_signature: Whether the signature should be used. + * + * Sets the signature text for the account. + * + * Returns: TRUE if it worked, FALSE otherwise + */ +gboolean modest_account_mgr_set_signature (ModestAccountMgr *self, const gchar* name, + const gchar* signature, gboolean use_signature); /** - * modest_account_mgr_get_tny_account: - * @self: a #ModestAccountMgr instance + * modest_account_mgr_get_signature: + * @self: a ModestAccountMgr instance + * @name: the account name + * @use_signature: Pointer to a gboolean taht will be set to TRUE if the signature should be used. + * + * Gets the signature text for this account. + * + * Returns: The signature text, which should be freed with g_free(). + */ +gchar* modest_account_mgr_get_signature (ModestAccountMgr *self, const gchar* name, + gboolean* use_signature); + +/** + * modest_account_mgr_get_store_protocol: + * @self: a ModestAccountMgr instance * @name: the account name - * @type: the #TnyAccountType to check; either TNY_ACCOUNT_TYPE_TRANSPORT or TNY_ACCOUNT_TYPE_STORE * - * get the TnyAccount corresponding to the store/transport (server) accounts for some account. - * ie., every account has two server accounts, and for every server account there is a corresponding - * TnyAccount + * Gets the protocol type (For instance, POP or IMAP) used for the store server account. + * + * Returns: The protocol type. + */ +ModestProtocolType modest_account_mgr_get_store_protocol (ModestAccountMgr *self, const gchar* name); + +/** + * modest_account_mgr_set_connection_specific_smtp + * @self: a ModestAccountMgr instance + * @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* connection_id, const gchar* server_account_name); + +/** + * modest_account_mgr_remove_connection_specific_smtp + * @self: a ModestAccountMgr instance + * @connection_id: A libconic IAP connection name + * + * 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* connection_id); + +/** + * modest_account_mgr_get_use_connection_specific_smtp + * @self: a ModestAccountMgr instance + * @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 + * @connection_id: A libconic IAP connection id + * + * Retrieve a server account to use with this specific connection for this account. * - * Returns: the requested TnyAccount, or NULL in case of error + * 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* connection_id); + + +/** + * modest_account_mgr_get_server_account_username: + * @self: a ModestAccountMgr instance + * @account_name: The name of a server account. + * + * Gets the username this server account. + * + * Returns: The username. + */ +gchar* modest_account_mgr_get_server_account_username (ModestAccountMgr *self, + const gchar* account_name); + +/** + * 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. */ -TnyAccount* modest_account_mgr_get_tny_account (ModestAccountMgr *self, const gchar* name, - TnyAccountType type); +void modest_account_mgr_set_server_account_username (ModestAccountMgr *self, + const gchar* account_name, + const gchar* username); + +/** + * modest_account_mgr_get_server_account_username_has_succeeded: + * @self: a ModestAccountMgr instance + * @account_name: The name of a server account. + * + * Whether a connection has ever been successfully made to this account with + * the current username. This can be used to avoid asking again for the username + * when asking a second time for a non-stored password. + * + * Returns: TRUE if the username is known to be correct. + */ +gboolean modest_account_mgr_get_server_account_username_has_succeeded (ModestAccountMgr *self, + const gchar* account_name); + +/** + * 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_account_mgr_set_server_account_username_has_succeeded (ModestAccountMgr *self, + const gchar* account_name, + gboolean succeeded); + +/** + * 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_account_mgr_set_server_account_password (ModestAccountMgr *self, + const gchar* account_name, + const gchar* 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_account_mgr_get_server_account_password (ModestAccountMgr *self, + const gchar* account_name); + +/** + * 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_account_mgr_get_server_account_has_password (ModestAccountMgr *self, + const gchar* account_name); + +/** + * modest_server_account_modest_account_mgr_get_server_account_hostname: + * @self: a ModestAccountMgr instance + * @account_name: The name of a server account. + * + * Gets the hostname this server account. + * + * Returns: The hostname. + */ +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_account_mgr_get_server_account_secure_auth: + * @self: a ModestAccountMgr instance + * @account_name: The name of a server account. + * + * Gets the secure authentication method for this server account. + * + * Returns: The secure authentication enum value. + */ +ModestProtocolType modest_account_mgr_get_server_account_secure_auth (ModestAccountMgr *self, + const gchar* account_name); + +/** + * modest_server_account_data_get_secure_auth: + * @self: a ModestAccountMgr instance + * @account_name: The name of a server account. + * @secure_auth: The secure authentication enum value. + * + * Gets the secure authentication method for this server account. + */ +void modest_account_mgr_set_server_account_secure_auth (ModestAccountMgr *self, + const gchar* account_name, + ModestProtocolType secure_auth); + +/** + * modest_server_account_data_get_security: + * @self: a ModestAccountMgr instance + * @account_name: The name of a server account. + * + * Gets the security method for this server account. + * + * Returns: The security connection protocol. + */ +ModestProtocolType modest_account_mgr_get_server_account_security (ModestAccountMgr *self, + const gchar* account_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_server_account_security (ModestAccountMgr *self, + const gchar* account_name, + ModestProtocolType security); + +gboolean modest_account_mgr_save_server_settings (ModestAccountMgr *self, + ModestServerAccountSettings *settings); + +ModestServerAccountSettings *modest_account_mgr_load_server_settings (ModestAccountMgr *self, + const gchar *account_name, + gboolean is_transport_not_store); /** * 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 */ gchar * modest_account_mgr_get_from_string (ModestAccountMgr *self, const gchar* name); +/** + * modest_account_mgr_get_unused_account_name + * @self: a #ModestAccountMgr instance + * @name: The initial account name + * + * get an unused account name, based on a starting string. + * + * Returns: the newly allocated name. + */ +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 + * @self: a #ModestAccountMgr instance + * @name: The initial account display name + * + * get an unused account display name, based on a starting string. + * + * Returns: the newly allocated 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 #endif /* __MODEST_ACCOUNT_MGR_H__ */