X-Git-Url: http://git.maemo.org/git/?p=modest;a=blobdiff_plain;f=src%2Fmodest-mail-operation.h;h=f86812a7eb54ec634048b83b21cfc0357c7f41d1;hp=aa293aec514a80b8923d275b8b4a5ba82476a727;hb=8b08d2fd3eebc0584a5c49abdcd26c52b65737f0;hpb=fb0039f9e3f59cd18402a0be8733a4ccfb37aeaa diff --git a/src/modest-mail-operation.h b/src/modest-mail-operation.h index aa293ae..f86812a 100644 --- a/src/modest-mail-operation.h +++ b/src/modest-mail-operation.h @@ -76,7 +76,7 @@ typedef enum { } ModestMailOperationTypeOperation; /** - * ErrorCheckingAsyncUserCallback: + * ErrorCheckingUserCallback: * * @mail_op: the current mail operation. * @user_data: generic data passed to user defined function. @@ -87,6 +87,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 +111,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); /** @@ -146,7 +159,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 +171,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 { @@ -190,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: @@ -211,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 @@ -329,17 +375,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, @@ -349,11 +394,14 @@ 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, + 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 @@ -374,10 +422,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); @@ -397,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: @@ -645,8 +696,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__ */