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