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