X-Git-Url: http://git.maemo.org/git/?p=modest;a=blobdiff_plain;f=src%2Fmodest-tny-account.h;h=75f67ea00f09af4a4e78d4c04f1b8bbbd7052b33;hp=e81e652f340661a06584bb2b6aa8cb81235de202;hb=4d39841513a3a7f7aa9d38ab97cb9fcc9171e80b;hpb=c5cb3d7892935854bca8d869ca0ee8f3305b457b diff --git a/src/modest-tny-account.h b/src/modest-tny-account.h index e81e652..75f67ea 100644 --- a/src/modest-tny-account.h +++ b/src/modest-tny-account.h @@ -42,17 +42,23 @@ G_BEGIN_DECLS +typedef struct +{ + guint local_size; + guint msg_count; + guint folders; +} ModestFolderStats; + /** * modest_tny_account_new_from_account: * @account_mgr: a valid account mgr instance - * @account_name: the account name for which to create a corresponding tny account + * @account_name: the modest account name for which to create a corresponding tny account of the given type. * @type: the type of account to create (TNY_ACCOUNT_TYPE_STORE or TNY_ACCOUNT_TYPE_TRANSPORT) * @session: a tny camel session * @get_pass_func: the get-password function * @forget_pass_func: the forget-password function * * get a tnyaccount corresponding to the server_accounts (store or transport) for this account. - * NOTE: this function does not set the camel session or the get/forget password functions * * Returns: a new TnyAccount or NULL in case of error. */ @@ -65,64 +71,154 @@ modest_tny_account_new_from_account (ModestAccountMgr *account_mgr, const gchar /** + * modest_tny_account_update_from_account: + * @tny_account: a valid tny_account + * + * update a tnyaccount corresponding to the server_accounts (store or transport) for this account. + * + * Returns: a TRUE or FALSE in case of error. + */ +gboolean +modest_tny_account_update_from_account (TnyAccount *tny_account, + TnyGetPassFunc get_pass_func, + TnyForgetPassFunc forget_pass_func); + + +/** * modest_tny_account_new_for_local_folders: * @account_mgr: a valid account mgr instance * @session: a tny camel session + * @location_filepath: The location at which the local-folders directory exists, or NULL to specify $HOME. * * get the local folders (pseudo) account; you should only need one such account. * * Returns: a new local folders TnyAccount or NULL in case of error. */ TnyAccount* modest_tny_account_new_for_local_folders (ModestAccountMgr *account_mgr, - TnySessionCamel *session); + TnySessionCamel *session, + const gchar* location_filepath); + +/** + * modest_tny_account_new_for_per_account_local_outbox_folder: + * @account_mgr: a valid account mgr instance + * @account_name: a modest account name. + * @session: a tny camel session + * + * get the per-account local outbox folder (pseudo) account. + * + * Returns: a new per-account local outbox folder TnyAccount or NULL in case of error. + */ +TnyAccount* modest_tny_account_new_for_per_account_local_outbox_folder ( + ModestAccountMgr *account_mgr, const gchar* account_name, + TnySessionCamel *session); + +/** + * modest_tny_account_new_from_server_account_name: + * @account_mgr: a valid account mgr instance + * @session: a valid TnySessionCamel instance. + * @server_account_name: the name of a server account in the configuration system. + * + * Returns: a new TnyAccount or NULL in case of error. + */ +TnyAccount* +modest_tny_account_new_from_server_account_name (ModestAccountMgr *account_mgr, + TnySessionCamel *session, + const gchar* server_account_name, + TnyGetPassFunc get_pass_func, + TnyForgetPassFunc forget_pass_func); /** * modest_tny_account_get_special_folder: * @self: a TnyAccount * @special_type: the special folder to get * - * get the special (Inbox,Outbox,Sent,Draft etc.) folder for this account + * get the special (Inbox,Outbox,Sent,Draft etc.) folder for this server account's parent modest account. * Note: currently, the implementation will always return a local folder for this. * This can be changed later to return really account-specific special folders, * such as (for example) server-side Sent/Junk mail for IMAP accounts * * Returns: the tny folder corresponding to this special folder, or NULL in case - * of error, or if the special folder does not exist for this account + * of error, or if the special folder does not exist for this account. + * This must be unrefed with g_object_unref(). */ TnyFolder* modest_tny_account_get_special_folder (TnyAccount *self, TnyFolderType special_type); +typedef void (*GetFolderStatsCallback) (ModestFolderStats stats, + gpointer user_data); + /** - * modest_tny_account_get_folder_count: - * @self: a #TnyAccount + * modest_tny_folder_store_get_folder_stats: + * @self: a #TnyFolderStore * - * gets the number of folders of the account - * - * Returns: the number of folder, or -1 in case of error **/ -gint modest_tny_account_get_folder_count (TnyAccount *self); +void +modest_tny_folder_store_get_folder_stats (TnyFolderStore *self, + GetFolderStatsCallback callback, + GetFolderStatsCallback status_callback, + gpointer user_data); /** - * modest_tny_account_get_message_count: - * @self: - * - * gets the number of messages in the account + * modest_tny_folder_store_is_remote: + * @folder_store: The folder store (folder or account) that needs to + * decide if need a connection in subsequent operations. + * @return value: Whether a connection is necessary for this folder_store. + */ +gboolean modest_tny_folder_store_is_remote (TnyFolderStore *self); + +/** modest_tny_account_get_parent_modest_account_name_for_server_account: + * Get the name of the parent modest account of which the server account is a part. + */ +const gchar* modest_tny_account_get_parent_modest_account_name_for_server_account (TnyAccount *self); + +/** modest_tny_account_set_parent_modest_account_name_for_server_account: + * Set the name of the parent modest account of which the server account is a part, + * so it can be retrieved later with + * modest_tny_account_get_parent_modest_account_name_for_server_account(). + */ +void modest_tny_account_set_parent_modest_account_name_for_server_account (TnyAccount *account, const gchar* parent_modest_acount_name); + + +typedef void (*ModestTnyAccountGetMmcAccountNameCallback) (TnyStoreAccount* self, gpointer user_data); + +/** modest_tny_account_get_mmc_account_name: + * Asnchronously get the name of a memory card account and set it in the TnyAccount, + * calling the callback (if not NULL) to notify that the name is changed. + * if the name was changed. The callback will not be called if the name was not changed. + */ +void modest_tny_account_get_mmc_account_name (TnyStoreAccount* self, + ModestTnyAccountGetMmcAccountNameCallback callback, + gpointer user_data); + + +/** modest_tny_account_is_virtual_local_folders: + * @self A TnyAccount. * - * Returns: the number of messages, or -1 in case of error + * A convenience function to identify whether TnyAccount + * is the virtual local folders account, containing the folders from local_folders/ + * and the outboxes from outboxes//. **/ -gint modest_tny_account_get_message_count (TnyAccount *self); +gboolean modest_tny_account_is_virtual_local_folders (TnyAccount *self); -/** - * modest_tny_account_get_local_size: - * @self: +/** modest_tny_account_is_memory_card_account: + * @self A TnyAccount. * - * gets the total size occupied by the account in the local storage - * device - * - * Returns: the total size in bytes, or -1 in case of error + * A convenience function to identify whether TnyAccount + * is the memory card account. **/ -gint modest_tny_account_get_local_size (TnyAccount *self); +gboolean modest_tny_account_is_memory_card_account (TnyAccount *self); + +/** + * modest_tny_account_get_protocol_type: + * @self: a #TnyAccount + * + * obtains the transport/store protocol type of @self + * + * Returns: a #ModestProtocolType + */ +ModestProtocolType modest_tny_account_get_protocol_type (TnyAccount *self); + G_END_DECLS