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