X-Git-Url: http://git.maemo.org/git/?p=modest;a=blobdiff_plain;f=src%2Fmodest-mail-operation.h;h=f86812a7eb54ec634048b83b21cfc0357c7f41d1;hp=8ff9dfe87e942dafe480b1baca5ba987ec1a123b;hb=8b08d2fd3eebc0584a5c49abdcd26c52b65737f0;hpb=68945e42768533308e3b94f0dc046ef722e56115 diff --git a/src/modest-mail-operation.h b/src/modest-mail-operation.h index 8ff9dfe..f86812a 100644 --- a/src/modest-mail-operation.h +++ b/src/modest-mail-operation.h @@ -32,6 +32,7 @@ #include #include +#include G_BEGIN_DECLS @@ -75,7 +76,7 @@ typedef enum { } ModestMailOperationTypeOperation; /** - * ErrorCheckingAsyncUserCallback: + * ErrorCheckingUserCallback: * * @mail_op: the current mail operation. * @user_data: generic data passed to user defined function. @@ -86,9 +87,21 @@ 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: * - * @obj: a #GObject generic object which has created current mail operation. + * @mail_op: the current #ModestMailOperation. + * @header: a #TnyHeader summary item. * @msg: a #TnyMsg message retrieved by async operation. * @user_data: generic data passed to user defined function. * @@ -98,11 +111,25 @@ typedef void (*ErrorCheckingUserCallback) (ModestMailOperation *mail_op, gpointe */ typedef void (*GetMsgAsyncUserCallback) (ModestMailOperation *mail_op, TnyHeader *header, + gboolean canceled, TnyMsg *msg, + GError *err, gpointer user_data); /** - * XferMsgAsynUserCallback: + * GetMimePartSizeCallback: + * + * @mail_op: the current #ModestMailOperation. + * @size: size of the attachment + * @user_data: generic data passed to user defined function. + * + */ +typedef void (*GetMimePartSizeCallback) (ModestMailOperation *mail_op, + gssize size, + gpointer user_data); + +/** + * XferAsyncUserCallback: * * @obj: a #GObject generic object which has created current mail operation. * @user_data: generic data passed to user defined function. @@ -111,13 +138,13 @@ typedef void (*GetMsgAsyncUserCallback) (ModestMailOperation *mail_op, * used as tinymail operation callback. The private function fills private * fields of mail operation and calls user defined callback if it exists. */ -typedef void (*XferMsgsAsynUserCallback) (const GObject *obj, gpointer user_data); +typedef void (*XferAsyncUserCallback) (ModestMailOperation *mail_op, gpointer user_data); /** * RefreshAsyncUserCallback: * - * @obj: a #GObject generic object which has created current mail operation. + * @mail_op: the current #ModestMailOperation. * @folder: a #TnyFolder which has been refreshed . * @user_data: generic data passed to user defined function. * @@ -125,10 +152,60 @@ typedef void (*XferMsgsAsynUserCallback) (const GObject *obj, gpointer user_data * used as tinymail operation callback. The private function fills private * fields of mail operation and calls user defined callback if it exists. */ -typedef void (*RefreshAsyncUserCallback) (const GObject *obj, +typedef void (*RefreshAsyncUserCallback) (ModestMailOperation *mail_op, TnyFolder *folder, gpointer user_data); +/** + * UpdateAccountCallback: + * + * @self: a #ModestMailOperation + * @new_headers: the list of new headers received + * @user_data: generic data passed to user defined function. + * + * This is the callback of the update_account operation. It informs + * the caller about the amount of new messages that have been + * downloaded + */ +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 { @@ -152,6 +229,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 */ @@ -159,14 +238,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: @@ -180,10 +257,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 @@ -260,6 +337,7 @@ void modest_mail_operation_send_mail (ModestMailOperation *self, * @html_body: the html version of the body of the new mail. If NULL, the mail will * 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 * * Sends a new mail message using the provided * #TnyTransportAccount. This operation is synchronous, so the @@ -277,6 +355,7 @@ void modest_mail_operation_send_new_mail (ModestMailOperation *self, const gchar *plain_body, const gchar *html_body, const GList *attachments_list, + const GList *images_list, TnyHeaderFlags priority_flags); @@ -295,28 +374,34 @@ void modest_mail_operation_send_new_mail (ModestMailOperation *self, * @html_body: the html version of the body of the new mail. If NULL, the mail will * 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, - const gchar *from, - const gchar *to, - const gchar *cc, - const gchar *bcc, - const gchar *subject, - const gchar *plain_body, - const gchar *html_body, - const GList *attachments_list, - TnyHeaderFlags priority_flags); +void modest_mail_operation_save_to_drafts (ModestMailOperation *self, + TnyTransportAccount *transport_account, + TnyMsg *draft_msg, + const gchar *from, + const gchar *to, + const gchar *cc, + const gchar *bcc, + const gchar *subject, + const gchar *plain_body, + const gchar *html_body, + const GList *attachments_list, + const GList *images_list, + TnyHeaderFlags priority_flags, + 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 * * Asynchronously refreshes the root folders of the given store * account. The caller should add the #ModestMailOperation to a @@ -337,10 +422,13 @@ 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, - const gchar *account_name); +void modest_mail_operation_update_account (ModestMailOperation *self, + const gchar *account_name, + gboolean poke_all, + RetrieveAllCallback retrieve_all_cb, + UpdateAccountCallback callback, + gpointer user_data); /* Functions that perform store operations */ @@ -358,9 +446,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: @@ -397,6 +487,8 @@ 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_data: generic user data which will be passed to @user_callback function. * * Sets the given @folder as child of a provided #TnyFolderStore. This * operation also transfers all the messages contained in the folder @@ -411,7 +503,10 @@ void modest_mail_operation_rename_folder (ModestMailOperation *self, void modest_mail_operation_xfer_folder (ModestMailOperation *self, TnyFolder *folder, TnyFolderStore *parent, - gboolean delete_original); + gboolean delete_original, + XferAsyncUserCallback user_callback, + gpointer user_data); + /* Functions that performs msg operations */ @@ -421,7 +516,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 #XferMsgsAsynUserCallback function to call after tinymail callback execution. + * @user_callback: a #XferAsyncUserCallback 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 @@ -449,7 +544,7 @@ void modest_mail_operation_xfer_msgs (ModestMailOperation *self, TnyList *header_list, TnyFolder *folder, gboolean delete_original, - XferMsgsAsynUserCallback user_callback, + XferAsyncUserCallback user_callback, gpointer user_data); /** @@ -468,6 +563,21 @@ void modest_mail_operation_remove_msg (ModestMailOperation *self, gboolean remove_to_trash); /** + * modest_mail_operation_remove_msg: + * @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 + **/ +void modest_mail_operation_remove_msgs (ModestMailOperation *self, + TnyList *headers, + gboolean remove_to_trash); + +/** * modest_mail_operation_get_msg: * @self: a #ModestMailOperation * @header_list: the #TnyHeader of the message to get @@ -586,10 +696,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