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