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