Build fix, updating API changes from Tinymail
[modest] / src / modest-mail-operation.h
index 34eff04..bf10382 100644 (file)
@@ -100,6 +100,18 @@ struct _ModestMailOperationClass {
  */
 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;
@@ -220,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
@@ -228,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
  * <informalexample><programlisting>
  * 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));
  * </programlisting></informalexample>
+ *
+ * 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 */
 
@@ -332,6 +344,8 @@ void    modest_mail_operation_xfer_folder_async    (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
@@ -357,7 +371,9 @@ void    modest_mail_operation_xfer_folder_async    (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: