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