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