* Removed the ModestTnyAttachment stuff
[modest] / src / modest-account-mgr.h
index 03c63d4..303a90c 100644 (file)
@@ -112,7 +112,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.
@@ -132,7 +132,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
@@ -154,7 +154,8 @@ gboolean modest_account_mgr_add_server_account    (ModestAccountMgr *self,
  * 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
  *
@@ -327,6 +328,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
@@ -335,7 +357,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
@@ -387,7 +409,45 @@ 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