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