X-Git-Url: http://git.maemo.org/git/?p=modest;a=blobdiff_plain;f=src%2Fmodest-mail-operation.h;h=f646929892eb76d2b7ff50cf7df0e0e054e1328d;hp=badbe1a47af93947a32125dceb5732ee16332908;hb=b978d07da0770b94bb6c49c25a8f528022af94e8;hpb=a8bb6c4cbb9237511e6c313a8c627e5d3fa08650 diff --git a/src/modest-mail-operation.h b/src/modest-mail-operation.h index badbe1a..f646929 100644 --- a/src/modest-mail-operation.h +++ b/src/modest-mail-operation.h @@ -33,6 +33,7 @@ #include #include #include +#include G_BEGIN_DECLS @@ -69,9 +70,12 @@ typedef enum _ModestMailOperationStatus { typedef enum { MODEST_MAIL_OPERATION_TYPE_SEND, MODEST_MAIL_OPERATION_TYPE_RECEIVE, + MODEST_MAIL_OPERATION_TYPE_SEND_AND_RECEIVE, MODEST_MAIL_OPERATION_TYPE_OPEN, MODEST_MAIL_OPERATION_TYPE_DELETE, MODEST_MAIL_OPERATION_TYPE_INFO, + MODEST_MAIL_OPERATION_TYPE_RUN_QUEUE, + MODEST_MAIL_OPERATION_TYPE_SYNC_FOLDER, MODEST_MAIL_OPERATION_TYPE_UNKNOWN, } ModestMailOperationTypeOperation; @@ -129,16 +133,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); /** @@ -171,7 +193,6 @@ typedef void (*UpdateAccountCallback) (ModestMailOperation *self, TnyList *new_headers, gpointer user_data); - /** * SaveToDraftsCallback: * @@ -187,6 +208,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 { @@ -382,6 +423,8 @@ 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 + * @interactive: if TRUE the update account was scheduled by an interactive send receive * * Asynchronously refreshes the root folders of the given store * account. The caller should add the #ModestMailOperation to a @@ -402,10 +445,12 @@ 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, + gboolean interactive, + RetrieveAllCallback retrieve_all_cb, UpdateAccountCallback callback, gpointer user_data); @@ -425,9 +470,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: @@ -456,7 +503,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: @@ -464,7 +513,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 @@ -481,7 +530,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); @@ -493,7 +542,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 @@ -521,7 +570,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); /** @@ -586,6 +635,31 @@ void modest_mail_operation_get_msgs_full (ModestMailOperation *self, gpointer user_data, GDestroyNotify notify); +/** + * modest_mail_operation_run_queue: + * @self: a #ModestMailOperation + * @queue: a #ModestTnySendQueue + * + * This mail operation is special. It should be running every time the send queue + * is running (after queue-start), and we should notify end of the operation + * after queue-end. Then, we should only set this queue on queue-start signal, and + * it will clean up the operation (notify end) on queue-end. + */ +void modest_mail_operation_run_queue (ModestMailOperation *self, + ModestTnySendQueue *queue); + +/** + * modest_mail_operation_sync_folder: + * @self: a #ModestMailOperation + * @folder: a #TnyFolder + * @expunge: a #gboolean + * + * mail operation wrapper around tny_folder_sync () method, to keep modest + * running while we do that sync operation. + */ +void modest_mail_operation_sync_folder (ModestMailOperation *self, + TnyFolder *folder, gboolean expunge); + /* Functions to control mail operations */ /** * modest_mail_operation_get_task_done: @@ -673,8 +747,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__ */