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