X-Git-Url: http://git.maemo.org/git/?a=blobdiff_plain;f=src%2Fmodest-mail-operation.h;h=46990ad1e881e5534fd04fc3b041a2e953fead6f;hb=fbd3de685de73916335501db19c4c1443fc7333d;hp=4c60822277cdf150d997e3dcedfc606f14c18f82;hpb=39831f5c98fa2ec22d0151f52e52cf49ed81e8d0;p=modest diff --git a/src/modest-mail-operation.h b/src/modest-mail-operation.h index 4c60822..46990ad 100644 --- a/src/modest-mail-operation.h +++ b/src/modest-mail-operation.h @@ -111,7 +111,9 @@ typedef void (*ErrorCheckingUserDataDestroyer) (gpointer user_data); */ typedef void (*GetMsgAsyncUserCallback) (ModestMailOperation *mail_op, TnyHeader *header, + gboolean canceled, TnyMsg *msg, + GError *err, gpointer user_data); /** @@ -127,16 +129,34 @@ typedef void (*GetMimePartSizeCallback) (ModestMailOperation *mail_op, gpointer user_data); /** - * XferAsyncUserCallback: + * XferMsgsAsyncUserCallback: * * @obj: a #GObject generic object which has created current mail operation. + * @new_folder: the new instance of the #TnyFolder that has been transferred * @user_data: generic data passed to user defined function. * * This function will be called after transfer_msgs_cb private function, which is * used as tinymail operation callback. The private function fills private * fields of mail operation and calls user defined callback if it exists. */ -typedef void (*XferAsyncUserCallback) (ModestMailOperation *mail_op, gpointer user_data); +typedef void (*XferMsgsAsyncUserCallback) (ModestMailOperation *mail_op, + gpointer user_data); + + +/** + * XferFolderAsyncUserCallback: + * + * @obj: a #GObject generic object which has created current mail operation. + * @new_folder: the new instance of the #TnyFolder that has been transferred + * @user_data: generic data passed to user defined function. + * + * This function will be called after transfer_msgs_cb private function, which is + * used as tinymail operation callback. The private function fills private + * fields of mail operation and calls user defined callback if it exists. + */ +typedef void (*XferFolderAsyncUserCallback) (ModestMailOperation *mail_op, + TnyFolder *new_folder, + gpointer user_data); /** @@ -169,7 +189,6 @@ typedef void (*UpdateAccountCallback) (ModestMailOperation *self, TnyList *new_headers, gpointer user_data); - /** * SaveToDraftsCallback: * @@ -185,6 +204,26 @@ typedef void (*SaveToDraftstCallback) (ModestMailOperation *self, gpointer user_data); +typedef gboolean (*RetrieveAllCallback) (GObject *source, + guint num_msgs, + guint limit); + +/** + * CreateFolderUserCallback: + * + * @mail_op: the current #ModestMailOperation. + * @folder: a #TnyFolder summary item. + * @user_data: generic data passed to user defined function. + * + * This function will be called after get_msg_cb private function, which is + * used as tinymail operation callback. The private function fills private + * fields of mail operation and calls user defined callback if it exists. + */ +typedef void (*CreateFolderUserCallback) (ModestMailOperation *mail_op, + TnyFolderStore *parent_folder, + TnyFolder *new_folder, + gpointer user_data); + /* This struct represents the internal state of a mail operation in a given time */ typedef struct { @@ -380,6 +419,7 @@ void modest_mail_operation_save_to_drafts (ModestMailOperation *self, * modest_mail_operation_update_account: * @self: a #ModestMailOperation * @account_name: the id of a Modest account + * @poke_all: if TRUE it will also do a poke_status over all folders of the account * * Asynchronously refreshes the root folders of the given store * account. The caller should add the #ModestMailOperation to a @@ -400,10 +440,11 @@ void modest_mail_operation_save_to_drafts (ModestMailOperation *self, * Note that the account_name *MUST* be a modest account name, not a * tinymail store account name * - * Returns: TRUE if the mail operation could be started, or FALSE otherwise **/ -gboolean modest_mail_operation_update_account (ModestMailOperation *self, +void modest_mail_operation_update_account (ModestMailOperation *self, const gchar *account_name, + gboolean poke_all, + RetrieveAllCallback retrieve_all_cb, UpdateAccountCallback callback, gpointer user_data); @@ -423,9 +464,11 @@ gboolean modest_mail_operation_update_account (ModestMailOperation *self, * * Returns: a newly created #TnyFolder or NULL in case of error. **/ -TnyFolder* modest_mail_operation_create_folder (ModestMailOperation *self, - TnyFolderStore *parent, - const gchar *name); +void modest_mail_operation_create_folder (ModestMailOperation *self, + TnyFolderStore *parent, + const gchar *name, + CreateFolderUserCallback callback, + gpointer user_data); /** * modest_mail_operation_remove_folder: @@ -454,7 +497,9 @@ void modest_mail_operation_remove_folder (ModestMailOperation *self, **/ void modest_mail_operation_rename_folder (ModestMailOperation *self, TnyFolder *folder, - const gchar *name); + const gchar *name, + XferFolderAsyncUserCallback user_callback, + gpointer user_data); /** * modest_mail_operation_xfer_folder: @@ -462,7 +507,7 @@ void modest_mail_operation_rename_folder (ModestMailOperation *self, * @folder: a #TnyFolder * @parent: the new parent of the folder as #TnyFolderStore * @delete_original: wheter or not delete the original folder - * @user_callback: a #XferAsyncUserCallback function to call after tinymail callback execution. + * @user_callback: a #XferFolderAsyncUserCallback function to call after tinymail callback execution. * @user_data: generic user data which will be passed to @user_callback function. * * Sets the given @folder as child of a provided #TnyFolderStore. This @@ -479,7 +524,7 @@ void modest_mail_operation_xfer_folder (ModestMailOperation *self, TnyFolder *folder, TnyFolderStore *parent, gboolean delete_original, - XferAsyncUserCallback user_callback, + XferFolderAsyncUserCallback user_callback, gpointer user_data); @@ -491,7 +536,7 @@ void modest_mail_operation_xfer_folder (ModestMailOperation *self, * @header_list: a #TnyList of #TnyHeader to transfer * @folder: the #TnyFolder where the messages will be transferred * @delete_original: whether or not delete the source messages - * @user_callback: a #XferAsyncUserCallback function to call after tinymail callback execution. + * @user_callback: a #XferFolderAsyncUserCallback function to call after tinymail callback execution. * @user_data: generic user data which will be passed to @user_callback function. * * Asynchronously transfers messages from their current folder to @@ -519,7 +564,7 @@ void modest_mail_operation_xfer_msgs (ModestMailOperation *self, TnyList *header_list, TnyFolder *folder, gboolean delete_original, - XferAsyncUserCallback user_callback, + XferMsgsAsyncUserCallback user_callback, gpointer user_data); /** @@ -671,8 +716,38 @@ void modest_mail_operation_refresh_folder (ModestMailOperation *self, RefreshAsyncUserCallback user_callback, gpointer user_data); +/** + * modest_mail_operation_get_account: + * @self: a #ModestMailOperation + * + * Gets the account associated to a mail operation + * + * Returns: the #TnyAccount associated to the #ModestMailOperation + **/ TnyAccount *modest_mail_operation_get_account (ModestMailOperation *self); + +/** + * modest_mail_operation_noop: + * @self: a #ModestMailOperation + * + * Does nothing except emitting operation-started and + * operation-finished + **/ +void modest_mail_operation_noop (ModestMailOperation *self); + + +/** + * modest_mail_operation_to_string: + * @self: a #ModestMailOperation + * + * get a string representation of the mail operation (for debugging) + * + * Returns: a newly allocated string + **/ +gchar* modest_mail_operation_to_string (ModestMailOperation *self); + + G_END_DECLS #endif /* __MODEST_MAIL_OPERATION_H__ */