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