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