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