#define __MODEST_ACCOUNT_MGR_HELPERS_H__
#include <modest-account-mgr.h>
+#include <modest-tny-account-store.h>
+
+#include <tny-account.h>
+#include <tny-store-account.h>
+#include <tny-transport-account.h>
G_BEGIN_DECLS
typedef struct {
- gchar *account_name;
- gchar *hostname;
- gchar *username;
- ModestProtocol proto;
- gchar *password;
+ 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 enabled;
+ 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:
* @self: a ModestAccountMgr instance
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
+ */
+gchar* modest_account_mgr_get_default_account (ModestAccountMgr *self);
/**
- * modest_account_mgr_free_account_data:
+ * modest_account_mgr_set_default_account:
* @self: a ModestAccountMgr instance
- * @data: a ModestAccountData instance
+ * @account: the name of an existing account
*
- * free the account data structure
+ * set the default account name (which must be valid account)
+ *
+ * Returns: TRUE if succeeded, FALSE otherwise
*/
-void modest_account_mgr_free_account_data (ModestAccountMgr *self,
- ModestAccountData *data);
+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);
/**
- * modest_account_mgr_server_account_names:
+ * modest_account_mgr_set_first_account_as_default:
* @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
+ * 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: 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
+ * Returns: TRUE if succeeded, FALSE otherwise
+ */
+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
*/
-GSList* modest_account_mgr_search_server_accounts (ModestAccountMgr *self,
- const gchar* account_name,
- ModestProtocolType type,
- ModestProtocol proto);
+void modest_account_mgr_free_account_data (ModestAccountMgr *self,
+ ModestAccountData *data);
/**
- * 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
*
* 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
*
*
* 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_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
+ * @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);
+
+/**
+ * modest_account_mgr_set_connection_specific_smtp
+ * @self: a ModestAccountMgr instance
+ * @name: the account name
+ * @connection_name: 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);
+
+/**
+ * modest_account_mgr_remove_connection_specific_smtp
+ * @self: a ModestAccountMgr instance
+ * @name: the account name
+ * @connection_name: A libconic IAP connection name
+ *
+ * Disassacoiate 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);
+
+/**
+ * modest_account_mgr_get_has_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);
+
+/**
+ * modest_account_mgr_get_connection_specific_smtp
+ * @self: a ModestAccountMgr instance
+ * @name: the account name
+ * @connection_name: A libconic IAP connection name
+ *
+ * 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);
+
+
+/**
+ * modest_server_account_get_username:
+ * @self: a ModestAccountMgr instance
+ * @account_name: The name of a server account.
+ *
+ * Gets the username this server account.
+ *
+ * Returns: The username.
+ */
+gchar*
+modest_server_account_get_username (ModestAccountMgr *self, const gchar* account_name);
+
+/**
+ * modest_server_account_set_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);
+
+/**
+ * modest_server_account_get_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_server_account_get_username_has_succeeded (ModestAccountMgr *self, const gchar* account_name);
+
+/**
+ * modest_server_account_set_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);
+
+/**
+ * modest_server_account_set_password:
+ * @self: a ModestAccountMgr instance
+ * @account_name: The name of a server account.
+ * @password: The new password.
+ *
+ * Sets the password this server account.
+ */
+void
+modest_server_account_set_password (ModestAccountMgr *self, const gchar* account_name,
+ const gchar* password);
+
+
+/**
+ * modest_server_account_modest_server_account_get_hostnameget_username:
+ * @self: a ModestAccountMgr instance
+ * @account_name: The name of a server account.
+ *
+ * Gets the hostname this server account.
+ *
+ * Returns: The hostname.
+ */
+gchar*
+modest_server_account_get_hostname (ModestAccountMgr *self, const gchar* account_name);
+
+
+/**
+ * modest_server_account_get_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.
+ */
+ModestAuthProtocol
+modest_server_account_get_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_server_account_set_secure_auth (ModestAccountMgr *self, const gchar* account_name,
+ ModestAuthProtocol 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 enum value.
+ */
+ModestConnectionProtocol
+modest_server_account_get_security (ModestAccountMgr *self, const gchar* account_name);
+
+/**
+ * modest_server_account_set_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);
+
+ModestServerAccountData*
+modest_account_mgr_get_server_account_data (ModestAccountMgr *self, const gchar* name);
+
+void
+modest_account_mgr_free_server_account_data (ModestAccountMgr *self,
+ ModestServerAccountData* data);
+
+/**
+ * modest_account_mgr_get_from_string
+ * @self: a #ModestAccountMgr instance
+ * @name: the account name
+ *
+ * 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);
G_END_DECLS