* modest-ui-actions:
[modest] / src / modest-account-mgr.h
index 5c36a63..a1d3113 100644 (file)
@@ -32,9 +32,9 @@
 #define __MODEST_ACCOUNT_MGR_H__
 
 #include <glib-object.h>
-#include "modest-conf.h"
-#include "modest-account-keys.h"
-#include "modest-proto.h"
+#include <modest-conf.h>
+#include <modest-defs.h>
+#include <modest-protocol-info.h>
 
 G_BEGIN_DECLS
 
@@ -57,14 +57,15 @@ struct _ModestAccountMgr {
 struct _ModestAccountMgrClass {
        GObjectClass parent_class;
 
-       void (* account_removed)   (ModestAccountMgr *obj, const gchar* account, gboolean server_account, gpointer user_data);
-       void (* account_changed)   (ModestAccountMgr *obj, const gchar* account, const gchar* key, gboolean server_account,
+       void (* account_removed)   (ModestAccountMgr *obj, const gchar* account,
+                                   gboolean server_account, gpointer user_data);
+       void (* account_changed)   (ModestAccountMgr *obj, const gchar* account,
+                                   const gchar* key, gboolean server_account,
                                    gpointer user_data);
 };
 
-
 /**
- * modest_ui_get_type:
+ * modest_account_mgr_get_type:
  * 
  * get the GType for ModestAccountMgr
  *  
@@ -86,7 +87,7 @@ ModestAccountMgr*        modest_account_mgr_new            (ModestConf *modest_c
 /**
  * modest_account_mgr_add_account:
  * @self: a ModestAccountMgr instance
- * @name: the name of the account to create
+ * @name: name (id) of the account, which is a valid UTF8 string that does not contain '/'
  * @store_name: the store account (ie. POP/IMAP)
  * @transport_name: the transport account (ie. sendmail/SMTP)
  * @err: a GError ptr, or NULL to ignore.
@@ -106,7 +107,7 @@ gboolean        modest_account_mgr_add_account    (ModestAccountMgr *self,
 /**
  * modest_account_mgr_add_server_account:
  * @self: a ModestAccountMgr instance
- * @name: name (id) of the account
+ * @name: name (id) of the account, which is a valid UTF8 string that does not contain '/'
  * @hostname: the hostname
  * @username: the username
  * @password: the password
@@ -122,13 +123,31 @@ gboolean modest_account_mgr_add_server_account    (ModestAccountMgr *self,
                                                   const gchar *hostname,
                                                   const gchar *username,
                                                   const gchar *password,
-                                                  const gchar *proto);  
+                                                  ModestProtocol proto);  
+
+
+/**
+ * modest_account_mgr_add_server_account_uri:
+ * @self: a ModestAccountMgr instance
+ * @name: name (id) of the account, which is a valid UTF8 string that does not contain '/'
+ * @proto:    the protocol (imap, smtp, ...) used for this account
+ * @uri: the URI
+ * 
+ * add a server account to the configuration, based on the account-URI
+ * 
+ * Returns: TRUE if succeeded, FALSE otherwise,
+ */
+gboolean modest_account_mgr_add_server_account_uri    (ModestAccountMgr *self,
+                                                      const gchar *name,
+                                                      ModestProtocol proto,
+                                                      const gchar* uri);
 
 /**
  * modest_account_mgr_remove_account:
  * @self: a ModestAccountMgr instance
  * @name: the name of the account to remove
- * @err: a GError ptr, or NULL to ignore.
+ * @server_account: TRUE if the account to remove is a server account
+ * @err: a #GError ptr, or NULL to ignore.
  * 
  * remove an existing account. the account with @name should already exist
  *
@@ -169,10 +188,9 @@ GSList*            modest_account_mgr_account_names    (ModestAccountMgr *self, GEr
  * 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,
-                                                    ModestProtoType type,
-                                                    const gchar*    proto,
-                                                    gboolean only_enabled);
+                                                    const gchar*       account_name,
+                                                    ModestProtocolType type,
+                                                    ModestProtocol     proto);
 
 /**
  * modest_account_mgr_account_exists:
@@ -193,35 +211,6 @@ gboolean   modest_account_mgr_account_exists         (ModestAccountMgr *self,
 
 
 /**
- * modest_account_mgr_account_set_enabled
- * @self: a ModestAccountMgr instance
- * @name: the account name 
- * @server_account: if TRUE, this is a server account
- * @enabled: if TRUE, the account will be enabled, if FALSE, it will be disabled
- * 
- * enable/disabled an account
- *
- * Returns: TRUE if it worked, FALSE otherwise
- */
-gboolean modest_account_mgr_set_account_enabled (ModestAccountMgr *self, const gchar* name,
-                                                gboolean is_server_account, gboolean enabled);
-
-
-/**
- * modest_account_mgr_account_get_enabled:
- * @self: a ModestAccountMgr instance
- * @name: the account name to check
- * @server_account: if TRUE, this is a server account
- *
- * check whether a certain account is enabled
- *
- * Returns: TRUE if it is enabled, FALSE otherwise
- */
-gboolean modest_account_mgr_account_get_enabled (ModestAccountMgr *self, const gchar* name,
-                                                gboolean is_server_account);
-
-
-/**
  * modest_account_mgr_get_account_string:
  * @self: self a ModestAccountMgr instance
  * @name: the name of the account
@@ -240,7 +229,6 @@ gchar*              modest_account_mgr_get_string     (ModestAccountMgr *self,
                                                   gboolean server_account,
                                                   GError **err);
 
-
 /**
  * modest_account_mgr_get_account_int:
  * @self: a ModestAccountMgr instance
@@ -282,6 +270,27 @@ gboolean   modest_account_mgr_get_bool       (ModestAccountMgr *self,
                                                   GError **err);
 
 /**
+ * modest_account_mgr_get_list:
+ * @self: a ModestAccountMgr instance
+ * @name: the name of the account
+ * @key: the key of the value to get
+ * @list_type: the type of the members of the list
+ * @server_account: if TRUE, this is a server account
+ * @err: a GError ptr, or NULL to ignore.
+ * 
+ * get a config list of values of type @list_type of an account
+ *
+ * Returns: a newly allocated list of elements
+ * @err gives details in case of error
+ */
+GSList*                modest_account_mgr_get_list       (ModestAccountMgr *self,
+                                                  const gchar *name,
+                                                  const gchar *key,
+                                                  ModestConfValueType list_type,
+                                                  gboolean server_account,
+                                                  GError **err);
+
+/**
  * modest_account_mgr_set_account_string:
  * @self: a ModestAccountMgr instance
  * @name: the name of the account
@@ -290,7 +299,7 @@ gboolean    modest_account_mgr_get_bool       (ModestAccountMgr *self,
  * @server_account: if TRUE, this is a server account
  * @err: a GError ptr, or NULL to ignore.
  * 
- * set a config string for an account
+ * set a config string for an account.
  *
  * Returns: TRUE if setting the value succeeded, or FALSE in case of error.
  * @err gives details in case of error
@@ -342,6 +351,46 @@ gboolean   modest_account_mgr_set_bool       (ModestAccountMgr *self,
                                                   gboolean server_account,
                                                   GError **err);
 
+/**
+ * modest_account_mgr_set_list:
+ * @self: a ModestAccountMgr instance
+ * @name: the name of the account
+ * @key: the key of the value to set
+ * @val: the list with the values to set
+ * @list_type: the type of the members of the list
+ * @server_account: if TRUE, this is a server account
+ * @err: a GError ptr, or NULL to ignore.
+ * 
+ * set a config list of values of type @list_type of an account
+ * @err gives details in case of error
+ */
+void           modest_account_mgr_set_list       (ModestAccountMgr *self,
+                                                  const gchar *name,
+                                                  const gchar *key,
+                                                  GSList *val,
+                                                  ModestConfValueType list_type,
+                                                  gboolean server_account,
+                                                  GError **err);
+
+/**
+ * modest_account_mgr_unset:
+ * @self: a ModestAccountMgr instance
+ * @name: the name of the account
+ * @key: the key of the value to unset
+ * @server_account: if TRUE, this is a server account
+ * @err: a GError ptr, or NULL to ignore.
+ * 
+ * unsets the config value of an account and all their children keys
+ *
+ * Returns: TRUE if unsetting the value succeeded, or FALSE in case of error.
+ * @err gives details in case of error
+ */
+gboolean        modest_account_mgr_unset           (ModestAccountMgr *self,
+                                                  const gchar *name,
+                                                  const gchar *key,
+                                                  gboolean server_account,
+                                                  GError **err);
+
 G_END_DECLS
 
 #endif /* __MODEST_ACCOUNT_MGR_H__ */