X-Git-Url: http://vcs.maemo.org/git/?a=blobdiff_plain;f=src%2Fmodest-mail-operation.h;h=bf103823d9ef597ea4e874c590e5dcabe2c59069;hb=bac5b9ce2f6d579d6d4bb0969c97537300cfc1c8;hp=af53120d43e9de5567764db3ed8cb7166f8234a4;hpb=cc36ea20ffc9bc9dbd884f511db9bae55f4d97ca;p=modest diff --git a/src/modest-mail-operation.h b/src/modest-mail-operation.h index af53120..bf10382 100644 --- a/src/modest-mail-operation.h +++ b/src/modest-mail-operation.h @@ -87,11 +87,45 @@ struct _ModestMailOperationClass { void (*progress_changed) (ModestMailOperation *self, gpointer user_data); }; +/** + * GetMsgAsynUserCallback: + * + * @obj: a #GObject generic object which has created current mail operation. + * @msg: a #TnyMsg message retrieved by async operation. + * @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 (*GetMsgAsynUserCallback) (const GObject *obj, const TnyMsg *msg, gpointer user_data); + +/** + * XferMsgAsynUserCallback: + * + * @obj: a #GObject generic object which has created current mail operation. + * @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 (*XferMsgsAsynUserCallback) (const GObject *obj, gpointer user_data); + + /* member functions */ GType modest_mail_operation_get_type (void) G_GNUC_CONST; -/* typical parameter-less _new function */ -ModestMailOperation* modest_mail_operation_new (ModestMailOperationId id); +/** + * 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 (ModestMailOperationId id, + GObject *source); /** * modest_mail_operation_get_id @@ -99,10 +133,23 @@ ModestMailOperation* modest_mail_operation_new (ModestMailOperationId id) * * Gets the private id field of mail operation. This id identifies * the class/type of mail operation. - **/ + **/ ModestMailOperationId modest_mail_operation_get_id (ModestMailOperation *self); +/** + * modest_mail_operation_is_mine + * @self: a #ModestMailOperation + * @source: a #GObject to check if it have created @self operation. + * + * Check if @source object its owner of @self mail operation. + * + * returns: TRUE if source its owner, FALSE otherwise. + **/ +gboolean +modest_mail_operation_is_mine (ModestMailOperation *self, + GObject *me); + /* fill in other public functions, eg.: */ /** @@ -185,7 +232,7 @@ void modest_mail_operation_save_to_drafts (ModestMailOperation *self, /** * modest_mail_operation_update_account: * @self: a #ModestMailOperation - * @store_account: a #TnyStoreAccount + * @account_name: the id of a Modest account * * Asynchronously refreshes the root folders of the given store * account. The caller should add the #ModestMailOperation to a @@ -193,23 +240,23 @@ void modest_mail_operation_save_to_drafts (ModestMailOperation *self, * notified by the "progress_changed" signal each time the progress of * the operation changes. * - * Note that the store account passed as parametter will be freed by - * the mail operation so you must pass a new reference - * * Example * * queue = modest_tny_platform_factory_get_modest_mail_operation_queue_instance (fact) * mail_op = modest_mail_operation_new (); * g_signal_connect (G_OBJECT (mail_op), "progress_changed", G_CALLBACK(on_progress_changed), NULL); * modest_mail_operation_queue_add (queue, mail_op); - * modest_mail_operation_update_account (mail_op, account) + * modest_mail_operation_update_account (mail_op, account_name) * g_object_unref (G_OBJECT (mail_op)); * + * + * 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, - TnyStoreAccount *store_account); + const gchar *account_name); /* Functions that perform store operations */ @@ -279,11 +326,16 @@ void modest_mail_operation_rename_folder (ModestMailOperation *self, * Returns: the newly transfered folder **/ TnyFolder* modest_mail_operation_xfer_folder (ModestMailOperation *self, - TnyFolder *folder, + TnyFolder *folder, TnyFolderStore *parent, gboolean delete_original); + +void modest_mail_operation_xfer_folder_async (ModestMailOperation *self, + TnyFolder *folder, + TnyFolderStore *parent, + gboolean delete_original); /* Functions that performs msg operations */ /** @@ -292,6 +344,8 @@ TnyFolder* 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_data: generic user data which will be passed to @user_callback function. * * Asynchronously transfers messages from their current folder to * another one. The caller should add the #ModestMailOperation to a @@ -317,7 +371,9 @@ TnyFolder* modest_mail_operation_xfer_folder (ModestMailOperation *self, void modest_mail_operation_xfer_msgs (ModestMailOperation *self, TnyList *header_list, TnyFolder *folder, - gboolean delete_original); + gboolean delete_original, + XferMsgsAsynUserCallback user_callback, + gpointer user_data); /** * modest_mail_operation_remove_msg: @@ -335,19 +391,34 @@ void modest_mail_operation_remove_msg (ModestMailOperation *self, gboolean remove_to_trash); /** + * modest_mail_operation_get_msg: + * @self: a #ModestMailOperation + * @header_list: the #TnyHeader of the message to get + * @user_callback: a #GetMsgAsynUserCallback 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 + **/ +void modest_mail_operation_get_msg (ModestMailOperation *self, + TnyHeader *header, + GetMsgAsynUserCallback user_callback, + gpointer user_data); +/** * modest_mail_operation_process_msg: * @self: a #ModestMailOperation - * @header: the #TnyHeader of the message to get - * permanently + * @header_list: a #TnyList of #TnyHeader objects to get and process + * @user_callback: a #TnyGetMsgCallback function to call after tinymail operation execution. + * @user_data: user data passed to both, user_callback and update_status_callback. * - * Gets a message and process it using @callback function - * pased as argument. This operation is assynchronous, so the - * #ModestMailOperation should be added to - * #ModestMailOperationQueue + * Gets messages from headers list and process hem using @callback function + * pased as argument. This operation is asynchronous, so the + * #ModestMailOperation should be added to #ModestMailOperationQueue **/ void modest_mail_operation_process_msg (ModestMailOperation *self, - TnyHeader *header, - TnyGetMsgCallback user_callback, + TnyList *headers_list, + GetMsgAsynUserCallback user_callback, gpointer user_data); /* Functions to control mail operations */