Modified webpage: now tinymail repository is in gitorious.
[modest] / src / modest-mail-operation.h
index c721541..97c6066 100644 (file)
@@ -32,8 +32,8 @@
 
 #include <tny-transport-account.h>
 #include <tny-folder-store.h>
-#include <widgets/modest-msg-edit-window.h>
 #include <modest-tny-send-queue.h>
+#include <modest-tny-account-store.h>
 
 G_BEGIN_DECLS
 
@@ -76,6 +76,9 @@ typedef enum {
        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;
 
@@ -228,6 +231,20 @@ typedef void (*CreateFolderUserCallback) (ModestMailOperation *mail_op,
                                          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 {
@@ -378,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:
@@ -417,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);
 /**
@@ -424,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
@@ -448,10 +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,
-                                                   RetrieveAllCallback retrieve_all_cb,
+                                                   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 */
 
 /**
@@ -572,39 +610,44 @@ void          modest_mail_operation_xfer_msgs      (ModestMailOperation *self,
                                                    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.
  * 
@@ -613,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
@@ -647,6 +710,18 @@ 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
@@ -656,7 +731,20 @@ void          modest_mail_operation_run_queue       (ModestMailOperation *self,
  * running while we do that sync operation.
  */
 void          modest_mail_operation_sync_folder     (ModestMailOperation *self,
-                                                    TnyFolder *folder, gboolean expunge);
+                                                    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 */
 /**