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 <widgets/modest-msg-edit-window.h>
  36 #include <modest-tny-send-queue.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_SEND,
  75         MODEST_MAIL_OPERATION_TYPE_OPEN,
  76         MODEST_MAIL_OPERATION_TYPE_DELETE,
  77         MODEST_MAIL_OPERATION_TYPE_INFO,
  78         MODEST_MAIL_OPERATION_TYPE_RUN_QUEUE,
  79         MODEST_MAIL_OPERATION_TYPE_SYNC_FOLDER,
  80         MODEST_MAIL_OPERATION_TYPE_UNKNOWN,
  81 } ModestMailOperationTypeOperation;
  82
  83 /**
  84  * ErrorCheckingUserCallback:
  85  *
  86  * @mail_op: the current mail operation.
  87  * @user_data: generic data passed to user defined function.
  88  *
  89  * This function implements required actions to performs under error
  90  * states.
  91  */
  92 typedef void (*ErrorCheckingUserCallback) (ModestMailOperation *mail_op, gpointer user_data);
  93
  94 /**
  95  * ErrorCheckingUserDataDestroyer:
  96  *
  97  * @user_data: generic data passed to user defined function.
  98  *
  99  * This function is used to destroy the user_data passed to the error
 100  * checking user callback function
 101  */
 102 typedef void (*ErrorCheckingUserDataDestroyer) (gpointer user_data);
 103
 104
 105 /**
 106  * GetMsgAsyncUserCallback:
 107  *
 108  * @mail_op: the current #ModestMailOperation.
 109  * @header: a #TnyHeader summary item.
 110  * @msg: a #TnyMsg message retrieved by async operation.
 111  * @user_data: generic data passed to user defined function.
 112  *
 113  * This function will be called after get_msg_cb private function, which is
 114  * used as tinymail operation callback. The private function fills private
 115  * fields of mail operation and calls user defined callback if it exists.
 116  */
 117 typedef void (*GetMsgAsyncUserCallback) (ModestMailOperation *mail_op,
 118                                          TnyHeader *header,
 119                                          gboolean canceled,
 120                                          TnyMsg *msg,
 121                                          GError *err,
 122                                          gpointer user_data);
 123
 124 /**
 125  * GetMimePartSizeCallback:
 126  *
 127  * @mail_op: the current #ModestMailOperation.
 128  * @size: size of the attachment
 129  * @user_data: generic data passed to user defined function.
 130  *
 131  */
 132 typedef void (*GetMimePartSizeCallback) (ModestMailOperation *mail_op,
 133                                          gssize size,
 134                                          gpointer user_data);
 135
 136 /**
 137  * XferMsgsAsyncUserCallback:
 138  *
 139  * @obj: a #GObject generic object which has created current mail operation.
 140  * @new_folder: the new instance of the #TnyFolder that has been transferred
 141  * @user_data: generic data passed to user defined function.
 142  *
 143  * This function will be called after transfer_msgs_cb private function, which is
 144  * used as tinymail operation callback. The private function fills private
 145  * fields of mail operation and calls user defined callback if it exists.
 146  */
 147 typedef void (*XferMsgsAsyncUserCallback) (ModestMailOperation *mail_op,
 148                                            gpointer user_data);
 149
 150
 151 /**
 152  * XferFolderAsyncUserCallback:
 153  *
 154  * @obj: a #GObject generic object which has created current mail operation.
 155  * @new_folder: the new instance of the #TnyFolder that has been transferred
 156  * @user_data: generic data passed to user defined function.
 157  *
 158  * This function will be called after transfer_msgs_cb private function, which is
 159  * used as tinymail operation callback. The private function fills private
 160  * fields of mail operation and calls user defined callback if it exists.
 161  */
 162 typedef void (*XferFolderAsyncUserCallback) (ModestMailOperation *mail_op,
 163                                              TnyFolder *new_folder,
 164                                              gpointer user_data);
 165
 166
 167 /**
 168  * RefreshAsyncUserCallback:
 169  *
 170  * @mail_op: the current #ModestMailOperation.
 171  * @folder: a #TnyFolder which has been refreshed .
 172  * @user_data: generic data passed to user defined function.
 173  *
 174  * This function will be called after refresh_folder_async_cb private function, which is
 175  * used as tinymail operation callback. The private function fills private
 176  * fields of mail operation and calls user defined callback if it exists.
 177  */
 178 typedef void (*RefreshAsyncUserCallback) (ModestMailOperation *mail_op,
 179                                           TnyFolder *folder,
 180                                           gpointer user_data);
 181
 182 /**
 183  * UpdateAccountCallback:
 184  *
 185  * @self: a #ModestMailOperation
 186  * @new_headers: the list of new headers received
 187  * @user_data: generic data passed to user defined function.
 188  *
 189  * This is the callback of the update_account operation. It informs
 190  * the caller about the amount of new messages that have been
 191  * downloaded
 192  */
 193 typedef void (*UpdateAccountCallback) (ModestMailOperation *self,
 194                                        TnyList *new_headers,
 195                                        gpointer user_data);
 196
 197 /**
 198  * SaveToDraftsCallback:
 199  *
 200  * @self: a #ModestMailOperation
 201  * @saved_draft: the new draft message that has been saved
 202  * @user_data: generic data passed to user defined function.
 203  *
 204  * This is the callback of the save_to_drafts operation. It returns
 205  * the newly created msg stored in the Drafts folder
 206  */
 207 typedef void (*SaveToDraftstCallback) (ModestMailOperation *self,
 208                                        TnyMsg *saved_draft,
 209                                        gpointer user_data);
 210
 211
 212 typedef gboolean (*RetrieveAllCallback) (GObject *source,
 213                                          guint num_msgs,
 214                                          guint limit);
 215
 216 /**
 217  * CreateFolderUserCallback:
 218  *
 219  * @mail_op: the current #ModestMailOperation.
 220  * @folder: a #TnyFolder summary item.
 221  * @user_data: generic data passed to user defined function.
 222  *
 223  * This function will be called after get_msg_cb private function, which is
 224  * used as tinymail operation callback. The private function fills private
 225  * fields of mail operation and calls user defined callback if it exists.
 226  */
 227 typedef void (*CreateFolderUserCallback) (ModestMailOperation *mail_op,
 228                                           TnyFolderStore *parent_folder,
 229                                           TnyFolder *new_folder,
 230                                           gpointer user_data);
 231
 232 /* This struct represents the internal state of a mail operation in a
 233    given time */
 234 typedef struct {
 235         guint      done;
 236         guint      total;
 237         gdouble    bytes_done;
 238         gdouble    bytes_total;
 239         gboolean   finished;
 240         ModestMailOperationStatus        status;
 241         ModestMailOperationTypeOperation op_type;
 242 } ModestMailOperationState;
 243
 244
 245 struct _ModestMailOperation {
 246          GObject parent;
 247         /* insert public members, if any */
 248 };
 249
 250 struct _ModestMailOperationClass {
 251         GObjectClass parent_class;
 252
 253         /* Signals */
 254         void (*progress_changed) (ModestMailOperation *self, ModestMailOperationState *state, gpointer user_data);
 255         void (*operation_started) (ModestMailOperation *self, gpointer user_data);
 256         void (*operation_finished) (ModestMailOperation *self, gpointer user_data);
 257 };
 258
 259 /* member functions */
 260 GType        modest_mail_operation_get_type    (void) G_GNUC_CONST;
 261
 262 /**
 263  * modest_mail_operation_new:
 264  * @source: a #GObject which creates this new operation.
 265  *
 266  * Creates a new instance of class #ModestMailOperation, using parameters
 267  * to initialize its private structure. @source parameter may be NULL.
 268  **/
 269 ModestMailOperation*    modest_mail_operation_new     (GObject *source);
 270
 271 /**
 272  * modest_mail_operation_new_with_error_handling:
 273  * @id: a #ModestMailOperationId identification of operation type.
 274  * @source: a #GObject which creates this new operation.
 275  * @error_handler: a #ErrorCheckingUserCallback function to performs operations when
 276  * an error occurs.
 277  *
 278  * Creates a new instance of class #ModestMailOperation, using parameters
 279  * to initialize its private structure. @source parameter may be NULL.
 280  * @error_handler can not be NULL, but it will be returned an mail operation
 281  * object without error handling capability.
 282  **/
 283 ModestMailOperation*    modest_mail_operation_new_with_error_handling     (GObject *source,
 284                                                                            ErrorCheckingUserCallback error_handler,
 285                                                                            gpointer user_data,
 286                                                                            ErrorCheckingUserDataDestroyer error_handler_destroyer);
 287 /**
 288  * modest_mail_operation_execute_error_handler
 289  * @self: a #ModestMailOperation
 290  *
 291  * Executes error handler if exists. The error handler is the one that
 292  * MUST free the user data passed to the
 293  * modest_mail_operation_new_with_error_handling constructor
 294  **/
 295 void
 296 modest_mail_operation_execute_error_handler (ModestMailOperation *self);
 297
 298 /**
 299  * modest_mail_operation_get_type_operation
 300  * @self: a #ModestMailOperation
 301  *
 302  * Gets the private op_type field of mail operation. This op_type
 303  * identifies the class/type of mail operation.
 304  **/
 305 ModestMailOperationTypeOperation
 306 modest_mail_operation_get_type_operation (ModestMailOperation *self);
 307
 308 /**
 309  * modest_mail_operation_is_mine
 310  * @self: a #ModestMailOperation
 311  * @source: a #GObject to check if it have created @self operation.
 312  *
 313  * Check if @source object its owner of @self mail operation.
 314  *
 315  * returns: TRUE if source its owner, FALSE otherwise.
 316  **/
 317 gboolean
 318 modest_mail_operation_is_mine (ModestMailOperation *self,
 319                                GObject *me);
 320
 321 /**
 322  * modest_mail_operation_get_source
 323  * @self: a #ModestMailOperation
 324  *
 325  * returns a new reference to the object that created the mail
 326  * operation passed to the constructor, or NULL if none. The caller
 327  * must free the new reference
 328  **/
 329 GObject *
 330 modest_mail_operation_get_source (ModestMailOperation *self);
 331
 332 /* fill in other public functions, eg.: */
 333
 334 /**
 335  * modest_mail_operation_send_mail:
 336  * @self: a #ModestMailOperation
 337  * @transport_account: a non-NULL #TnyTransportAccount
 338  * @msg: a non-NULL #TnyMsg
 339  *
 340  * Sends and already existing message using the provided
 341  * #TnyTransportAccount. This operation is synchronous, so the
 342  * #ModestMailOperation should not be added to any
 343  * #ModestMailOperationQueue
 344   **/
 345 void    modest_mail_operation_send_mail       (ModestMailOperation *self,
 346                                                TnyTransportAccount *transport_account,
 347                                                TnyMsg* msg);
 348
 349 /**
 350  * modest_mail_operation_send_new_mail:
 351  * @self: a #ModestMailOperation
 352  * @transport_account: a non-NULL #TnyTransportAccount
 353  * @draft_msg: a #TnyMsg of the origin draft message, if any
 354  * @from: the email address of the mail sender
 355  * @to: a non-NULL email address of the mail receiver
 356  * @cc: a comma-separated list of email addresses where to send a carbon copy
 357  * @bcc: a comma-separated list of email addresses where to send a blind carbon copy
 358  * @subject: the subject of the new mail
 359  * @plain_body: the plain text body of the new mail.
 360  * @html_body: the html version of the body of the new mail. If NULL, the mail will
 361  *             be sent with the plain body only.
 362  * @attachments_list: a #GList of attachments, each attachment must be a #TnyMimePart
 363  * @images_list: a #GList of image attachments, each attachment must be a #TnyMimePart
 364  *
 365  * Sends a new mail message using the provided
 366  * #TnyTransportAccount. This operation is synchronous, so the
 367  * #ModestMailOperation should not be added to any
 368  * #ModestMailOperationQueue
 369   **/
 370 void    modest_mail_operation_send_new_mail   (ModestMailOperation *self,
 371                                                TnyTransportAccount *transport_account,
 372                                                TnyMsg *draft_msg,
 373                                                const gchar *from,
 374                                                const gchar *to,
 375                                                const gchar *cc,
 376                                                const gchar *bcc,
 377                                                const gchar *subject,
 378                                                const gchar *plain_body,
 379                                                const gchar *html_body,
 380                                                const GList *attachments_list,
 381                                                const GList *images_list,
 382                                                TnyHeaderFlags priority_flags);
 383
 384
 385 /**
 386  * modest_mail_operation_save_to_drafts:
 387  * @self: a #ModestMailOperation
 388  * @transport_account: a non-NULL #TnyTransportAccount
 389  * @draft_msg: the previous draft message, in case it's an update
 390  * to an existing draft.
 391  * @from: the email address of the mail sender
 392  * @to: a non-NULL email address of the mail receiver
 393  * @cc: a comma-separated list of email addresses where to send a carbon copy
 394  * @bcc: a comma-separated list of email addresses where to send a blind carbon copy
 395  * @subject: the subject of the new mail
 396  * @plain_body: the plain text body of the new mail.
 397  * @html_body: the html version of the body of the new mail. If NULL, the mail will
 398  *             be sent with the plain body only.
 399  * @attachments_list: a #GList of attachments, each attachment must be a #TnyMimePart
 400  * @images_list: a #GList of image attachments, each attachment must be a #TnyMimePart
 401  * @callback: the user callback, will be called when the operation finishes
 402  * @user_data: data that will be passed to the user callback
 403  *
 404  * Save a mail message to drafts using the provided
 405  * #TnyTransportAccount. This operation is asynchronous.
 406  *
 407   **/
 408 void modest_mail_operation_save_to_drafts   (ModestMailOperation *self,
 409                                              TnyTransportAccount *transport_account,
 410                                              TnyMsg *draft_msg,
 411                                              const gchar *from,
 412                                              const gchar *to,
 413                                              const gchar *cc,
 414                                              const gchar *bcc,
 415                                              const gchar *subject,
 416                                              const gchar *plain_body,
 417                                              const gchar *html_body,
 418                                              const GList *attachments_list,
 419                                              const GList *images_list,
 420                                              TnyHeaderFlags priority_flags,
 421                                              SaveToDraftstCallback callback,
 422                                              gpointer user_data);
 423 /**
 424  * modest_mail_operation_update_account:
 425  * @self: a #ModestMailOperation
 426  * @account_name: the id of a Modest account
 427  * @poke_all: if TRUE it will also do a poke_status over all folders of the account
 428  *
 429  * Asynchronously refreshes the root folders of the given store
 430  * account. The caller should add the #ModestMailOperation to a
 431  * #ModestMailOperationQueue and then free it. The caller will be
 432  * notified by the "progress_changed" signal each time the progress of
 433  * the operation changes.
 434  *
 435  * Example
 436  * <informalexample><programlisting>
 437  * queue = modest_tny_platform_factory_get_modest_mail_operation_queue_instance (fact)
 438  * mail_op = modest_mail_operation_new ();
 439  * g_signal_connect (G_OBJECT (mail_op), "progress_changed", G_CALLBACK(on_progress_changed), NULL);
 440  * modest_mail_operation_queue_add (queue, mail_op);
 441  * modest_mail_operation_update_account (mail_op, account_name)
 442  * g_object_unref (G_OBJECT (mail_op));
 443  * </programlisting></informalexample>
 444  *
 445  * Note that the account_name *MUST* be a modest account name, not a
 446  * tinymail store account name
 447  *
 448  **/
 449 void          modest_mail_operation_update_account (ModestMailOperation *self,
 450                                                     const gchar *account_name,
 451                                                     gboolean poke_all,
 452                                                     RetrieveAllCallback retrieve_all_cb,
 453                                                     UpdateAccountCallback callback,
 454                                                     gpointer user_data);
 455
 456 /* Functions that perform store operations */
 457
 458 /**
 459  * modest_mail_operation_create_folder:
 460  * @self: a #ModestMailOperation
 461  * @parent: the #TnyFolderStore which is the parent of the new folder
 462  * @name: the non-NULL new name for the new folder
 463  *
 464  * Creates a new folder as a children of a existing one. If the store
 465  * account supports subscriptions this method also sets the new folder
 466  * as subscribed. This operation is synchronous, so the
 467  * #ModestMailOperation should not be added to any
 468  * #ModestMailOperationQueue
 469  *
 470  * Returns: a newly created #TnyFolder or NULL in case of error.
 471  **/
 472 void    modest_mail_operation_create_folder  (ModestMailOperation *self,
 473                                               TnyFolderStore *parent,
 474                                               const gchar *name,
 475                                               CreateFolderUserCallback callback,
 476                                               gpointer user_data);
 477
 478 /**
 479  * modest_mail_operation_remove_folder:
 480  * @self: a #ModestMailOperation
 481  * @folder: a #TnyFolder
 482  * @remove_to_trash: TRUE to move it to trash or FALSE to delete
 483  * permanently
 484  *
 485  * Removes a folder. This operation is synchronous, so the
 486  * #ModestMailOperation should not be added to any
 487  * #ModestMailOperationQueue
 488  **/
 489 void          modest_mail_operation_remove_folder  (ModestMailOperation *self,
 490                                                     TnyFolder *folder,
 491                                                     gboolean remove_to_trash);
 492
 493 /**
 494  * modest_mail_operation_rename_folder:
 495  * @self: a #ModestMailOperation
 496  * @folder: a #TnyFolder
 497  * @name: a non-NULL name without "/"
 498  *
 499  * Renames a given folder with the provided new name. This operation
 500  * is synchronous, so the #ModestMailOperation should not be added to
 501  * any #ModestMailOperationQueue
 502  **/
 503 void          modest_mail_operation_rename_folder  (ModestMailOperation *self,
 504                                                     TnyFolder *folder,
 505                                                     const gchar *name,
 506                                                     XferFolderAsyncUserCallback user_callback,
 507                                                     gpointer user_data);
 508
 509 /**
 510  * modest_mail_operation_xfer_folder:
 511  * @self: a #ModestMailOperation
 512  * @folder: a #TnyFolder
 513  * @parent: the new parent of the folder as #TnyFolderStore
 514  * @delete_original: wheter or not delete the original folder
 515  * @user_callback: a #XferFolderAsyncUserCallback function to call after tinymail callback execution.
 516  * @user_data: generic user data which will be passed to @user_callback function.
 517  *
 518  * Sets the given @folder as child of a provided #TnyFolderStore. This
 519  * operation also transfers all the messages contained in the folder
 520  * and all of his children folders with their messages as well. This
 521  * operation is synchronous, so the #ModestMailOperation should not be
 522  * added to any #ModestMailOperationQueue.
 523  *
 524  * If @delete_original is TRUE this function moves the original
 525  * folder, if it is FALSE the it just copies it
 526  *
 527  **/
 528 void          modest_mail_operation_xfer_folder    (ModestMailOperation *self,
 529                                                     TnyFolder *folder,
 530                                                     TnyFolderStore *parent,
 531                                                     gboolean delete_original,
 532                                                     XferFolderAsyncUserCallback user_callback,
 533                                                     gpointer user_data);
 534
 535
 536 /* Functions that performs msg operations */
 537
 538 /**
 539  * modest_mail_operation_xfer_msgs:
 540  * @self: a #ModestMailOperation
 541  * @header_list: a #TnyList of #TnyHeader to transfer
 542  * @folder: the #TnyFolder where the messages will be transferred
 543  * @delete_original: whether or not delete the source messages
 544  * @user_callback: a #XferFolderAsyncUserCallback function to call after tinymail callback execution.
 545  * @user_data: generic user data which will be passed to @user_callback function.
 546  *
 547  * Asynchronously transfers messages from their current folder to
 548  * another one. The caller should add the #ModestMailOperation to a
 549  * #ModestMailOperationQueue and then free it. The caller will be
 550  * notified by the "progress_changed" when the operation is completed.
 551  *
 552  * If the @delete_original paramter is TRUE then this function moves
 553  * the messages between folders, otherwise it copies them.
 554  *
 555  * Example
 556  * <informalexample><programlisting>
 557  * queue = modest_tny_platform_factory_get_modest_mail_operation_queue_instance (fact);
 558  * mail_op = modest_mail_operation_new ();
 559  * modest_mail_operation_queue_add (queue, mail_op);
 560  * g_signal_connect (G_OBJECT (mail_op), "progress_changed", G_CALLBACK(on_progress_changed), queue);
 561  *
 562  * modest_mail_operation_xfer_msg (mail_op, headers, folder, TRUE);
 563  *
 564  * g_object_unref (G_OBJECT (mail_op));
 565  * </programlisting></informalexample>
 566  *
 567  **/
 568 void          modest_mail_operation_xfer_msgs      (ModestMailOperation *self,
 569                                                     TnyList *header_list,
 570                                                     TnyFolder *folder,
 571                                                     gboolean delete_original,
 572                                                     XferMsgsAsyncUserCallback user_callback,
 573                                                     gpointer user_data);
 574
 575 /**
 576  * modest_mail_operation_remove_msg:
 577  * @self: a #ModestMailOperation
 578  * @header: the #TnyHeader of the message to move
 579  * @remove_to_trash: TRUE to move it to trash or FALSE to delete it
 580  * permanently
 581  *
 582  * Deletes a message. This operation is synchronous, so the
 583  * #ModestMailOperation should not be added to any
 584  * #ModestMailOperationQueue
 585  **/
 586 void          modest_mail_operation_remove_msg     (ModestMailOperation *self,
 587                                                     TnyHeader *header,
 588                                                     gboolean remove_to_trash);
 589
 590 /**
 591  * modest_mail_operation_remove_msg:
 592  * @self: a #ModestMailOperation
 593  * @headers: the #TnyList of the messages to delete
 594  * @remove_to_trash: TRUE to move it to trash or FALSE to delete it
 595  * permanently
 596  *
 597  * Deletes a list of messages. This operation is synchronous, so the
 598  * #ModestMailOperation should not be added to any
 599  * #ModestMailOperationQueue
 600  **/
 601 void          modest_mail_operation_remove_msgs     (ModestMailOperation *self,
 602                                                      TnyList *headers,
 603                                                      gboolean remove_to_trash);
 604
 605 /**
 606  * modest_mail_operation_get_msg:
 607  * @self: a #ModestMailOperation
 608  * @header_list: the #TnyHeader of the message to get
 609  * @user_callback: a #GetMsgAsyncUserCallback function to call after tinymail callback execution.
 610  * @user_data: generic user data which will be passed to @user_callback function.
 611  *
 612  * Gets a message from header using an user defined @callback function
 613  * pased as argument. This operation is asynchronous, so the
 614  * #ModestMailOperation should be added to #ModestMailOperationQueue
 615  **/
 616 void          modest_mail_operation_get_msg     (ModestMailOperation *self,
 617                                                  TnyHeader *header,
 618                                                  GetMsgAsyncUserCallback user_callback,
 619                                                  gpointer user_data);
 620 /**
 621  * modest_mail_operation_get_msgs_full:
 622  * @self: a #ModestMailOperation
 623  * @header_list: a #TnyList of #TnyHeader objects to get and process
 624  * @user_callback: a #TnyGetMsgCallback function to call after tinymail operation execution.
 625  * @user_data: user data passed to both, user_callback and update_status_callback.
 626  *
 627  * Gets messages from headers list and process hem using @callback function
 628  * pased as argument. This operation is asynchronous, so the
 629  * #ModestMailOperation should be added to #ModestMailOperationQueue
 630  **/
 631 void          modest_mail_operation_get_msgs_full   (ModestMailOperation *self,
 632                                                      TnyList *headers_list,
 633                                                      GetMsgAsyncUserCallback user_callback,
 634                                                      gpointer user_data,
 635                                                      GDestroyNotify notify);
 636
 637 /**
 638  * modest_mail_operation_run_queue:
 639  * @self: a #ModestMailOperation
 640  * @queue: a #ModestTnySendQueue
 641  *
 642  * This mail operation is special. It should be running every time the send queue
 643  * is running (after queue-start), and we should notify end of the operation
 644  * after queue-end. Then, we should only set this queue on queue-start signal, and
 645  * it will clean up the operation (notify end) on queue-end.
 646  */
 647 void          modest_mail_operation_run_queue       (ModestMailOperation *self,
 648                                                      ModestTnySendQueue *queue);
 649
 650 /**
 651  * modest_mail_operation_sync_folder:
 652  * @self: a #ModestMailOperation
 653  * @folder: a #TnyFolder
 654  * @expunge: a #gboolean
 655  *
 656  * mail operation wrapper around tny_folder_sync () method, to keep modest
 657  * running while we do that sync operation.
 658  */
 659 void          modest_mail_operation_sync_folder     (ModestMailOperation *self,
 660                                                      TnyFolder *folder, gboolean expunge);
 661
 662 /* Functions to control mail operations */
 663 /**
 664  * modest_mail_operation_get_task_done:
 665  * @self: a #ModestMailOperation
 666  *
 667  * Gets the amount of work done for a given mail operation. This
 668  * amount of work is an absolute value.
 669  *
 670  * Returns: the amount of work completed
 671  **/
 672 guint     modest_mail_operation_get_task_done      (ModestMailOperation *self);
 673
 674 /**
 675  * modest_mail_operation_get_task_total:
 676  * @self: a #ModestMailOperation
 677  *
 678  * Gets the total amount of work that must be done to complete a given
 679  * mail operation. This amount of work is an absolute value.
 680  *
 681  * Returns: the total required amount of work
 682  **/
 683 guint     modest_mail_operation_get_task_total     (ModestMailOperation *self);
 684
 685
 686 /**
 687  * modest_mail_operation_is_finished:
 688  * @self: a #ModestMailOperation
 689  *
 690  * Checks if the operation is finished. A #ModestMailOperation is
 691  * finished if it's in any of the following states:
 692  * MODEST_MAIL_OPERATION_STATUS_SUCCESS,
 693  * MODEST_MAIL_OPERATION_STATUS_FAILED,
 694  * MODEST_MAIL_OPERATION_STATUS_CANCELED or
 695  * MODEST_MAIL_OPERATION_STATUS_FINISHED_WITH_ERRORS
 696  *
 697  * Returns: TRUE if the operation is finished, FALSE otherwise
 698  **/
 699 gboolean  modest_mail_operation_is_finished        (ModestMailOperation *self);
 700
 701 /**
 702  * modest_mail_operation_is_finished:
 703  * @self: a #ModestMailOperation
 704  *
 705  * Gets the current status of the given mail operation
 706  *
 707  * Returns: the current status or MODEST_MAIL_OPERATION_STATUS_INVALID in case of error
 708  **/
 709 ModestMailOperationStatus modest_mail_operation_get_status  (ModestMailOperation *self);
 710
 711 /**
 712  * modest_mail_operation_get_error:
 713  * @self: a #ModestMailOperation
 714  *
 715  * Gets the error associated to the mail operation if exists
 716  *
 717  * Returns: the #GError associated to the #ModestMailOperation if it
 718  * exists or NULL otherwise
 719  **/
 720 const GError*             modest_mail_operation_get_error   (ModestMailOperation *self);
 721
 722 /**
 723  * modest_mail_operation_cancel:
 724  * @self: a #ModestMailOperation
 725  *
 726  * Cancels an active mail operation
 727  *
 728  * Returns: TRUE if the operation was succesfully canceled, FALSE otherwise
 729  **/
 730 gboolean  modest_mail_operation_cancel          (ModestMailOperation *self);
 731
 732 /**
 733  * modest_mail_operation_refresh_folder
 734  * @self: a #ModestMailOperation
 735  * @folder: the #TnyFolder to refresh
 736  * @user_callback: the #RefreshAsyncUserCallback function to be called
 737  * after internal refresh async callback was being executed.
 738  *
 739  * Refreshes the contents of a folder. After internal callback was executed,
 740  * and all interna mail operation field were filled, if exists, it calls an
 741  * user callback function to make UI operations which must be done after folder
 742  * was refreshed.
 743  */
 744 void      modest_mail_operation_refresh_folder  (ModestMailOperation *self,
 745                                                  TnyFolder *folder,
 746                                                  RefreshAsyncUserCallback user_callback,
 747                                                  gpointer user_data);
 748
 749 /**
 750  * modest_mail_operation_get_account:
 751  * @self: a #ModestMailOperation
 752  *
 753  * Gets the account associated to a mail operation
 754  *
 755  * Returns: the #TnyAccount associated to the #ModestMailOperation
 756  **/
 757 TnyAccount *modest_mail_operation_get_account   (ModestMailOperation *self);
 758
 759
 760 /**
 761  * modest_mail_operation_noop:
 762  * @self: a #ModestMailOperation
 763  *
 764  * Does nothing except emitting operation-started and
 765  * operation-finished
 766  **/
 767 void modest_mail_operation_noop (ModestMailOperation *self);
 768
 769
 770 /**
 771  * modest_mail_operation_to_string:
 772  * @self: a #ModestMailOperation
 773  *
 774  * get a string representation of the mail operation (for debugging)
 775  *
 776  * Returns: a newly allocated string
 777  **/
 778 gchar* modest_mail_operation_to_string (ModestMailOperation *self);
 779
 780
 781 G_END_DECLS
 782
 783 #endif /* __MODEST_MAIL_OPERATION_H__ */
 784