#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
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
*
/**
* 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.
gboolean modest_account_mgr_add_account (ModestAccountMgr *self,
const gchar* name,
const gchar* store_name,
- const gchar* transport_name,
- GError **err);
-
+ const gchar* transport_name);
/**
* 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
* @proto: the protocol (imap, smtp, ...) used for this account
+ * @security: the security options, (SSL, TLS ...) used to access the server
+ * @auth: the authentication method (password, none ...) used to access the server
*
* add a server account to the configuration.
* the server account with @name should not already exist
const gchar *hostname,
const gchar *username,
const gchar *password,
- const gchar *proto);
+ ModestProtocol proto,
+ ModestProtocol security,
+ ModestProtocol auth);
+
+
+/**
+ * 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
*
*/
gboolean modest_account_mgr_remove_account (ModestAccountMgr *self,
const gchar* name,
- gboolean server_account,
- GError **err);
+ gboolean server_account);
/**
* modest_account_mgr_account_names:
* @self: a ModestAccountMgr instance
- * @err: a GError ptr, or NULL to ignore.
*
* list all account names
*
* Returns: a newly allocated list of account names, or NULL in case of error or
* if there are no accounts. The caller must free the returned GSList
- * @err gives details in case of error
*/
-GSList* modest_account_mgr_account_names (ModestAccountMgr *self, GError **err);
+GSList* modest_account_mgr_account_names (ModestAccountMgr *self);
/**
* 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:
* @self: a ModestAccountMgr instance
* @name: the account name to check
* @server_account: if TRUE, this is a server account
- * @err: a GError ptr, or NULL to ignore.
*
* check whether account @name exists
*
* Returns: TRUE if the account with name @name exists, FALSE otherwise (or in case of error)
- * @err gives details in case of error
*/
gboolean modest_account_mgr_account_exists (ModestAccountMgr *self,
const gchar *name,
- gboolean server_account,
- GError **err);
+ gboolean server_account);
/**
- * modest_account_mgr_account_set_enabled
- * @self: a ModestAccountMgr instance
- * @name: the account name
+ * modest_account_mgr_get_string:
+ * @self: self a ModestAccountMgr instance
+ * @name: the name of the account
+ * @key: the key of the value to retrieve
* @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
+ * get a config string from an account
*
- * Returns: TRUE if it is enabled, FALSE otherwise
+ * Returns: a newly allocated string with the value for the key,
+ * or NULL in case of error.
*/
-gboolean modest_account_mgr_account_get_enabled (ModestAccountMgr *self, const gchar* name,
- gboolean is_server_account);
+gchar* modest_account_mgr_get_string (ModestAccountMgr *self,
+ const gchar *name,
+ const gchar *key,
+ gboolean server_account);
/**
- * modest_account_mgr_get_account_string:
+ * modest_account_mgr_get_password:
* @self: self a ModestAccountMgr instance
* @name: the name of the account
* @key: the key of the value to retrieve
* @server_account: if TRUE, this is a server account
- * @err: a GError ptr, or NULL to ignore.
*
- * get a config string from an account
+ * get a password from an account
*
* Returns: a newly allocated string with the value for the key,
- * or NULL in case of error. @err gives details in case of error
+ * or NULL in case of error.
*/
-gchar* modest_account_mgr_get_string (ModestAccountMgr *self,
- const gchar *name,
- const gchar *key,
- gboolean server_account,
- GError **err);
-
+gchar* modest_account_mgr_get_password (ModestAccountMgr *self,
+ const gchar *name,
+ const gchar *key,
+ gboolean server_account);
/**
- * modest_account_mgr_get_account_int:
+ * modest_account_mgr_get_int:
* @self: a ModestAccountMgr instance
* @name: the name of the account
* @key: the key of the value to retrieve
* @server_account: if TRUE, this is a server account
- * @err: a GError ptr, or NULL to ignore.
*
* get a config int from an account
*
* Returns: an integer with the value for the key, or -1 in case of
* error (but of course -1 does not necessarily imply an error)
- * @err gives details in case of error
*/
gint modest_account_mgr_get_int (ModestAccountMgr *self,
const gchar *name,
const gchar *key,
- gboolean server_account,
- GError **err);
+ gboolean server_account);
/**
- * modest_account_mgr_get_account_bool:
+ * modest_account_mgr_get_bool:
* @self: a ModestAccountMgr instance
* @name: the name of the account
* @key: the key of the value to retrieve
* @server_account: if TRUE, this is a server account
- * @err: a GError ptr, or NULL to ignore.
*
* get a config boolean from an account
*
* Returns: an boolean with the value for the key, or FALSE in case of
* error (but of course FALSE does not necessarily imply an error)
- * @err gives details in case of error
*/
gboolean modest_account_mgr_get_bool (ModestAccountMgr *self,
const gchar *name,
const gchar *key,
- gboolean server_account,
- GError **err);
+ gboolean server_account);
/**
- * modest_account_mgr_set_account_string:
+ * 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
+ *
+ * get a config list of values of type @list_type of an account
+ *
+ * Returns: a newly allocated list of elements
+ */
+GSList* modest_account_mgr_get_list (ModestAccountMgr *self,
+ const gchar *name,
+ const gchar *key,
+ ModestConfValueType list_type,
+ gboolean server_account);
+
+/**
+ * modest_account_mgr_set_string:
* @self: a ModestAccountMgr instance
* @name: the name of the account
* @key: the key of the value to set
* @val: the value to set
* @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
*/
gboolean modest_account_mgr_set_string (ModestAccountMgr *self,
const gchar *name,
const gchar *key, const gchar* val,
- gboolean server_account,
- GError **err);
+ gboolean server_account);
+
/**
- * modest_account_mgr_set_account_int:
+ * modest_account_mgr_set_password:
+ * @self: a ModestAccountMgr instance
+ * @name: the name of the account
+ * @key: the key of the value to set
+ * @val: the value to set
+ * @server_account: if TRUE, this is a server account
+ *
+ * set a password for an account.
+ *
+ * Returns: TRUE if setting the value succeeded, or FALSE in case of error.
+* @err gives details in case of error
+ */
+gboolean modest_account_mgr_set_password (ModestAccountMgr *self,
+ const gchar *name,
+ const gchar *key, const gchar* val,
+ gboolean server_account);
+
+/**
+ * modest_account_mgr_set_int:
* @self: a ModestAccountMgr instance
* @name: the name of the account
* @key: the key of the value to set
* @val: the value to set
* @server_account: if TRUE, this is a server account
- * @err: a GError ptr, or NULL to ignore.
*
* set a config int for an account
*
* Returns: TRUE if setting the value succeeded, or FALSE in case of error.
- * @err gives details in case of error
*/
gboolean modest_account_mgr_set_int (ModestAccountMgr *self,
const gchar *name,
const gchar *key, gint val,
- gboolean server_account,
- GError **err);
-
+ gboolean server_account);
/**
- * modest_account_mgr_set_account_bool:
+ * modest_account_mgr_set_bool:
* @self: a ModestAccountMgr instance
* @name: the name of the account
* @key: the key of the value to set
* @val: the value to set
* @server_account: if TRUE, this is a server account
- * @err: a GError ptr, or NULL to ignore.
*
* set a config bool for an account
*
* Returns: TRUE if setting the value succeeded, or FALSE in case of error.
- * @err gives details in case of error
*/
gboolean modest_account_mgr_set_bool (ModestAccountMgr *self,
const gchar *name,
const gchar *key, gboolean val,
- gboolean server_account,
- GError **err);
+ gboolean server_account);
+
+/**
+ * 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
+ *
+ * * set a config list of values of type @list_type of an account
+ *
+ * returns TRUE if this succeeded, FALSE otherwise
+ */
+gboolean modest_account_mgr_set_list (ModestAccountMgr *self,
+ const gchar *name,
+ const gchar *key,
+ GSList *val,
+ ModestConfValueType list_type,
+ gboolean server_account);
+
+/**
+ * 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);
G_END_DECLS
projects / modest / blobdiff