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