2007-04-18 Murray Cumming <murrayc@murrayc.com>

[modest] / src / modest-account-mgr-helpers.h

diff --git a/src/modest-account-mgr-helpers.h b/src/modest-account-mgr-helpers.h
index 9457de9..8a09475 100644 (file)
--- a/src/modest-account-mgr-helpers.h
+++ b/src/modest-account-mgr-helpers.h
@@ -32,28 +32,39 @@
 #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;
-       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. */
+       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;
 
+
+
 /**
  * modest_account_mgr_get_account_data:
  * @self: a ModestAccountMgr instance
@@ -102,10 +113,8 @@ gboolean modest_account_mgr_set_default_account  (ModestAccountMgr *self,
 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
@@ -114,12 +123,11 @@ void       modest_account_mgr_free_account_data     (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
  *
@@ -127,12 +135,94 @@ 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_server_account_get_option_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_option_secure_auth (ModestAccountMgr *self, const gchar* account_name);
+
+/**
+ * modest_server_account_data_get_option_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_option_secure_auth (ModestAccountMgr *self, const gchar* account_name, 
+       ModestProtocol secure_auth);
+       
+/**
+ * modest_server_account_data_get_option_security:
+ * @account_data: a ModestAccountData instance.
+ *
+ * Gets the security method for this server account.
+ *
+ * Returns: The security enum value.
+ */
+ModestProtocol
+modest_server_account_data_get_option_security (ModestServerAccountData *account_data);
+
+/**
+ * modest_server_account_set_option_security:
+ * @self: a ModestAccountMgr instance
+ * @secure_auth: The security enum value.
+ *
+ * Gets the security method for this server account.
+ */
+void
+modest_server_account_set_option_security (ModestAccountMgr *self, const gchar* account_name, 
+       ModestProtocol security);
 
+/**
+ * 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
+ *
+ * Returns: The account option value. This must be freed with g_free().
+ */
+gchar* modest_server_account_data_get_option_value (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: Whether the account option is present.
+ */
+gboolean modest_server_account_data_get_option_bool (GSList* options_list, const gchar* option_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" <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);
 
 
 G_END_DECLS