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