git.maemo.org Git - modest/blob - src/modest-mail-operation.h

   1 /* Copyright (c) 2006, Nokia Corporation
   2  * All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   8  * * Redistributions of source code must retain the above copyright
   9  *   notice, this list of conditions and the following disclaimer.
  10  * * Redistributions in binary form must reproduce the above copyright
  11  *   notice, this list of conditions and the following disclaimer in the
  12  *   documentation and/or other materials provided with the distribution.
  13  * * Neither the name of the Nokia Corporation nor the names of its
  14  *   contributors may be used to endorse or promote products derived from
  15  *   this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
  18  * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  19  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  20  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
  21  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  22  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  23  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  24  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  25  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  26  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  27  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  */
  29
  30 #ifndef __MODEST_MAIL_OPERATION_H__
  31 #define __MODEST_MAIL_OPERATION_H__
  32
  33 #include <tny-transport-account.h>
  34 #include <tny-folder-store.h>
  35 #include <modest-tny-send-queue.h>
  36 #include <modest-tny-account-store.h>
  37
  38 G_BEGIN_DECLS
  39
  40 /* convenience macros */
  41 #define MODEST_TYPE_MAIL_OPERATION             (modest_mail_operation_get_type())
  42 #define MODEST_MAIL_OPERATION(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_MAIL_OPERATION,ModestMailOperation))
  43 #define MODEST_MAIL_OPERATION_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_MAIL_OPERATION,GObject))
  44 #define MODEST_IS_MAIL_OPERATION(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_MAIL_OPERATION))
  45 #define MODEST_IS_MAIL_OPERATION_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_MAIL_OPERATION))
  46 #define MODEST_MAIL_OPERATION_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_MAIL_OPERATION,ModestMailOperationClass))
  47
  48 typedef struct _ModestMailOperation      ModestMailOperation;
  49 typedef struct _ModestMailOperationClass ModestMailOperationClass;
  50
  51 /**
  52  * ModestMailOperationStatus:
  53  *
  54  * The state of a mail operation
  55  */
  56 typedef enum _ModestMailOperationStatus {
  57         MODEST_MAIL_OPERATION_STATUS_INVALID,
  58         MODEST_MAIL_OPERATION_STATUS_SUCCESS,
  59         MODEST_MAIL_OPERATION_STATUS_FINISHED_WITH_ERRORS,
  60         MODEST_MAIL_OPERATION_STATUS_FAILED,
  61         MODEST_MAIL_OPERATION_STATUS_IN_PROGRESS,
  62         MODEST_MAIL_OPERATION_STATUS_CANCELED
  63 } ModestMailOperationStatus;
  64
  65 /**
  66  * ModestMailOperationId:
  67  *
  68  * The id for identifying the type of mail operation
  69  */
  70 typedef enum {
  71         MODEST_MAIL_OPERATION_TYPE_SEND,
  72         MODEST_MAIL_OPERATION_TYPE_RECEIVE,
  73         MODEST_MAIL_OPERATION_TYPE_SEND_AND_RECEIVE,
  74         MODEST_MAIL_OPERATION_TYPE_OPEN,
  75         MODEST_MAIL_OPERATION_TYPE_DELETE,
  76         MODEST_MAIL_OPERATION_TYPE_INFO,
  77         MODEST_MAIL_OPERATION_TYPE_RUN_QUEUE,
  78         MODEST_MAIL_OPERATION_TYPE_SYNC_FOLDER,
  79         MODEST_MAIL_OPERATION_TYPE_SHUTDOWN,
  80         MODEST_MAIL_OPERATION_TYPE_QUEUE_WAKEUP,
  81         MODEST_MAIL_OPERATION_TYPE_UPDATE_FOLDER_COUNTS,
  82         MODEST_MAIL_OPERATION_TYPE_UNKNOWN,
  83 } ModestMailOperationTypeOperation;
  84
  85 /**
  86  * ErrorCheckingUserCallback:
  87  *
  88  * @mail_op: the current mail operation.
  89  * @user_data: generic data passed to user defined function.
  90  *
  91  * This function implements required actions to performs under error
  92  * states.
  93  */
  94 typedef void (*ErrorCheckingUserCallback) (ModestMailOperation *mail_op, gpointer user_data);
  95
  96 /**
  97  * ErrorCheckingUserDataDestroyer:
  98  *
  99  * @user_data: generic data passed to user defined function.
 100  *
 101  * This function is used to destroy the user_data passed to the error
 102  * checking user callback function
 103  */
 104 typedef void (*ErrorCheckingUserDataDestroyer) (gpointer user_data);
 105
 106
 107 /**
 108  * GetMsgAsyncUserCallback:
 109  *
 110  * @mail_op: the current #ModestMailOperation.
 111  * @header: a #TnyHeader summary item.
 112  * @msg: a #TnyMsg message retrieved by async operation.
 113  * @user_data: generic data passed to user defined function.
 114  *
 115  * This function will be called after get_msg_cb private function, which is
 116  * used as tinymail operation callback. The private function fills private
 117  * fields of mail operation and calls user defined callback if it exists.
 118  */
 119 typedef void (*GetMsgAsyncUserCallback) (ModestMailOperation *mail_op,
 120                                          TnyHeader *header,
 121                                          gboolean canceled,
 122                                          TnyMsg *msg,
 123                                          GError *err,
 124                                          gpointer user_data);
 125
 126 /**
 127  * GetMimePartSizeCallback:
 128  *
 129  * @mail_op: the current #ModestMailOperation.
 130  * @size: size of the attachment
 131  * @user_data: generic data passed to user defined function.
 132  *
 133  */
 134 typedef void (*GetMimePartSizeCallback) (ModestMailOperation *mail_op,
 135                                          gssize size,
 136                                          gpointer user_data);
 137
 138 /**
 139  * XferMsgsAsyncUserCallback:
 140  *
 141  * @obj: a #GObject generic object which has created current mail operation.
 142  * @new_folder: the new instance of the #TnyFolder that has been transferred
 143  * @user_data: generic data passed to user defined function.
 144  *
 145  * This function will be called after transfer_msgs_cb private function, which is
 146  * used as tinymail operation callback. The private function fills private
 147  * fields of mail operation and calls user defined callback if it exists.
 148  */
 149 typedef void (*XferMsgsAsyncUserCallback) (ModestMailOperation *mail_op,
 150                                            gpointer user_data);
 151
 152
 153 /**
 154  * XferFolderAsyncUserCallback:
 155  *
 156  * @obj: a #GObject generic object which has created current mail operation.
 157  * @new_folder: the new instance of the #TnyFolder that has been transferred
 158  * @user_data: generic data passed to user defined function.
 159  *
 160  * This function will be called after transfer_msgs_cb private function, which is
 161  * used as tinymail operation callback. The private function fills private
 162  * fields of mail operation and calls user defined callback if it exists.
 163  */
 164 typedef void (*XferFolderAsyncUserCallback) (ModestMailOperation *mail_op,
 165                                              TnyFolder *new_folder,
 166                                              gpointer user_data);
 167
 168
 169 /**
 170  * RefreshAsyncUserCallback:
 171  *
 172  * @mail_op: the current #ModestMailOperation.
 173  * @folder: a #TnyFolder which has been refreshed .
 174  * @user_data: generic data passed to user defined function.
 175  *
 176  * This function will be called after refresh_folder_async_cb private function, which is
 177  * used as tinymail operation callback. The private function fills private
 178  * fields of mail operation and calls user defined callback if it exists.
 179  */
 180 typedef void (*RefreshAsyncUserCallback) (ModestMailOperation *mail_op,
 181                                           TnyFolder *folder,
 182                                           gpointer user_data);
 183
 184 /**
 185  * UpdateAccountCallback:
 186  *
 187  * @self: a #ModestMailOperation
 188  * @new_headers: the list of new headers received
 189  * @user_data: generic data passed to user defined function.
 190  *
 191  * This is the callback of the update_account operation. It informs
 192  * the caller about the amount of new messages that have been
 193  * downloaded
 194  */
 195 typedef void (*UpdateAccountCallback) (ModestMailOperation *self,
 196                                        TnyList *new_headers,
 197                                        gpointer user_data);
 198
 199 /**
 200  * SaveToDraftsCallback:
 201  *
 202  * @self: a #ModestMailOperation
 203  * @saved_draft: the new draft message that has been saved
 204  * @user_data: generic data passed to user defined function.
 205  *
 206  * This is the callback of the save_to_drafts operation. It returns
 207  * the newly created msg stored in the Drafts folder
 208  */
 209 typedef void (*SaveToDraftstCallback) (ModestMailOperation *self,
 210                                        TnyMsg *saved_draft,
 211                                        gpointer user_data);
 212
 213
 214 typedef gboolean (*RetrieveAllCallback) (GObject *source,
 215                                          guint num_msgs,
 216                                          guint limit);
 217
 218 /**
 219  * CreateFolderUserCallback:
 220  *
 221  * @mail_op: the current #ModestMailOperation.
 222  * @folder: a #TnyFolder summary item.
 223  * @user_data: generic data passed to user defined function.
 224  *
 225  * This function will be called after get_msg_cb private function, which is
 226  * used as tinymail operation callback. The private function fills private
 227  * fields of mail operation and calls user defined callback if it exists.
 228  */
 229 typedef void (*CreateFolderUserCallback) (ModestMailOperation *mail_op,
 230                                           TnyFolderStore *parent_folder,
 231                                           TnyFolder *new_folder,
 232                                           gpointer user_data);
 233
 234 /**
 235  * SyncFolderCallback:
 236  *
 237  * @self: a #ModestMailOperation
 238  * @folder: the #TnyFolder to sync
 239  * @user_data: generic data passed to user defined function.
 240  *
 241  * This is the callback of the sync_folder operation.
 242  */
 243 typedef void (*SyncFolderCallback) (ModestMailOperation *self,
 244                                     TnyFolder *folder,
 245                                     gpointer user_data);
 246
 247
 248 /* This struct represents the internal state of a mail operation in a
 249    given time */
 250 typedef struct {
 251         guint      done;
 252         guint      total;
 253         gdouble    bytes_done;
 254         gdouble    bytes_total;
 255         gboolean   finished;
 256         ModestMailOperationStatus        status;
 257         ModestMailOperationTypeOperation op_type;
 258 } ModestMailOperationState;
 259
 260
 261 struct _ModestMailOperation {
 262          GObject parent;
 263         /* insert public members, if any */
 264 };
 265
 266 struct _ModestMailOperationClass {
 267         GObjectClass parent_class;
 268
 269         /* Signals */
 270         void (*progress_changed) (ModestMailOperation *self, ModestMailOperationState *state, gpointer user_data);
 271         void (*operation_started) (ModestMailOperation *self, gpointer user_data);
 272         void (*operation_finished) (ModestMailOperation *self, gpointer user_data);
 273 };
 274
 275 /* member functions */
 276 GType        modest_mail_operation_get_type    (void) G_GNUC_CONST;
 277
 278 /**
 279  * modest_mail_operation_new:
 280  * @source: a #GObject which creates this new operation.
 281  *
 282  * Creates a new instance of class #ModestMailOperation, using parameters
 283  * to initialize its private structure. @source parameter may be NULL.
 284  **/
 285 ModestMailOperation*    modest_mail_operation_new     (GObject *source);
 286
 287 /**
 288  * modest_mail_operation_new_with_error_handling:
 289  * @id: a #ModestMailOperationId identification of operation type.
 290  * @source: a #GObject which creates this new operation.
 291  * @error_handler: a #ErrorCheckingUserCallback function to performs operations when
 292  * an error occurs.
 293  *
 294  * Creates a new instance of class #ModestMailOperation, using parameters
 295  * to initialize its private structure. @source parameter may be NULL.
 296  * @error_handler can not be NULL, but it will be returned an mail operation
 297  * object without error handling capability.
 298  **/
 299 ModestMailOperation*    modest_mail_operation_new_with_error_handling     (GObject *source,
 300                                                                            ErrorCheckingUserCallback error_handler,
 301                                                                            gpointer user_data,
 302                                                                            ErrorCheckingUserDataDestroyer error_handler_destroyer);
 303 /**
 304  * modest_mail_operation_execute_error_handler
 305  * @self: a #ModestMailOperation
 306  *
 307  * Executes error handler if exists. The error handler is the one that
 308  * MUST free the user data passed to the
 309  * modest_mail_operation_new_with_error_handling constructor
 310  **/
 311 void
 312 modest_mail_operation_execute_error_handler (ModestMailOperation *self);
 313
 314 /**
 315  * modest_mail_operation_get_type_operation
 316  * @self: a #ModestMailOperation
 317  *
 318  * Gets the private op_type field of mail operation. This op_type
 319  * identifies the class/type of mail operation.
 320  **/
 321 ModestMailOperationTypeOperation
 322 modest_mail_operation_get_type_operation (ModestMailOperation *self);
 323
 324 /**
 325  * modest_mail_operation_is_mine
 326  * @self: a #ModestMailOperation
 327  * @source: a #GObject to check if it have created @self operation.
 328  *
 329  * Check if @source object its owner of @self mail operation.
 330  *
 331  * returns: TRUE if source its owner, FALSE otherwise.
 332  **/
 333 gboolean
 334 modest_mail_operation_is_mine (ModestMailOperation *self,
 335                                GObject *me);
 336
 337 /**
 338  * modest_mail_operation_get_source
 339  * @self: a #ModestMailOperation
 340  *
 341  * returns a new reference to the object that created the mail
 342  * operation passed to the constructor, or NULL if none. The caller
 343  * must free the new reference
 344  **/
 345 GObject *
 346 modest_mail_operation_get_source (ModestMailOperation *self);
 347
 348 /* fill in other public functions, eg.: */
 349
 350 /**
 351  * modest_mail_operation_send_mail:
 352  * @self: a #ModestMailOperation
 353  * @transport_account: a non-NULL #TnyTransportAccount
 354  * @msg: a non-NULL #TnyMsg
 355  *
 356  * Sends and already existing message using the provided
 357  * #TnyTransportAccount. This operation is synchronous, so the
 358  * #ModestMailOperation should not be added to any
 359  * #ModestMailOperationQueue
 360   **/
 361 void    modest_mail_operation_send_mail       (ModestMailOperation *self,
 362                                                TnyTransportAccount *transport_account,
 363                                                TnyMsg* msg);
 364
 365 /**
 366  * modest_mail_operation_send_new_mail:
 367  * @self: a #ModestMailOperation
 368  * @transport_account: a non-NULL #TnyTransportAccount
 369  * @draft_msg: a #TnyMsg of the origin draft message, if any
 370  * @from: the email address of the mail sender
 371  * @to: a non-NULL email address of the mail receiver
 372  * @cc: a comma-separated list of email addresses where to send a carbon copy
 373  * @bcc: a comma-separated list of email addresses where to send a blind carbon copy
 374  * @subject: the subject of the new mail
 375  * @plain_body: the plain text body of the new mail.
 376  * @html_body: the html version of the body of the new mail. If NULL, the mail will
 377  *             be sent with the plain body only.
 378  * @attachments_list: a #GList of attachments, each attachment must be a #TnyMimePart
 379  * @images_list: a #GList of image attachments, each attachment must be a #TnyMimePart
 380  *
 381  * Sends a new mail message using the provided
 382  * #TnyTransportAccount. This operation is synchronous, so the
 383  * #ModestMailOperation should not be added to any
 384  * #ModestMailOperationQueue
 385   **/
 386 void    modest_mail_operation_send_new_mail   (ModestMailOperation *self,
 387                                                TnyTransportAccount *transport_account,
 388                                                TnyMsg *draft_msg,
 389                                                const gchar *from,
 390                                                const gchar *to,
 391                                                const gchar *cc,
 392                                                const gchar *bcc,
 393                                                const gchar *subject,
 394                                                const gchar *plain_body,
 395                                                const gchar *html_body,
 396                                                const GList *attachments_list,
 397                                                const GList *images_list,
 398                                                const gchar *references,
 399                                                const gchar *in_reply_to,
 400                                                TnyHeaderFlags priority_flags,
 401                                                TnyList *header_pairs);
 402
 403 void modest_mail_operation_send_mail (ModestMailOperation *mail_operation,
 404                                       TnyTransportAccount *transport_account,
 405                                       TnyMsg *msg);
 406
 407 /**
 408  * modest_mail_operation_save_to_drafts:
 409  * @self: a #ModestMailOperation
 410  * @transport_account: a non-NULL #TnyTransportAccount
 411  * @draft_msg: the previous draft message, in case it's an update
 412  * to an existing draft.
 413  * @from: the email address of the mail sender
 414  * @to: a non-NULL email address of the mail receiver
 415  * @cc: a comma-separated list of email addresses where to send a carbon copy
 416  * @bcc: a comma-separated list of email addresses where to send a blind carbon copy
 417  * @subject: the subject of the new mail
 418  * @plain_body: the plain text body of the new mail.
 419  * @html_body: the html version of the body of the new mail. If NULL, the mail will
 420  *             be sent with the plain body only.
 421  * @attachments_list: a #GList of attachments, each attachment must be a #TnyMimePart
 422  * @images_list: a #GList of image attachments, each attachment must be a #TnyMimePart
 423  * @callback: the user callback, will be called when the operation finishes
 424  * @user_data: data that will be passed to the user callback
 425  *
 426  * Save a mail message to drafts using the provided
 427  * #TnyTransportAccount. This operation is asynchronous.
 428  *
 429   **/
 430 void modest_mail_operation_save_to_drafts   (ModestMailOperation *self,
 431                                              TnyTransportAccount *transport_account,
 432                                              TnyMsg *draft_msg,
 433                                              const gchar *from,
 434                                              const gchar *to,
 435                                              const gchar *cc,
 436                                              const gchar *bcc,
 437                                              const gchar *subject,
 438                                              const gchar *plain_body,
 439                                              const gchar *html_body,
 440                                              const GList *attachments_list,
 441                                              const GList *images_list,
 442                                              TnyHeaderFlags priority_flags,
 443                                              const gchar *references,
 444                                              const gchar *in_reply_to,
 445                                              TnyList *header_pairs,
 446                                              SaveToDraftstCallback callback,
 447                                              gpointer user_data);
 448 /**
 449  * modest_mail_operation_update_account:
 450  * @self: a #ModestMailOperation
 451  * @account_name: the id of a Modest account
 452  * @poke_all: if TRUE it will also do a poke_status over all folders of the account
 453  * @interactive: if TRUE the update account was scheduled by an interactive send receive
 454  *
 455  * Asynchronously refreshes the root folders of the given store
 456  * account. The caller should add the #ModestMailOperation to a
 457  * #ModestMailOperationQueue and then free it. The caller will be
 458  * notified by the "progress_changed" signal each time the progress of
 459  * the operation changes.
 460  *
 461  * Example
 462  * <informalexample><programlisting>
 463  * queue = modest_tny_platform_factory_get_modest_mail_operation_queue_instance (fact)
 464  * mail_op = modest_mail_operation_new ();
 465  * g_signal_connect (G_OBJECT (mail_op), "progress_changed", G_CALLBACK(on_progress_changed), NULL);
 466  * modest_mail_operation_queue_add (queue, mail_op);
 467  * modest_mail_operation_update_account (mail_op, account_name)
 468  * g_object_unref (G_OBJECT (mail_op));
 469  * </programlisting></informalexample>
 470  *
 471  * Note that the account_name *MUST* be a modest account name, not a
 472  * tinymail store account name
 473  *
 474  **/
 475 void          modest_mail_operation_update_account (ModestMailOperation *self,
 476                                                     const gchar *account_name,
 477                                                     gboolean poke_all,
 478                                                     gboolean interactive,
 479                                                     UpdateAccountCallback callback,
 480                                                     gpointer user_data);
 481
 482 /**
 483  * modest_mail_operation_update_folder_counts:
 484  * @self: a #ModestMailOperation
 485  * @account_name: the id of a Modest account
 486  *
 487  * Asynchronously refreshes the folder counts of the given store
 488  * account.
 489  */
 490 void          modest_mail_operation_update_folder_counts (ModestMailOperation *self,
 491                                                           const gchar *account_name);
 492
 493 /* Functions that perform store operations */
 494
 495 /**
 496  * modest_mail_operation_create_folder:
 497  * @self: a #ModestMailOperation
 498  * @parent: the #TnyFolderStore which is the parent of the new folder
 499  * @name: the non-NULL new name for the new folder
 500  *
 501  * Creates a new folder as a children of a existing one. If the store
 502  * account supports subscriptions this method also sets the new folder
 503  * as subscribed. This operation is synchronous, so the
 504  * #ModestMailOperation should not be added to any
 505  * #ModestMailOperationQueue
 506  *
 507  * Returns: a newly created #TnyFolder or NULL in case of error.
 508  **/
 509 void    modest_mail_operation_create_folder  (ModestMailOperation *self,
 510                                               TnyFolderStore *parent,
 511                                               const gchar *name,
 512                                               CreateFolderUserCallback callback,
 513                                               gpointer user_data);
 514
 515 /**
 516  * modest_mail_operation_remove_folder:
 517  * @self: a #ModestMailOperation
 518  * @folder: a #TnyFolder
 519  * @remove_to_trash: TRUE to move it to trash or FALSE to delete
 520  * permanently
 521  *
 522  * Removes a folder. This operation is synchronous, so the
 523  * #ModestMailOperation should not be added to any
 524  * #ModestMailOperationQueue
 525  **/
 526 void          modest_mail_operation_remove_folder  (ModestMailOperation *self,
 527                                                     TnyFolder *folder,
 528                                                     gboolean remove_to_trash);
 529
 530 /**
 531  * modest_mail_operation_rename_folder:
 532  * @self: a #ModestMailOperation
 533  * @folder: a #TnyFolder
 534  * @name: a non-NULL name without "/"
 535  *
 536  * Renames a given folder with the provided new name. This operation
 537  * is synchronous, so the #ModestMailOperation should not be added to
 538  * any #ModestMailOperationQueue
 539  **/
 540 void          modest_mail_operation_rename_folder  (ModestMailOperation *self,
 541                                                     TnyFolder *folder,
 542                                                     const gchar *name,
 543                                                     XferFolderAsyncUserCallback user_callback,
 544                                                     gpointer user_data);
 545
 546 /**
 547  * modest_mail_operation_xfer_folder:
 548  * @self: a #ModestMailOperation
 549  * @folder: a #TnyFolder
 550  * @parent: the new parent of the folder as #TnyFolderStore
 551  * @delete_original: wheter or not delete the original folder
 552  * @user_callback: a #XferFolderAsyncUserCallback function to call after tinymail callback execution.
 553  * @user_data: generic user data which will be passed to @user_callback function.
 554  *
 555  * Sets the given @folder as child of a provided #TnyFolderStore. This
 556  * operation also transfers all the messages contained in the folder
 557  * and all of his children folders with their messages as well. This
 558  * operation is synchronous, so the #ModestMailOperation should not be
 559  * added to any #ModestMailOperationQueue.
 560  *
 561  * If @delete_original is TRUE this function moves the original
 562  * folder, if it is FALSE the it just copies it
 563  *
 564  **/
 565 void          modest_mail_operation_xfer_folder    (ModestMailOperation *self,
 566                                                     TnyFolder *folder,
 567                                                     TnyFolderStore *parent,
 568                                                     gboolean delete_original,
 569                                                     XferFolderAsyncUserCallback user_callback,
 570                                                     gpointer user_data);
 571
 572
 573 /* Functions that performs msg operations */
 574
 575 /**
 576  * modest_mail_operation_xfer_msgs:
 577  * @self: a #ModestMailOperation
 578  * @header_list: a #TnyList of #TnyHeader to transfer
 579  * @folder: the #TnyFolder where the messages will be transferred
 580  * @delete_original: whether or not delete the source messages
 581  * @user_callback: a #XferFolderAsyncUserCallback function to call after tinymail callback execution.
 582  * @user_data: generic user data which will be passed to @user_callback function.
 583  *
 584  * Asynchronously transfers messages from their current folder to
 585  * another one. The caller should add the #ModestMailOperation to a
 586  * #ModestMailOperationQueue and then free it. The caller will be
 587  * notified by the "progress_changed" when the operation is completed.
 588  *
 589  * If the @delete_original paramter is TRUE then this function moves
 590  * the messages between folders, otherwise it copies them.
 591  *
 592  * Example
 593  * <informalexample><programlisting>
 594  * queue = modest_tny_platform_factory_get_modest_mail_operation_queue_instance (fact);
 595  * mail_op = modest_mail_operation_new ();
 596  * modest_mail_operation_queue_add (queue, mail_op);
 597  * g_signal_connect (G_OBJECT (mail_op), "progress_changed", G_CALLBACK(on_progress_changed), queue);
 598  *
 599  * modest_mail_operation_xfer_msg (mail_op, headers, folder, TRUE);
 600  *
 601  * g_object_unref (G_OBJECT (mail_op));
 602  * </programlisting></informalexample>
 603  *
 604  **/
 605 void          modest_mail_operation_xfer_msgs      (ModestMailOperation *self,
 606                                                     TnyList *header_list,
 607                                                     TnyFolder *folder,
 608                                                     gboolean delete_original,
 609                                                     XferMsgsAsyncUserCallback user_callback,
 610                                                     gpointer user_data);
 611
 612 /**
 613  * modest_mail_operation_remove_msgs:
 614  * @self: a #ModestMailOperation
 615  * @headers: the #TnyList of the messages to delete
 616  * @remove_to_trash: TRUE to move it to trash or FALSE to delete it
 617  * permanently
 618  *
 619  * Deletes a list of messages.
 620  **/
 621 void          modest_mail_operation_remove_msgs     (ModestMailOperation *self,
 622                                                      TnyList *headers,
 623                                                      gboolean remove_to_trash);
 624
 625 /**
 626  * modest_mail_operation_get_msg_and_parts:
 627  * @self: a #ModestMailOperation
 628  * @header_list: the #TnyHeader of the message to get
 629  * @progress_feedback: a #gboolean. If %TRUE, we'll get progress bar feedback.
 630  * @user_callback: a #GetMsgAsyncUserCallback function to call after tinymail callback execution.
 631  * @user_data: generic user data which will be passed to @user_callback function.
 632  *
 633  * Gets a message from header using an user defined @callback function
 634  * pased as argument. This operation is asynchronous, so the
 635  * #ModestMailOperation should be added to #ModestMailOperationQueue
 636  *
 637  * This operation also retrieves to cache all parts of the message. This is needed for
 638  * forward operation.
 639  **/
 640 void          modest_mail_operation_get_msg_and_parts     (ModestMailOperation *self,
 641                                                            TnyHeader *header,
 642                                                            TnyList *parts,
 643                                                            gboolean progress_feedback,
 644                                                            GetMsgAsyncUserCallback user_callback,
 645                                                            gpointer user_data);
 646 /**
 647  * modest_mail_operation_get_msg:
 648  * @self: a #ModestMailOperation
 649  * @header_list: the #TnyHeader of the message to get
 650  * @progress_feedback: a #gboolean. If %TRUE, we'll get progress bar feedback.
 651  * @user_callback: a #GetMsgAsyncUserCallback function to call after tinymail callback execution.
 652  * @user_data: generic user data which will be passed to @user_callback function.
 653  *
 654  * Gets a message from header using an user defined @callback function
 655  * pased as argument. This operation is asynchronous, so the
 656  * #ModestMailOperation should be added to #ModestMailOperationQueue
 657  **/
 658 void          modest_mail_operation_get_msg     (ModestMailOperation *self,
 659                                                  TnyHeader *header,
 660                                                  gboolean progress_feedback,
 661                                                  GetMsgAsyncUserCallback user_callback,
 662                                                  gpointer user_data);
 663 /**
 664  * modest_mail_operation_find_msg:
 665  * @self: a #ModestMailOperation
 666  * @msg_uid: a string
 667  * @progress_feedback: a #gboolean. If %TRUE, we'll get progress bar feedback.
 668  * @user_callback: a #GetMsgAsyncUserCallback function to call after tinymail callback execution.
 669  * @user_data: generic user data which will be passed to @user_callback function.
 670  *
 671  * Gets a message from a uid using an user defined @callback function
 672  * pased as argument. This operation is asynchronous, so the
 673  * #ModestMailOperation should be added to #ModestMailOperationQueue
 674  **/
 675 void          modest_mail_operation_find_msg     (ModestMailOperation *self,
 676                                                   TnyFolder *folder,
 677                                                   const gchar *msg_uid,
 678                                                   gboolean progress_feedback,
 679                                                   GetMsgAsyncUserCallback user_callback,
 680                                                   gpointer user_data);
 681
 682 /**
 683  * modest_mail_operation_get_msgs_full:
 684  * @self: a #ModestMailOperation
 685  * @header_list: a #TnyList of #TnyHeader objects to get and process
 686  * @user_callback: a #TnyGetMsgCallback function to call after tinymail operation execution.
 687  * @user_data: user data passed to both, user_callback and update_status_callback.
 688  *
 689  * Gets messages from headers list and process hem using @callback function
 690  * pased as argument. This operation is asynchronous, so the
 691  * #ModestMailOperation should be added to #ModestMailOperationQueue
 692  **/
 693 void          modest_mail_operation_get_msgs_full   (ModestMailOperation *self,
 694                                                      TnyList *headers_list,
 695                                                      GetMsgAsyncUserCallback user_callback,
 696                                                      gpointer user_data,
 697                                                      GDestroyNotify notify);
 698
 699 /**
 700  * modest_mail_operation_run_queue:
 701  * @self: a #ModestMailOperation
 702  * @queue: a #ModestTnySendQueue
 703  *
 704  * This mail operation is special. It should be running every time the send queue
 705  * is running (after queue-start), and we should notify end of the operation
 706  * after queue-end. Then, we should only set this queue on queue-start signal, and
 707  * it will clean up the operation (notify end) on queue-end.
 708  */
 709 void          modest_mail_operation_run_queue       (ModestMailOperation *self,
 710                                                      ModestTnySendQueue *queue);
 711
 712 /**
 713  * modest_mail_operation_queue_wakeup:
 714  * @self: a #ModestMailOperation
 715  * @queue: a #ModestTnySendQueue
 716  *
 717  * This mail operation is special. It should be running every time the send queue
 718  * wakeup is running and we should notify end of the operation
 719  * after wakeup has done msg-sent notification.
 720  */
 721 void          modest_mail_operation_queue_wakeup       (ModestMailOperation *self,
 722                                                         ModestTnySendQueue *queue);
 723
 724 /**
 725  * modest_mail_operation_sync_folder:
 726  * @self: a #ModestMailOperation
 727  * @folder: a #TnyFolder
 728  * @expunge: a #gboolean
 729  *
 730  * mail operation wrapper around tny_folder_sync () method, to keep modest
 731  * running while we do that sync operation.
 732  */
 733 void          modest_mail_operation_sync_folder     (ModestMailOperation *self,
 734                                                      TnyFolder *folder,
 735                                                      gboolean expunge,
 736                                                      SyncFolderCallback callback,
 737                                                      gpointer user_data);
 738
 739 /**
 740  * modest_mail_operation_shutdown:
 741  * @self: a #ModestMailOperation
 742  * @account_store: a #ModestTnyAccountStore
 743  *
 744  * disconnects all accounts in the account store (doing the proper syncs).
 745  */
 746 void          modest_mail_operation_shutdown        (ModestMailOperation *self,
 747                                                      ModestTnyAccountStore *account_store);
 748
 749 /* Functions to control mail operations */
 750 /**
 751  * modest_mail_operation_get_task_done:
 752  * @self: a #ModestMailOperation
 753  *
 754  * Gets the amount of work done for a given mail operation. This
 755  * amount of work is an absolute value.
 756  *
 757  * Returns: the amount of work completed
 758  **/
 759 guint     modest_mail_operation_get_task_done      (ModestMailOperation *self);
 760
 761 /**
 762  * modest_mail_operation_get_task_total:
 763  * @self: a #ModestMailOperation
 764  *
 765  * Gets the total amount of work that must be done to complete a given
 766  * mail operation. This amount of work is an absolute value.
 767  *
 768  * Returns: the total required amount of work
 769  **/
 770 guint     modest_mail_operation_get_task_total     (ModestMailOperation *self);
 771
 772
 773 /**
 774  * modest_mail_operation_is_finished:
 775  * @self: a #ModestMailOperation
 776  *
 777  * Checks if the operation is finished. A #ModestMailOperation is
 778  * finished if it's in any of the following states:
 779  * MODEST_MAIL_OPERATION_STATUS_SUCCESS,
 780  * MODEST_MAIL_OPERATION_STATUS_FAILED,
 781  * MODEST_MAIL_OPERATION_STATUS_CANCELED or
 782  * MODEST_MAIL_OPERATION_STATUS_FINISHED_WITH_ERRORS
 783  *
 784  * Returns: TRUE if the operation is finished, FALSE otherwise
 785  **/
 786 gboolean  modest_mail_operation_is_finished        (ModestMailOperation *self);
 787
 788 /**
 789  * modest_mail_operation_is_finished:
 790  * @self: a #ModestMailOperation
 791  *
 792  * Gets the current status of the given mail operation
 793  *
 794  * Returns: the current status or MODEST_MAIL_OPERATION_STATUS_INVALID in case of error
 795  **/
 796 ModestMailOperationStatus modest_mail_operation_get_status  (ModestMailOperation *self);
 797
 798 /**
 799  * modest_mail_operation_get_error:
 800  * @self: a #ModestMailOperation
 801  *
 802  * Gets the error associated to the mail operation if exists
 803  *
 804  * Returns: the #GError associated to the #ModestMailOperation if it
 805  * exists or NULL otherwise
 806  **/
 807 const GError*             modest_mail_operation_get_error   (ModestMailOperation *self);
 808
 809 /**
 810  * modest_mail_operation_cancel:
 811  * @self: a #ModestMailOperation
 812  *
 813  * Cancels an active mail operation
 814  *
 815  * Returns: TRUE if the operation was succesfully canceled, FALSE otherwise
 816  **/
 817 gboolean  modest_mail_operation_cancel          (ModestMailOperation *self);
 818
 819 /**
 820  * modest_mail_operation_refresh_folder
 821  * @self: a #ModestMailOperation
 822  * @folder: the #TnyFolder to refresh
 823  * @user_callback: the #RefreshAsyncUserCallback function to be called
 824  * after internal refresh async callback was being executed.
 825  *
 826  * Refreshes the contents of a folder. After internal callback was executed,
 827  * and all interna mail operation field were filled, if exists, it calls an
 828  * user callback function to make UI operations which must be done after folder
 829  * was refreshed.
 830  */
 831 void      modest_mail_operation_refresh_folder  (ModestMailOperation *self,
 832                                                  TnyFolder *folder,
 833                                                  RefreshAsyncUserCallback user_callback,
 834                                                  gpointer user_data);
 835
 836 /**
 837  * modest_mail_operation_get_account:
 838  * @self: a #ModestMailOperation
 839  *
 840  * Gets the account associated to a mail operation
 841  *
 842  * Returns: the #TnyAccount associated to the #ModestMailOperation
 843  **/
 844 TnyAccount *modest_mail_operation_get_account   (ModestMailOperation *self);
 845
 846
 847 /**
 848  * modest_mail_operation_noop:
 849  * @self: a #ModestMailOperation
 850  *
 851  * Does nothing except emitting operation-started and
 852  * operation-finished
 853  **/
 854 void modest_mail_operation_noop (ModestMailOperation *self);
 855
 856
 857 /**
 858  * modest_mail_operation_to_string:
 859  * @self: a #ModestMailOperation
 860  *
 861  * get a string representation of the mail operation (for debugging)
 862  *
 863  * Returns: a newly allocated string
 864  **/
 865 gchar* modest_mail_operation_to_string (ModestMailOperation *self);
 866
 867
 868 G_END_DECLS
 869
 870 #endif /* __MODEST_MAIL_OPERATION_H__ */
 871