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