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