X-Git-Url: http://git.maemo.org/git/?p=modest;a=blobdiff_plain;f=src%2Fmodest-mail-operation.h;h=b271c9250043389e1ae8f6482cd3692440d3b8e4;hp=f4212b47742976053b61ef2426c5bdf7d3670f97;hb=4d39841513a3a7f7aa9d38ab97cb9fcc9171e80b;hpb=b9b928dee5f5169c3317df86b153b4d069b814d0 diff --git a/src/modest-mail-operation.h b/src/modest-mail-operation.h index f4212b4..b271c92 100644 --- a/src/modest-mail-operation.h +++ b/src/modest-mail-operation.h @@ -32,7 +32,8 @@ #include #include -#include +#include +#include G_BEGIN_DECLS @@ -69,14 +70,19 @@ 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_SHUTDOWN, + MODEST_MAIL_OPERATION_TYPE_QUEUE_WAKEUP, MODEST_MAIL_OPERATION_TYPE_UNKNOWN, } ModestMailOperationTypeOperation; /** - * ErrorCheckingAsyncUserCallback: + * ErrorCheckingUserCallback: * * @mail_op: the current mail operation. * @user_data: generic data passed to user defined function. @@ -87,6 +93,17 @@ typedef enum { typedef void (*ErrorCheckingUserCallback) (ModestMailOperation *mail_op, gpointer user_data); /** + * ErrorCheckingUserDataDestroyer: + * + * @user_data: generic data passed to user defined function. + * + * This function is used to destroy the user_data passed to the error + * checking user callback function + */ +typedef void (*ErrorCheckingUserDataDestroyer) (gpointer user_data); + + +/** * GetMsgAsyncUserCallback: * * @mail_op: the current #ModestMailOperation. @@ -100,7 +117,9 @@ typedef void (*ErrorCheckingUserCallback) (ModestMailOperation *mail_op, gpointe */ typedef void (*GetMsgAsyncUserCallback) (ModestMailOperation *mail_op, TnyHeader *header, + gboolean canceled, TnyMsg *msg, + GError *err, gpointer user_data); /** @@ -116,16 +135,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 (*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 (*XferAsyncUserCallback) (ModestMailOperation *mail_op, gpointer user_data); +typedef void (*XferFolderAsyncUserCallback) (ModestMailOperation *mail_op, + TnyFolder *new_folder, + gpointer user_data); /** @@ -146,7 +183,7 @@ typedef void (*RefreshAsyncUserCallback) (ModestMailOperation *mail_op, /** * UpdateAccountCallback: * - * @obj: a #GObject generic object which has created current mail operation. + * @self: a #ModestMailOperation * @new_headers: the list of new headers received * @user_data: generic data passed to user defined function. * @@ -158,6 +195,41 @@ typedef void (*UpdateAccountCallback) (ModestMailOperation *self, TnyList *new_headers, gpointer user_data); +/** + * SaveToDraftsCallback: + * + * @self: a #ModestMailOperation + * @saved_draft: the new draft message that has been saved + * @user_data: generic data passed to user defined function. + * + * This is the callback of the save_to_drafts operation. It returns + * the newly created msg stored in the Drafts folder + */ +typedef void (*SaveToDraftstCallback) (ModestMailOperation *self, + TnyMsg *saved_draft, + 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 { @@ -181,6 +253,8 @@ struct _ModestMailOperationClass { /* Signals */ void (*progress_changed) (ModestMailOperation *self, ModestMailOperationState *state, gpointer user_data); + void (*operation_started) (ModestMailOperation *self, gpointer user_data); + void (*operation_finished) (ModestMailOperation *self, gpointer user_data); }; /* member functions */ @@ -188,14 +262,12 @@ GType modest_mail_operation_get_type (void) G_GNUC_CONST; /** * modest_mail_operation_new: - * @id: a #ModestMailOperationId identification of operation type. * @source: a #GObject which creates this new operation. * * Creates a new instance of class #ModestMailOperation, using parameters * to initialize its private structure. @source parameter may be NULL. **/ -ModestMailOperation* modest_mail_operation_new (ModestMailOperationTypeOperation type, - GObject *source); +ModestMailOperation* modest_mail_operation_new (GObject *source); /** * modest_mail_operation_new_with_error_handling: @@ -209,10 +281,10 @@ ModestMailOperation* modest_mail_operation_new (ModestMailOperationTypeOp * @error_handler can not be NULL, but it will be returned an mail operation * object without error handling capability. **/ -ModestMailOperation* modest_mail_operation_new_with_error_handling (ModestMailOperationTypeOperation op_type, - GObject *source, +ModestMailOperation* modest_mail_operation_new_with_error_handling (GObject *source, ErrorCheckingUserCallback error_handler, - gpointer user_data); + gpointer user_data, + ErrorCheckingUserDataDestroyer error_handler_destroyer); /** * modest_mail_operation_execute_error_handler * @self: a #ModestMailOperation @@ -308,6 +380,8 @@ void modest_mail_operation_send_new_mail (ModestMailOperation *self, const gchar *html_body, const GList *attachments_list, const GList *images_list, + const gchar *references, + const gchar *in_reply_to, TnyHeaderFlags priority_flags); @@ -327,17 +401,16 @@ void modest_mail_operation_send_new_mail (ModestMailOperation *self, * be sent with the plain body only. * @attachments_list: a #GList of attachments, each attachment must be a #TnyMimePart * @images_list: a #GList of image attachments, each attachment must be a #TnyMimePart - * + * @callback: the user callback, will be called when the operation finishes + * @user_data: data that will be passed to the user callback + * * Save a mail message to drafts using the provided - * #TnyTransportAccount. This operation is synchronous, so the - * #ModestMailOperation should not be added to any - * #ModestMailOperationQueue + * #TnyTransportAccount. This operation is asynchronous. * **/ void modest_mail_operation_save_to_drafts (ModestMailOperation *self, TnyTransportAccount *transport_account, TnyMsg *draft_msg, - ModestMsgEditWindow *edit_window, const gchar *from, const gchar *to, const gchar *cc, @@ -347,11 +420,17 @@ void modest_mail_operation_save_to_drafts (ModestMailOperation *self, const gchar *html_body, const GList *attachments_list, const GList *images_list, - TnyHeaderFlags priority_flags); + TnyHeaderFlags priority_flags, + const gchar *references, + const gchar *in_reply_to, + SaveToDraftstCallback callback, + gpointer user_data); /** * 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 @@ -372,10 +451,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); @@ -395,9 +476,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: @@ -426,7 +509,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: @@ -434,7 +519,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 @@ -451,7 +536,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); @@ -463,7 +548,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 @@ -491,34 +576,17 @@ 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); /** - * modest_mail_operation_remove_msg: - * @self: a #ModestMailOperation - * @header: the #TnyHeader of the message to move - * @remove_to_trash: TRUE to move it to trash or FALSE to delete it - * permanently - * - * Deletes a message. This operation is synchronous, so the - * #ModestMailOperation should not be added to any - * #ModestMailOperationQueue - **/ -void modest_mail_operation_remove_msg (ModestMailOperation *self, - TnyHeader *header, - gboolean remove_to_trash); - -/** - * modest_mail_operation_remove_msg: + * modest_mail_operation_remove_msgs: * @self: a #ModestMailOperation * @headers: the #TnyList of the messages to delete * @remove_to_trash: TRUE to move it to trash or FALSE to delete it * permanently * - * Deletes a list of messages. This operation is synchronous, so the - * #ModestMailOperation should not be added to any - * #ModestMailOperationQueue + * Deletes a list of messages. **/ void modest_mail_operation_remove_msgs (ModestMailOperation *self, TnyList *headers, @@ -528,6 +596,7 @@ void modest_mail_operation_remove_msgs (ModestMailOperation *self, * modest_mail_operation_get_msg: * @self: a #ModestMailOperation * @header_list: the #TnyHeader of the message to get + * @progress_feedback: a #gboolean. If %TRUE, we'll get progress bar feedback. * @user_callback: a #GetMsgAsyncUserCallback function to call after tinymail callback execution. * @user_data: generic user data which will be passed to @user_callback function. * @@ -536,10 +605,30 @@ void modest_mail_operation_remove_msgs (ModestMailOperation *self, * #ModestMailOperation should be added to #ModestMailOperationQueue **/ void modest_mail_operation_get_msg (ModestMailOperation *self, - TnyHeader *header, + TnyHeader *header, + gboolean progress_feedback, GetMsgAsyncUserCallback user_callback, gpointer user_data); /** + * modest_mail_operation_find_msg: + * @self: a #ModestMailOperation + * @msg_uid: a string + * @progress_feedback: a #gboolean. If %TRUE, we'll get progress bar feedback. + * @user_callback: a #GetMsgAsyncUserCallback function to call after tinymail callback execution. + * @user_data: generic user data which will be passed to @user_callback function. + * + * Gets a message from a uid using an user defined @callback function + * pased as argument. This operation is asynchronous, so the + * #ModestMailOperation should be added to #ModestMailOperationQueue + **/ +void modest_mail_operation_find_msg (ModestMailOperation *self, + TnyFolder *folder, + const gchar *msg_uid, + gboolean progress_feedback, + GetMsgAsyncUserCallback user_callback, + gpointer user_data); + +/** * modest_mail_operation_get_msgs_full: * @self: a #ModestMailOperation * @header_list: a #TnyList of #TnyHeader objects to get and process @@ -556,6 +645,53 @@ 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_queue_wakeup: + * @self: a #ModestMailOperation + * @queue: a #ModestTnySendQueue + * + * This mail operation is special. It should be running every time the send queue + * wakeup is running and we should notify end of the operation + * after wakeup has done msg-sent notification. + */ +void modest_mail_operation_queue_wakeup (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); + +/** + * modest_mail_operation_shutdown: + * @self: a #ModestMailOperation + * @account_store: a #ModestTnyAccountStore + * + * disconnects all accounts in the account store (doing the proper syncs). + */ +void modest_mail_operation_shutdown (ModestMailOperation *self, + ModestTnyAccountStore *account_store); + /* Functions to control mail operations */ /** * modest_mail_operation_get_task_done: @@ -643,10 +779,37 @@ void modest_mail_operation_refresh_folder (ModestMailOperation *self, RefreshAsyncUserCallback user_callback, gpointer user_data); -guint modest_mail_operation_get_id (ModestMailOperation *self); +/** + * 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); -guint modest_mail_operation_set_id (ModestMailOperation *self, - guint id); G_END_DECLS