X-Git-Url: http://git.maemo.org/git/?p=modest;a=blobdiff_plain;f=src%2Fmodest-mail-operation.h;h=97c60667e9308594bb87a9261d5700d0b17d3e3c;hp=c46a31f3b37a15a468d3d05540e9eaaacf990174;hb=80d46e0ddb62768d3ce531038da3e055aa8feaba;hpb=06ee0f33a632215fe2948f2113e2e425151a5e2e diff --git a/src/modest-mail-operation.h b/src/modest-mail-operation.h index c46a31f..97c6066 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,9 +70,15 @@ 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_UPDATE_FOLDER_COUNTS, MODEST_MAIL_OPERATION_TYPE_UNKNOWN, } ModestMailOperationTypeOperation; @@ -129,16 +136,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 +196,6 @@ typedef void (*UpdateAccountCallback) (ModestMailOperation *self, TnyList *new_headers, gpointer user_data); - /** * SaveToDraftsCallback: * @@ -187,6 +211,40 @@ 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); + +/** + * SyncFolderCallback: + * + * @self: a #ModestMailOperation + * @folder: the #TnyFolder to sync + * @user_data: generic data passed to user defined function. + * + * This is the callback of the sync_folder operation. + */ +typedef void (*SyncFolderCallback) (ModestMailOperation *self, + TnyFolder *folder, + gpointer user_data); + + /* This struct represents the internal state of a mail operation in a given time */ typedef struct { @@ -337,8 +395,14 @@ void modest_mail_operation_send_new_mail (ModestMailOperation *self, const gchar *html_body, const GList *attachments_list, const GList *images_list, - TnyHeaderFlags priority_flags); + const gchar *references, + const gchar *in_reply_to, + TnyHeaderFlags priority_flags, + TnyList *header_pairs); +void modest_mail_operation_send_mail (ModestMailOperation *mail_operation, + TnyTransportAccount *transport_account, + TnyMsg *msg); /** * modest_mail_operation_save_to_drafts: @@ -376,6 +440,9 @@ void modest_mail_operation_save_to_drafts (ModestMailOperation *self, const GList *attachments_list, const GList *images_list, TnyHeaderFlags priority_flags, + const gchar *references, + const gchar *in_reply_to, + TnyList *header_pairs, SaveToDraftstCallback callback, gpointer user_data); /** @@ -383,6 +450,7 @@ void modest_mail_operation_save_to_drafts (ModestMailOperation *self, * @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 @@ -407,9 +475,21 @@ void modest_mail_operation_save_to_drafts (ModestMailOperation *self, void modest_mail_operation_update_account (ModestMailOperation *self, const gchar *account_name, gboolean poke_all, + gboolean interactive, UpdateAccountCallback callback, gpointer user_data); +/** + * modest_mail_operation_update_folder_counts: + * @self: a #ModestMailOperation + * @account_name: the id of a Modest account + * + * Asynchronously refreshes the folder counts of the given store + * account. + */ +void modest_mail_operation_update_folder_counts (ModestMailOperation *self, + const gchar *account_name); + /* Functions that perform store operations */ /** @@ -426,9 +506,11 @@ void 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: @@ -457,7 +539,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: @@ -465,7 +549,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 @@ -482,7 +566,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); @@ -494,7 +578,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 @@ -522,43 +606,48 @@ 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, gboolean remove_to_trash); /** + * modest_mail_operation_get_msg_and_parts: + * @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. + * + * Gets a message from header using an user defined @callback function + * pased as argument. This operation is asynchronous, so the + * #ModestMailOperation should be added to #ModestMailOperationQueue + * + * This operation also retrieves to cache all parts of the message. This is needed for + * forward operation. + **/ +void modest_mail_operation_get_msg_and_parts (ModestMailOperation *self, + TnyHeader *header, + TnyList *parts, + gboolean progress_feedback, + GetMsgAsyncUserCallback user_callback, + gpointer user_data); +/** * 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. * @@ -567,10 +656,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 @@ -587,6 +696,56 @@ 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, + SyncFolderCallback callback, + gpointer user_data); + +/** + * 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: @@ -694,6 +853,18 @@ TnyAccount *modest_mail_operation_get_account (ModestMailOperation *self); **/ 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__ */