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  * GetMsgAsynUserCallback:
  92  *
  93  * @obj: a #GObject generic object which has created current mail operation.
  94  * @msg: a #TnyMsg message retrieved by async operation.
  95  * @user_data: generic data passed to user defined function.
  96  *
  97  * This function will be called after get_msg_cb private function, which is
  98  * used as tinymail operation callback. The private function fills private
  99  * fields of mail operation and calls user defined callback if it exists.
 100  */
 101 typedef void (*GetMsgAsynUserCallback) (const GObject *obj, const TnyMsg *msg, gpointer user_data);
 102
 103
 104 /* member functions */
 105 GType        modest_mail_operation_get_type    (void) G_GNUC_CONST;
 106
 107 /**
 108  * modest_mail_operation_new:
 109  * @id: a #ModestMailOperationId identification of operation type.
 110  * @source: a #GObject which creates this new operation.
 111  *
 112  * Creates a new instance of class #ModestMailOperation, using parameters
 113  * to initialize its private structure. @source parameter may be NULL.
 114  **/
 115 ModestMailOperation*    modest_mail_operation_new     (ModestMailOperationId id,
 116                                                        GObject *source);
 117
 118 /**
 119  * modest_mail_operation_get_id
 120  * @self: a #ModestMailOperation
 121  *
 122  * Gets the private id field of mail operation. This id identifies
 123  * the class/type of mail operation.
 124  **/
 125 ModestMailOperationId
 126 modest_mail_operation_get_id (ModestMailOperation *self);
 127
 128 /**
 129  * modest_mail_operation_is_mine
 130  * @self: a #ModestMailOperation
 131  * @source: a #GObject to check if it have created @self operation.
 132  *
 133  * Check if @source object its owner of @self mail operation.
 134  *
 135  * returns: TRUE if source its owner, FALSE otherwise.
 136  **/
 137 gboolean
 138 modest_mail_operation_is_mine (ModestMailOperation *self,
 139                                GObject *me);
 140
 141 /* fill in other public functions, eg.: */
 142
 143 /**
 144  * modest_mail_operation_send_mail:
 145  * @self: a #ModestMailOperation
 146  * @transport_account: a non-NULL #TnyTransportAccount
 147  * @msg: a non-NULL #TnyMsg
 148  *
 149  * Sends and already existing message using the provided
 150  * #TnyTransportAccount. This operation is synchronous, so the
 151  * #ModestMailOperation should not be added to any
 152  * #ModestMailOperationQueue
 153   **/
 154 void    modest_mail_operation_send_mail       (ModestMailOperation *self,
 155                                                TnyTransportAccount *transport_account,
 156                                                TnyMsg* msg);
 157
 158 /**
 159  * modest_mail_operation_send_new_mail:
 160  * @self: a #ModestMailOperation
 161  * @transport_account: a non-NULL #TnyTransportAccount
 162  * @from: the email address of the mail sender
 163  * @to: a non-NULL email address of the mail receiver
 164  * @cc: a comma-separated list of email addresses where to send a carbon copy
 165  * @bcc: a comma-separated list of email addresses where to send a blind carbon copy
 166  * @subject: the subject of the new mail
 167  * @plain_body: the plain text body of the new mail.
 168  * @html_body: the html version of the body of the new mail. If NULL, the mail will
 169  *             be sent with the plain body only.
 170  * @attachments_list: a #GList of attachments, each attachment must be a #TnyMimePart
 171  *
 172  * Sends a new mail message using the provided
 173  * #TnyTransportAccount. This operation is synchronous, so the
 174  * #ModestMailOperation should not be added to any
 175  * #ModestMailOperationQueue
 176   **/
 177 void    modest_mail_operation_send_new_mail   (ModestMailOperation *self,
 178                                                TnyTransportAccount *transport_account,
 179                                                const gchar *from,
 180                                                const gchar *to,
 181                                                const gchar *cc,
 182                                                const gchar *bcc,
 183                                                const gchar *subject,
 184                                                const gchar *plain_body,
 185                                                const gchar *html_body,
 186                                                const GList *attachments_list,
 187                                                TnyHeaderFlags priority_flags);
 188
 189
 190 /**
 191  * modest_mail_operation_save_to_drafts:
 192  * @self: a #ModestMailOperation
 193  * @transport_account: a non-NULL #TnyTransportAccount
 194  * @from: the email address of the mail sender
 195  * @to: a non-NULL email address of the mail receiver
 196  * @cc: a comma-separated list of email addresses where to send a carbon copy
 197  * @bcc: a comma-separated list of email addresses where to send a blind carbon copy
 198  * @subject: the subject of the new mail
 199  * @plain_body: the plain text body of the new mail.
 200  * @html_body: the html version of the body of the new mail. If NULL, the mail will
 201  *             be sent with the plain body only.
 202  * @attachments_list: a #GList of attachments, each attachment must be a #TnyMimePart
 203  *
 204  * Save a mail message to drafts using the provided
 205  * #TnyTransportAccount. This operation is synchronous, so the
 206  * #ModestMailOperation should not be added to any
 207  * #ModestMailOperationQueue
 208   **/
 209 void    modest_mail_operation_save_to_drafts   (ModestMailOperation *self,
 210                                                 TnyTransportAccount *transport_account,
 211                                                 const gchar *from,
 212                                                 const gchar *to,
 213                                                 const gchar *cc,
 214                                                 const gchar *bcc,
 215                                                 const gchar *subject,
 216                                                 const gchar *plain_body,
 217                                                 const gchar *html_body,
 218                                                 const GList *attachments_list,
 219                                                 TnyHeaderFlags priority_flags);
 220 /**
 221  * modest_mail_operation_update_account:
 222  * @self: a #ModestMailOperation
 223  * @store_account: a #TnyStoreAccount
 224  *
 225  * Asynchronously refreshes the root folders of the given store
 226  * account. The caller should add the #ModestMailOperation to a
 227  * #ModestMailOperationQueue and then free it. The caller will be
 228  * notified by the "progress_changed" signal each time the progress of
 229  * the operation changes.
 230  *
 231  * Note that the store account passed as parametter will be freed by
 232  * the mail operation so you must pass a new reference
 233  *
 234  * Example
 235  * <informalexample><programlisting>
 236  * queue = modest_tny_platform_factory_get_modest_mail_operation_queue_instance (fact)
 237  * mail_op = modest_mail_operation_new ();
 238  * g_signal_connect (G_OBJECT (mail_op), "progress_changed", G_CALLBACK(on_progress_changed), NULL);
 239  * modest_mail_operation_queue_add (queue, mail_op);
 240  * modest_mail_operation_update_account (mail_op, account)
 241  * g_object_unref (G_OBJECT (mail_op));
 242  * </programlisting></informalexample>
 243  *
 244  * Returns: TRUE if the mail operation could be started, or FALSE otherwise
 245  **/
 246 gboolean      modest_mail_operation_update_account (ModestMailOperation *self,
 247                                                     TnyStoreAccount *store_account);
 248
 249 /* Functions that perform store operations */
 250
 251 /**
 252  * modest_mail_operation_create_folder:
 253  * @self: a #ModestMailOperation
 254  * @parent: the #TnyFolderStore which is the parent of the new folder
 255  * @name: the non-NULL new name for the new folder
 256  *
 257  * Creates a new folder as a children of a existing one. If the store
 258  * account supports subscriptions this method also sets the new folder
 259  * as subscribed. This operation is synchronous, so the
 260  * #ModestMailOperation should not be added to any
 261  * #ModestMailOperationQueue
 262  *
 263  * Returns: a newly created #TnyFolder or NULL in case of error.
 264  **/
 265 TnyFolder*    modest_mail_operation_create_folder  (ModestMailOperation *self,
 266                                                     TnyFolderStore *parent,
 267                                                     const gchar *name);
 268
 269 /**
 270  * modest_mail_operation_remove_folder:
 271  * @self: a #ModestMailOperation
 272  * @folder: a #TnyFolder
 273  * @remove_to_trash: TRUE to move it to trash or FALSE to delete
 274  * permanently
 275  *
 276  * Removes a folder. This operation is synchronous, so the
 277  * #ModestMailOperation should not be added to any
 278  * #ModestMailOperationQueue
 279  **/
 280 void          modest_mail_operation_remove_folder  (ModestMailOperation *self,
 281                                                     TnyFolder *folder,
 282                                                     gboolean remove_to_trash);
 283
 284 /**
 285  * modest_mail_operation_rename_folder:
 286  * @self: a #ModestMailOperation
 287  * @folder: a #TnyFolder
 288  * @name: a non-NULL name without "/"
 289  *
 290  * Renames a given folder with the provided new name. This operation
 291  * is synchronous, so the #ModestMailOperation should not be added to
 292  * any #ModestMailOperationQueue
 293  **/
 294 void          modest_mail_operation_rename_folder  (ModestMailOperation *self,
 295                                                     TnyFolder *folder,
 296                                                     const gchar *name);
 297
 298 /**
 299  * modest_mail_operation_xfer_folder:
 300  * @self: a #ModestMailOperation
 301  * @folder: a #TnyFolder
 302  * @parent: the new parent of the folder as #TnyFolderStore
 303  * @delete_original: wheter or not delete the original folder
 304  *
 305  * Sets the given @folder as child of a provided #TnyFolderStore. This
 306  * operation also transfers all the messages contained in the folder
 307  * and all of his children folders with their messages as well. This
 308  * operation is synchronous, so the #ModestMailOperation should not be
 309  * added to any #ModestMailOperationQueue.
 310  *
 311  * If @delete_original is TRUE this function moves the original
 312  * folder, if it is FALSE the it just copies it
 313  *
 314  * Returns: the newly transfered folder
 315  **/
 316 TnyFolder*    modest_mail_operation_xfer_folder    (ModestMailOperation *self,
 317                                                     TnyFolder *folder,
 318                                                     TnyFolderStore *parent,
 319                                                     gboolean delete_original);
 320
 321
 322 /* Functions that performs msg operations */
 323
 324 /**
 325  * modest_mail_operation_xfer_msgs:
 326  * @self: a #ModestMailOperation
 327  * @header_list: a #TnyList of #TnyHeader to transfer
 328  * @folder: the #TnyFolder where the messages will be transferred
 329  * @delete_original: whether or not delete the source messages
 330  *
 331  * Asynchronously transfers messages from their current folder to
 332  * another one. The caller should add the #ModestMailOperation to a
 333  * #ModestMailOperationQueue and then free it. The caller will be
 334  * notified by the "progress_changed" when the operation is completed.
 335  *
 336  * If the @delete_original paramter is TRUE then this function moves
 337  * the messages between folders, otherwise it copies them.
 338  *
 339  * Example
 340  * <informalexample><programlisting>
 341  * queue = modest_tny_platform_factory_get_modest_mail_operation_queue_instance (fact);
 342  * mail_op = modest_mail_operation_new ();
 343  * modest_mail_operation_queue_add (queue, mail_op);
 344  * g_signal_connect (G_OBJECT (mail_op), "progress_changed", G_CALLBACK(on_progress_changed), queue);
 345  *
 346  * modest_mail_operation_xfer_msg (mail_op, headers, folder, TRUE);
 347  *
 348  * g_object_unref (G_OBJECT (mail_op));
 349  * </programlisting></informalexample>
 350  *
 351  **/
 352 void          modest_mail_operation_xfer_msgs      (ModestMailOperation *self,
 353                                                     TnyList *header_list,
 354                                                     TnyFolder *folder,
 355                                                     gboolean delete_original);
 356
 357 /**
 358  * modest_mail_operation_remove_msg:
 359  * @self: a #ModestMailOperation
 360  * @header: the #TnyHeader of the message to move
 361  * @remove_to_trash: TRUE to move it to trash or FALSE to delete it
 362  * permanently
 363  *
 364  * Deletes a message. This operation is synchronous, so the
 365  * #ModestMailOperation should not be added to any
 366  * #ModestMailOperationQueue
 367  **/
 368 void          modest_mail_operation_remove_msg     (ModestMailOperation *self,
 369                                                     TnyHeader *header,
 370                                                     gboolean remove_to_trash);
 371
 372 /**
 373  * modest_mail_operation_get_msg:
 374  * @self: a #ModestMailOperation
 375  * @header_list: the #TnyHeader of the message to get
 376  * @user_callback: a #GetMsgAsynUserCallback function to call after tinymail callback execution.
 377  * @user_data: generic user data which will be passed to @user_callback function.
 378  *
 379  * Gets a message from header using an user defined @callback function
 380  * pased as argument. This operation is asynchronous, so the
 381  * #ModestMailOperation should be added to #ModestMailOperationQueue
 382  **/
 383 void          modest_mail_operation_get_msg     (ModestMailOperation *self,
 384                                                  TnyHeader *header,
 385                                                  GetMsgAsynUserCallback user_callback,
 386                                                  gpointer user_data);
 387 /**
 388  * modest_mail_operation_process_msg:
 389  * @self: a #ModestMailOperation
 390  * @header_list: a #TnyList of #TnyHeader objects to get and process
 391  * @user_callback: a #TnyGetMsgCallback function to call after tinymail operation execution.
 392  * @user_data: user data passed to both, user_callback and update_status_callback.
 393  *
 394  * Gets messages from headers list and process hem using @callback function
 395  * pased as argument. This operation is asynchronous, so the
 396  * #ModestMailOperation should be added to #ModestMailOperationQueue
 397  **/
 398 void          modest_mail_operation_process_msg     (ModestMailOperation *self,
 399                                                      TnyList *headers_list,
 400                                                      GetMsgAsynUserCallback user_callback,
 401                                                      gpointer user_data);
 402
 403 /* Functions to control mail operations */
 404 /**
 405  * modest_mail_operation_get_task_done:
 406  * @self: a #ModestMailOperation
 407  *
 408  * Gets the amount of work done for a given mail operation. This
 409  * amount of work is an absolute value.
 410  *
 411  * Returns: the amount of work completed
 412  **/
 413 guint     modest_mail_operation_get_task_done      (ModestMailOperation *self);
 414
 415 /**
 416  * modest_mail_operation_get_task_total:
 417  * @self: a #ModestMailOperation
 418  *
 419  * Gets the total amount of work that must be done to complete a given
 420  * mail operation. This amount of work is an absolute value.
 421  *
 422  * Returns: the total required amount of work
 423  **/
 424 guint     modest_mail_operation_get_task_total     (ModestMailOperation *self);
 425
 426
 427 /**
 428  * modest_mail_operation_is_finished:
 429  * @self: a #ModestMailOperation
 430  *
 431  * Checks if the operation is finished. A #ModestMailOperation is
 432  * finished if it's in any of the following states:
 433  * MODEST_MAIL_OPERATION_STATUS_SUCCESS,
 434  * MODEST_MAIL_OPERATION_STATUS_FAILED,
 435  * MODEST_MAIL_OPERATION_STATUS_CANCELED or
 436  * MODEST_MAIL_OPERATION_STATUS_FINISHED_WITH_ERRORS
 437  *
 438  * Returns: TRUE if the operation is finished, FALSE otherwise
 439  **/
 440 gboolean  modest_mail_operation_is_finished        (ModestMailOperation *self);
 441
 442 /**
 443  * modest_mail_operation_is_finished:
 444  * @self: a #ModestMailOperation
 445  *
 446  * Gets the current status of the given mail operation
 447  *
 448  * Returns: the current status or MODEST_MAIL_OPERATION_STATUS_INVALID in case of error
 449  **/
 450 ModestMailOperationStatus modest_mail_operation_get_status  (ModestMailOperation *self);
 451
 452 /**
 453  * modest_mail_operation_get_error:
 454  * @self: a #ModestMailOperation
 455  *
 456  * Gets the error associated to the mail operation if exists
 457  *
 458  * Returns: the #GError associated to the #ModestMailOperation if it
 459  * exists or NULL otherwise
 460  **/
 461 const GError*             modest_mail_operation_get_error   (ModestMailOperation *self);
 462
 463 /**
 464  * modest_mail_operation_cancel:
 465  * @self: a #ModestMailOperation
 466  *
 467  * Cancels an active mail operation
 468  *
 469  * Returns: TRUE if the operation was succesfully canceled, FALSE otherwise
 470  **/
 471 gboolean  modest_mail_operation_cancel          (ModestMailOperation *self);
 472
 473 /**
 474  * modest_mail_operation_refresh_folder
 475  * @self: a #ModestMailOperation
 476  * @folder: the #TnyFolder to refresh
 477  *
 478  * Refreshes the contents of a folder
 479  */
 480 void      modest_mail_operation_refresh_folder  (ModestMailOperation *self,
 481                                                  TnyFolder *folder);
 482
 483 /**
 484  *
 485  * This function is a workarround. It emits the progress-changed
 486  * signal. It's used by the mail operation queue to notify the
 487  * observers attached to that signal that the operation finished. We
 488  * need to use that for the moment because tinymail does not give us
 489  * the progress of a given operation very well. So we must delete it
 490  * when tinymail has that functionality and remove the call to it in
 491  * the queue as well.
 492  */
 493 void _modest_mail_operation_notify_end (ModestMailOperation *self);
 494
 495 G_END_DECLS
 496
 497 #endif /* __MODEST_MAIL_OPERATION_H__ */
 498