X-Git-Url: http://git.maemo.org/git/?p=modest;a=blobdiff_plain;f=src%2Fmodest-account-mgr-helpers.h;h=f10d8739362bafa4081b0cc7338c4670fa361ea4;hp=d122dafb08e59a152e3970ba092ce78fc9a2d969;hb=4d39841513a3a7f7aa9d38ab97cb9fcc9171e80b;hpb=5024de84b7959b0b3373176d8c1f91a73427ff88 diff --git a/src/modest-account-mgr-helpers.h b/src/modest-account-mgr-helpers.h index d122daf..f10d873 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, @@ -32,74 +32,51 @@ #define __MODEST_ACCOUNT_MGR_HELPERS_H__ #include +#include -G_BEGIN_DECLS - -typedef struct { - gchar *account_name; - gchar *hostname; - gchar *username; - ModestProtocol proto; - gchar *password; -} ModestServerAccountData; +#include +#include +#include +#include -typedef struct { - gchar *account_name; - gchar *display_name; - gchar *fullname; - gchar *email; - gboolean enabled; - ModestServerAccountData *transport_account; - ModestServerAccountData *store_account; -} ModestAccountData; +G_BEGIN_DECLS /** - * 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); +void modest_account_mgr_save_account_settings (ModestAccountMgr *self, + ModestAccountSettings *settings); /** - * modest_account_mgr_free_account_data: + * modest_account_mgr_set_first_account_as_default: * @self: a ModestAccountMgr instance - * @data: a ModestAccountData instance * - * free the account data structure + * 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 */ -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); -/** - * 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_enabled: get only enabled server accounts if TRUE - * - * list all the server 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 - */ -GSList* modest_account_mgr_search_server_accounts (ModestAccountMgr *self, - const gchar* account_name, - ModestProtocolType type, - ModestProtocol proto); /** - * modest_account_mgr_account_set_enabled + * modest_account_mgr_set_enabled * @self: a ModestAccountMgr instance * @name: the account name * @enabled: if TRUE, the account will be enabled, if FALSE, it will be disabled @@ -108,12 +85,11 @@ GSList* modest_account_mgr_search_server_accounts (ModestAccountMgr *self, * * Returns: TRUE if it worked, FALSE otherwise */ -gboolean modest_account_mgr_account_set_enabled (ModestAccountMgr *self, const gchar* name, - gboolean enabled); - +gboolean modest_account_mgr_set_enabled (ModestAccountMgr *self, const gchar* name, + gboolean enabled); /** - * modest_account_mgr_account_get_enabled: + * modest_account_mgr_get_enabled: * @self: a ModestAccountMgr instance * @name: the account name to check * @@ -121,8 +97,367 @@ gboolean modest_account_mgr_account_set_enabled (ModestAccountMgr *self, const g * * Returns: TRUE if it is enabled, FALSE otherwise */ -gboolean modest_account_mgr_account_get_enabled (ModestAccountMgr *self, const gchar* name); +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_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); + +gchar *modest_account_mgr_get_signature_from_recipient (ModestAccountMgr *self, const gchar *recipient, + gboolean *use_signature); + +void modest_account_mgr_get_branding_from_recipient (ModestAccountMgr *mgr, + const gchar *current_recipient, + gchar **service_name, + const GdkPixbuf **service_icon, + guint64 icon_size); + +gboolean modest_account_mgr_account_is_multimailbox (ModestAccountMgr *mgr, + const gchar *account_name, + ModestProtocol **mmb_protocol); + +/** + * modest_account_mgr_get_store_protocol: + * @self: a ModestAccountMgr instance + * @name: the account name + * + * 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: 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. + */ +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 + * @mailbox: the mailbox + * + * 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, const gchar *mailbox); + + +/** + * 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