* check for a valid foldername
[modest] / src / modest-account-mgr-helpers.h
index ca4d7c9..5143220 100644 (file)
@@ -44,11 +44,13 @@ typedef struct {
        gchar            *account_name;
        gchar            *hostname;
        gchar            *username;
-       gchar            *uri;
-       ModestProtocol    proto; /*< The store or transport. Not ORed. */
+       gchar            *uri; /*< Only for mbox and maildir accounts. */
+       ModestTransportStoreProtocol    proto; /*< The store or transport. Not ORed. */
        gchar            *password;
        time_t            last_updated;
-       GSList           *options;
+       gint              port; /* Or 0, if the default should be used. */
+       ModestAuthProtocol   secure_auth;
+       ModestConnectionProtocol   security;
 } ModestServerAccountData;
 
 typedef struct {
@@ -91,7 +93,7 @@ ModestAccountData *modest_account_mgr_get_account_data     (ModestAccountMgr *se
 gchar* modest_account_mgr_get_default_account  (ModestAccountMgr *self);
 
 /**
- * modest_account_mgr_get_default_account:
+ * modest_account_mgr_set_default_account:
  * @self: a ModestAccountMgr instance
  * @account: the name of an existing account
  * 
@@ -103,6 +105,34 @@ gboolean modest_account_mgr_set_default_account  (ModestAccountMgr *self,
                                                  const gchar* account);
 
 /**
+ * modest_account_mgr_unset_default_account:
+ * @self: a ModestAccountMgr instance
+ * @account: the name of an account
+ * 
+ * Unset the default account name, so that no account is the default.
+ *
+ * Returns: TRUE if succeeded, FALSE otherwise
+ */
+gboolean modest_account_mgr_unset_default_account  (ModestAccountMgr *self);
+
+/**
+ * modest_account_mgr_set_first_account_as_default:
+ * @self: a ModestAccountMgr instance
+ * 
+ * Guarantees that at least one account, if there are any accounts, is the default,
+ * so that modest_account_mgr_get_default_account() will return non-NULL if there 
+ * are any accounts.
+ *
+ * Returns: TRUE if succeeded, FALSE otherwise
+ */
+gboolean
+modest_account_mgr_set_first_account_as_default  (ModestAccountMgr *self);
+
+/** Get the first one, alphabetically, by title. */
+gchar* 
+modest_account_mgr_get_first_account_name (ModestAccountMgr *self);
+
+/**
  * modest_account_mgr_free_account_data:
  * @self: a ModestAccountMgr instance
  * @data: a ModestAccountData instance
@@ -137,80 +167,253 @@ gboolean modest_account_mgr_set_enabled (ModestAccountMgr *self, const gchar* na
 gboolean modest_account_mgr_get_enabled (ModestAccountMgr *self, const gchar* name);
 
 /**
- * modest_server_account_data_get_option_secure_auth:
- * @account_data: a ModestAccountData instance.
+ * modest_account_mgr_get_display_name:
+ * @self: a ModestAccountMgr instance
+ * @name: the account name to check
  *
- * Gets the secure authentication method for this server account.
+ * Return the human-readable account title for this account, or NULL.
+ */
+gchar* modest_account_mgr_get_display_name (ModestAccountMgr *self, 
+       const gchar* name);
+
+
+/**
+ * modest_account_mgr_set_signature
+ * @self: a ModestAccountMgr instance
+ * @name: the account name to check
+ * @signature: the signature text 
+ * @use_signature: Whether the signature should be used.
+ * 
+ * Sets the signature text for the account.
  *
- * Returns: The secure authentication enum value.
+ * Returns: TRUE if it worked, FALSE otherwise
  */
-ModestProtocol
-modest_server_account_data_get_option_secure_auth (ModestServerAccountData *account_data);
+gboolean modest_account_mgr_set_signature (ModestAccountMgr *self, const gchar* name, 
+       const gchar* signature, gboolean use_signature);
 
 /**
- * modest_server_account_data_get_option_secure_auth:
+ * modest_account_mgr_get_signature:
  * @self: a ModestAccountMgr instance
- * @secure_auth: The secure authentication enum value.
+ * @name: the account name
+ * @use_signature: Pointer to a gboolean taht will be set to TRUE if the signature should be used.
  *
- * Gets the secure authentication method for this server account.
+ * Gets the signature text for this account.
+ *
+ * Returns: The signature text, which should be freed with g_free().
  */
-void
-modest_server_account_set_option_secure_auth (ModestAccountMgr *self, const gchar* account_name, 
-       ModestProtocol secure_auth);
+gchar* modest_account_mgr_get_signature (ModestAccountMgr *self, const gchar* name, 
+       gboolean* use_signature);
        
 /**
- * modest_server_account_data_get_option_security:
- * @account_data: a ModestAccountData instance.
+ * modest_account_mgr_get_store_protocol:
+ * @self: a ModestAccountMgr instance
+ * @name: the account name
  *
- * Gets the security method for this server account.
+ * Gets the protocol type (For instance, POP or IMAP) used for the store server account.
  *
- * Returns: The security enum value.
+ * Returns: The protocol type.
  */
-ModestProtocol
-modest_server_account_data_get_option_security (ModestServerAccountData *account_data);
+ModestTransportStoreProtocol modest_account_mgr_get_store_protocol (ModestAccountMgr *self, const gchar* name);
 
 /**
- * modest_server_account_set_option_security:
+ * modest_account_mgr_set_connection_specific_smtp
  * @self: a ModestAccountMgr instance
- * @secure_auth: The security enum value.
+ * @name: the account name
+ * @connection_name: A libconic IAP connection name
+ * @server_account_name: a server account name to use for this connection.
+ * 
+ * Specify a server account to use with the specific connection for this account.
  *
- * Gets the security method for this server account.
+ * Returns: TRUE if it worked, FALSE otherwise
+ */
+gboolean modest_account_mgr_set_connection_specific_smtp (ModestAccountMgr *self, const gchar* name,
+                                        const gchar* connection_name, const gchar* server_account_name);
+
+/**
+ * modest_account_mgr_remove_connection_specific_smtp
+ * @self: a ModestAccountMgr instance
+ * @name: the account name
+ * @connection_name: A libconic IAP connection name
+ * 
+ * Disassacoiate a server account to use with the specific connection for this account.
+ *
+ * Returns: TRUE if it worked, FALSE otherwise
+ */                             
+gboolean modest_account_mgr_remove_connection_specific_smtp (ModestAccountMgr *self, const gchar* name,
+                                        const gchar* connection_name);
+
+/**
+ * modest_account_mgr_get_has_connection_specific_smtp
+ * @self: a ModestAccountMgr instance
+ * @name: the account name
+ * @result: Whether this account uses any connection-specific smtp server accounts.
+ */    
+gboolean modest_account_mgr_get_has_connection_specific_smtp (ModestAccountMgr *self, const gchar* account_name);
+
+/**
+ * modest_account_mgr_get_connection_specific_smtp
+ * @self: a ModestAccountMgr instance
+ * @name: the account name
+ * @connection_name: A libconic IAP connection name
+ * 
+ * Retrieve a server account to use with this specific connection for this account.
+ *
+ * Returns: a server account name to use for this connection, or NULL if none is specified.
+ */                     
+gchar* modest_account_mgr_get_connection_specific_smtp (ModestAccountMgr *self, const gchar* name,
+                                        const gchar* connection_name);
+
+
+/**
+ * modest_server_account_get_username:
+ * @self: a ModestAccountMgr instance
+ * @account_name: The name of a server account.
+ *
+ * Gets the username this server account.
+ *
+ * Returns: The username.
+ */
+gchar*
+modest_server_account_get_username (ModestAccountMgr *self, const gchar* account_name);
+
+/**
+ * modest_server_account_set_username:
+ * @self: a ModestAccountMgr instance
+ * @account_name: The name of a server account.
+ * @username: The new username.
+ *
+ * Sets the username this server account.
  */
 void
-modest_server_account_set_option_security (ModestAccountMgr *self, const gchar* account_name, 
-       ModestProtocol security);
+modest_server_account_set_username (ModestAccountMgr *self, const gchar* account_name, 
+       const gchar* username);
 
 /**
- * modest_account_mgr_get_account_option:
+ * modest_server_account_get_username_has_succeeded:
  * @self: a ModestAccountMgr instance
- * @account_name: the account name to check
- * @account_name: the option name to check
+ * @account_name: The name of a server account.
+ *
+ * Whether a connection has ever been successfully made to this account with 
+ * the current username. This can be used to avoid asking again for the username 
+ * when asking a second time for a non-stored password.
  *
- * Returns: The account option value. This must be freed with g_free().
+ * Returns: TRUE if the username is known to be correct.
  */
-gchar* modest_account_mgr_get_server_account_option (ModestAccountMgr *self, 
-       const gchar* account_name, const gchar* option_name);
+gboolean
+modest_server_account_get_username_has_succeeded (ModestAccountMgr *self, const gchar* account_name);
 
 /**
- * modest_server_account_data_get_option_value:
- * @options_list: a ModestServerAccountData::options list.
- * @option_name: the option name to check
+ * modest_server_account_set_username_has_succeeded:
+ * @self: a ModestAccountMgr instance
+ * @account_name: The name of a server account.
+ * @succeeded: Whether the username has succeeded
+ *
+ * Sets whether the username is known to be correct.
+ */
+void
+modest_server_account_set_username_has_succeeded (ModestAccountMgr *self, const gchar* account_name, 
+       gboolean succeeded);
+       
+/**
+ * modest_server_account_set_password:
+ * @self: a ModestAccountMgr instance
+ * @account_name: The name of a server account.
+ * @password: The new password.
+ *
+ * Sets the password for this server account.
+ */
+void
+modest_server_account_set_password (ModestAccountMgr *self, const gchar* account_name, 
+       const gchar* password);
+       
+/**
+ * modest_server_account_get_password:
+ * @self: a ModestAccountMgr instance
+ * @account_name: The name of a server account.
  *
- * Returns: The account option value. This must be freed with g_free().
+ * Gets the password for this server account from the account settings.
  */
-gchar* modest_server_account_data_get_option_value (GSList* options_list, const gchar* option_name);
+gchar*
+modest_server_account_get_password (ModestAccountMgr *self, const gchar* account_name);
 
 /**
- * modest_server_account_data_get_option_bool:
- * @options_list: a ModestServerAccountData::options list.
- * @option_name: the option name to check
+ * modest_server_account_get_has_password:
+ * @self: a ModestAccountMgr instance
+ * @account_name: The name of a server account.
  *
- * Returns: Whether the account option is present.
+ * Gets whether a password has been set for this server account in the account settings.
  */
-gboolean modest_server_account_data_get_option_bool (GSList* options_list, const gchar* option_name);
+gboolean
+modest_server_account_get_has_password (ModestAccountMgr *self, const gchar* account_name);     
+
+/**
+ * modest_server_account_modest_server_account_get_hostnameget_username:
+ * @self: a ModestAccountMgr instance
+ * @account_name: The name of a server account.
+ *
+ * Gets the hostname this server account.
+ *
+ * Returns: The hostname.
+ */
+gchar*
+modest_server_account_get_hostname (ModestAccountMgr *self, const gchar* account_name);
 
 
 /**
+ * modest_server_account_get_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.
+ */
+ModestAuthProtocol
+modest_server_account_get_secure_auth (ModestAccountMgr *self, const gchar* account_name);
+
+/**
+ * modest_server_account_data_get_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_secure_auth (ModestAccountMgr *self, const gchar* account_name, 
+                                      ModestAuthProtocol secure_auth);
+       
+/**
+ * modest_server_account_data_get_security:
+ * @self: a ModestAccountMgr instance
+ * @account_name: The name of a server account.
+ *
+ * Gets the security method for this server account.
+ *
+ * Returns: The security enum value.
+ */
+ModestConnectionProtocol
+modest_server_account_get_security (ModestAccountMgr *self, const gchar* account_name);
+
+/**
+ * modest_server_account_set_security:
+ * @self: a ModestAccountMgr instance
+ * @secure_auth: The security enum value.
+ *
+ * Gets the security method for this server account.
+ */
+void
+modest_server_account_set_security (ModestAccountMgr *self, const gchar* account_name, 
+                                   ModestConnectionProtocol security);
+
+ModestServerAccountData*
+modest_account_mgr_get_server_account_data (ModestAccountMgr *self, const gchar* name);
+
+void
+modest_account_mgr_free_server_account_data (ModestAccountMgr *self,
+                                            ModestServerAccountData* data);
+
+/**
  * modest_account_mgr_get_from_string
  * @self: a #ModestAccountMgr instance
  * @name: the account name
@@ -222,6 +425,31 @@ gboolean modest_server_account_data_get_option_bool (GSList* options_list, const
 gchar * modest_account_mgr_get_from_string (ModestAccountMgr *self, const gchar* name);
 
 
+/**
+ * modest_account_mgr_get_unused_account_name
+ * @self: a #ModestAccountMgr instance
+ * @name: The initial account name
+ *
+ * get an unused account name, based on a starting string.
+ *
+ * Returns: the newly allocated name.
+ */
+gchar*
+modest_account_mgr_get_unused_account_name (ModestAccountMgr *self, const gchar* starting_name,
+       gboolean server_account);
+
+/**
+ * modest_account_mgr_get_unused_account_display name
+ * @self: a #ModestAccountMgr instance
+ * @name: The initial account display name
+ *
+ * get an unused account display name, based on a starting string.
+ *
+ * Returns: the newly allocated name.
+ */
+gchar*
+modest_account_mgr_get_unused_account_display_name (ModestAccountMgr *self, const gchar* starting_name);
+
 G_END_DECLS
 
 #endif /* __MODEST_ACCOUNT_MGR_H__ */