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