2007-04-30 Murray Cumming <murrayc@murrayc.com>
[modest] / src / modest-account-mgr-helpers.h
index 61cef7d..60d91ef 100644 (file)
 G_BEGIN_DECLS
 
 typedef struct {
-       TnyAccount    *tny_account;
-       gchar         *account_name;
-       gchar         *hostname;
-       gchar         *username;
-       ModestProtocol proto;
-       gchar         *password;
-       GSList        *options;
+       gchar            *account_name;
+       gchar            *hostname;
+       gchar            *username;
+       gchar            *uri;
+       ModestProtocol    proto; /*< The store or transport. Not ORed. */
+       gchar            *password;
+       time_t            last_updated;
+       gint             port; /* Or 0, if the default should be used. */
+       ModestProtocol   secure_auth;
+       ModestProtocol   security;
+       GSList           *options;
 } 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;
@@ -89,7 +94,7 @@ ModestAccountData *modest_account_mgr_get_account_data     (ModestAccountMgr *se
 gchar* modest_account_mgr_get_default_account  (ModestAccountMgr *self);
 
 /**
- * modest_account_mgr_get_default_account:
+ * modest_account_mgr_set_default_account:
  * @self: a ModestAccountMgr instance
  * @account: the name of an existing account
  * 
@@ -101,6 +106,30 @@ 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_set_first_account_as_default:
+ * @self: a ModestAccountMgr instance
+ * 
+ * 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_first_account_as_default  (ModestAccountMgr *self);
+
+/**
  * modest_account_mgr_free_account_data:
  * @self: a ModestAccountMgr instance
  * @data: a ModestAccountData instance
@@ -110,8 +139,6 @@ gboolean modest_account_mgr_set_default_account  (ModestAccountMgr *self,
 void       modest_account_mgr_free_account_data     (ModestAccountMgr *self,
                                                     ModestAccountData *data);
 
-
-
 /**
  * modest_account_mgr_set_enabled
  * @self: a ModestAccountMgr instance
@@ -136,22 +163,157 @@ 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_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_get_tny_account:
- * @self: a #ModestAccountMgr instance
+ * 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_connection_specific_smtp
+ * @self: a ModestAccountMgr instance
  * @name: the account name
- * @type: the #TnyAccountType to check; either TNY_ACCOUNT_TYPE_TRANSPORT or TNY_ACCOUNT_TYPE_STORE
+ * @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_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.
+ */
+ModestProtocol
+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, 
+       ModestProtocol 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.
+ */
+ModestProtocol
+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, 
+       ModestProtocol 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);
+       
+#if 0
+/**
+ * modest_account_mgr_get_account_option:
+ * @self: a ModestAccountMgr instance
+ * @account_name: the account name to check
+ * @account_name: the option name to check
+ *
+ * Returns: The account option value. This must be freed with g_free().
+ */
+gchar* modest_account_mgr_get_server_account_option (ModestAccountMgr *self, 
+       const gchar* account_name, const gchar* option_name);
+
+/**
+ * modest_server_account_data_get_option_value:
+ * @options_list: a ModestServerAccountData::options list.
+ * @option_name: the option name to check
  *
- * 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 
+ * Returns: The account option value. This must be freed with g_free().
+ */
+gchar* modest_server_account_data_get_option_string (GSList* options_list, const gchar* option_name);
+
+/**
+ * modest_server_account_data_get_option_bool:
+ * @options_list: a ModestServerAccountData::options list.
+ * @option_name: the option name to check
  *
- * Returns: the requested TnyAccount, or NULL in case of error
+ * Returns: Whether the account option is present.
  */
-TnyAccount*  modest_account_mgr_get_tny_account (ModestAccountMgr *self, const gchar* name,
-                                                TnyAccountType type);
+gboolean modest_server_account_data_get_option_bool (GSList* options_list, const gchar* option_name);
+#endif
 
 /**
  * modest_account_mgr_get_from_string
@@ -165,6 +327,31 @@ TnyAccount*  modest_account_mgr_get_tny_account (ModestAccountMgr *self, const g
 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
 
 #endif /* __MODEST_ACCOUNT_MGR_H__ */