typedef struct _ModestAccountMgr ModestAccountMgr;
typedef struct _ModestAccountMgrClass ModestAccountMgrClass;
-
struct _ModestAccountMgr {
GObject parent;
};
* @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.
+ * @enabled: Whether the account should be enabled initially.
*
- * create a new account. the account with @name should not already exist
+ * Create a new account. The account with @name should not already exist. The @name will
+ * be used as the initial display name of the new account.
*
* Returns: TRUE if the creation succeeded, FALSE otherwise,
- * @err gives details in case of error
*/
gboolean modest_account_mgr_add_account (ModestAccountMgr *self,
const gchar* name,
const gchar* store_name,
const gchar* transport_name,
- GError **err);
-
+ gboolean enabled);
/**
* modest_account_mgr_add_server_account:
* @self: a ModestAccountMgr instance
* @name: name (id) of the account, which is a valid UTF8 string that does not contain '/'
* @hostname: the hostname
+ * @portnumber: the portnumber, or 0 for default
* @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
gboolean modest_account_mgr_add_server_account (ModestAccountMgr *self,
const gchar *name,
const gchar *hostname,
+ const guint portnumber,
const gchar *username,
const gchar *password,
- ModestProtocol proto);
+ ModestTransportStoreProtocol proto,
+ ModestConnectionProtocol security,
+ ModestAuthProtocol 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,
+ ModestTransportStoreProtocol proto,
+ const gchar* uri);
/**
* modest_account_mgr_remove_account:
* @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
+ * remove an existing account. the account with @name should already exist; note
+ * that when deleting an account, also the corresponding server accounts will
+ * be deleted
*
* Returns: TRUE if the creation succeeded, FALSE otherwise,
* @err gives details in case of error
*/
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.
+ * @only_enabled: Whether only enabled accounts should be returned.
*
* 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
+ * if there are no accounts. The caller must free the returned GSList.
+ *
+ * TODO: I believe that the caller must free the strings in the GSList items too,
+ * because this is implemented via gconf_client_all_dirs() which also requires a deep free,
+ * though that's not documented. murrayc.
*/
-GSList* modest_account_mgr_account_names (ModestAccountMgr *self, GError **err);
-
+GSList* modest_account_mgr_account_names (ModestAccountMgr *self,
+ gboolean only_enabled);
+#if 0
+/* Not used. */
/**
- * modest_account_mgr_server_account_names:
+ * modest_account_mgr_search_server_account:
* @self: a ModestAccountMgr instance
* @account_name: get only server accounts for @account_name, or NULL for any
- * @type: get only server accounts from protocol type @type, or MODEST_PROTO_TYPE_ANY
- * @proto: get only server account with protocol @proto, or NULL for any
- * @only_enabled: get only enabled server accounts if TRUE
+ * @type: get only server accounts from protocol type @type, or MODEST_PROTOCOL_TYPE_UNKNOWN
+ * @proto: get only server account with protocol @proto, or MODEST_PROTOCOL_TRANSPORT_STORE_UNKNOWN for any
*
- * list all the server account names
+ * List all the server account names, optionally narrowing the result down to one account.
*
* Returns: a newly allocated list of server account names, or NULL in case of
* 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,
ModestProtocolType type,
- ModestProtocol proto);
+ ModestTransportStoreProtocol proto);
+#endif
/**
* 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
+ * check whether account @name exists. Note that this does not check the display name.
*
* 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_exists:
+ * @self: a ModestAccountMgr instance
+ * @name: the account name to check
+ *
+ * check whether a non-server account with the @display_name exists.
+ *
+ * Returns: TRUE if the account with name @name exists, FALSE otherwise (or in case of error)
+ */
+gboolean modest_account_mgr_account_with_display_name_exists (ModestAccountMgr *self,
+ const gchar *display_name);
/**
- * modest_account_mgr_get_account_string:
+ * 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
- * @err: a GError ptr, or NULL to ignore.
*
* get a config string 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);
+ gboolean server_account);
+
/**
- * modest_account_mgr_get_account_int:
+ * 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
+ *
+ * get a password from an account
+ *
+ * Returns: a newly allocated string with the value for the key,
+ * or NULL in case of error.
+ */
+gchar* modest_account_mgr_get_password (ModestAccountMgr *self,
+ const gchar *name,
+ const gchar *key,
+ gboolean server_account);
+
+/**
+ * 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_get_list:
* @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);
+ gboolean server_account);
/**
- * modest_account_mgr_set_account_string:
+ * 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.
*
* 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:
* @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
*
- * set a config list of values of type @list_type of an account
- * @err gives details in case of error
+ * returns TRUE if this succeeded, FALSE otherwise
*/
-void modest_account_mgr_set_list (ModestAccountMgr *self,
- const gchar *name,
- const gchar *key,
- GSList *val,
- ModestConfValueType list_type,
- gboolean server_account,
- GError **err);
+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:
* @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);
+ const gchar *name,
+ const gchar *key,
+ gboolean server_account);
G_END_DECLS
projects / modest / blobdiff