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