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