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 "modest-tny-attachment.h"
  35 /* other include files */
  36
  37 G_BEGIN_DECLS
  38
  39 /* convenience macros */
  40 #define MODEST_TYPE_MAIL_OPERATION             (modest_mail_operation_get_type())
  41 #define MODEST_MAIL_OPERATION(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_MAIL_OPERATION,ModestMailOperation))
  42 #define MODEST_MAIL_OPERATION_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_MAIL_OPERATION,GObject))
  43 #define MODEST_IS_MAIL_OPERATION(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_MAIL_OPERATION))
  44 #define MODEST_IS_MAIL_OPERATION_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_MAIL_OPERATION))
  45 #define MODEST_MAIL_OPERATION_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_MAIL_OPERATION,ModestMailOperationClass))
  46
  47 typedef struct _ModestMailOperation      ModestMailOperation;
  48 typedef struct _ModestMailOperationClass ModestMailOperationClass;
  49
  50 /* typedef enum _ModestMailOperationForwardType ModestMailOperationForwardType; */
  51 /* typedef enum _ModestMailOperationReplyType   ModestMailOperationReplyType; */
  52 /* typedef enum _ModestMailOperationReplyMode   ModestMailOperationReplyMode; */
  53 /* typedef enum _ModestMailOperationStatus      ModestMailOperationStatus; */
  54
  55 typedef enum _ModestMailOperationForwardType {
  56         MODEST_MAIL_OPERATION_FORWARD_TYPE_INLINE = 1,
  57         MODEST_MAIL_OPERATION_FORWARD_TYPE_ATTACHMENT
  58 } ModestMailOperationForwardType;
  59
  60 typedef enum _ModestMailOperationReplyType {
  61         MODEST_MAIL_OPERATION_REPLY_TYPE_CITE = 1,
  62         MODEST_MAIL_OPERATION_REPLY_TYPE_QUOTE
  63 } ModestMailOperationReplyType;
  64
  65 typedef enum _ModestMailOperationReplyMode {
  66         MODEST_MAIL_OPERATION_REPLY_MODE_SENDER,
  67         MODEST_MAIL_OPERATION_REPLY_MODE_LIST,
  68         MODEST_MAIL_OPERATION_REPLY_MODE_ALL
  69 } ModestMailOperationReplyMode;
  70
  71 typedef enum _ModestMailOperationStatus {
  72         MODEST_MAIL_OPERATION_STATUS_INVALID,
  73         MODEST_MAIL_OPERATION_STATUS_SUCCESS,
  74         MODEST_MAIL_OPERATION_STATUS_FINISHED_WITH_ERRORS,
  75         MODEST_MAIL_OPERATION_STATUS_FAILED,
  76         MODEST_MAIL_OPERATION_STATUS_IN_PROGRESS,
  77         MODEST_MAIL_OPERATION_STATUS_CANCELED
  78 } ModestMailOperationStatus;
  79
  80 struct _ModestMailOperation {
  81          GObject parent;
  82         /* insert public members, if any */
  83 };
  84
  85 struct _ModestMailOperationClass {
  86         GObjectClass parent_class;
  87
  88         /* Signals */
  89         void (*progress_changed) (ModestMailOperation *mail_op, gpointer user_data);
  90 };
  91
  92 /* member functions */
  93 GType        modest_mail_operation_get_type    (void) G_GNUC_CONST;
  94
  95 /* typical parameter-less _new function */
  96 ModestMailOperation*    modest_mail_operation_new         (void);
  97
  98 /* fill in other public functions, eg.: */
  99 void    modest_mail_operation_send_mail       (ModestMailOperation *mail_op,
 100                                                TnyTransportAccount *transport_account,
 101                                                TnyMsg* msg);
 102
 103 void    modest_mail_operation_send_new_mail   (ModestMailOperation *mail_op,
 104                                                TnyTransportAccount *transport_account,
 105                                                const gchar *from,
 106                                                const gchar *to,
 107                                                const gchar *cc,
 108                                                const gchar *bcc,
 109                                                const gchar *subject,
 110                                                const gchar *body,
 111                                                const GList *attachments_list);
 112
 113 TnyMsg* modest_mail_operation_create_forward_mail (TnyMsg *msg,
 114                                                    const gchar *from,
 115                                                    ModestMailOperationForwardType forward_type);
 116
 117 TnyMsg* modest_mail_operation_create_reply_mail    (TnyMsg *msg,
 118                                                     const gchar *from,
 119                                                     ModestMailOperationReplyType reply_type,
 120                                                     ModestMailOperationReplyMode reply_mode);
 121
 122 gboolean      modest_mail_operation_update_account (ModestMailOperation *mail_op,
 123                                                     TnyStoreAccount *store_account);
 124
 125 /* Functions that perform store operations */
 126 TnyFolder*    modest_mail_operation_create_folder  (ModestMailOperation *mail_op,
 127                                                     TnyFolderStore *parent,
 128                                                     const gchar *name);
 129
 130 void          modest_mail_operation_remove_folder  (ModestMailOperation *mail_op,
 131                                                     TnyFolder *folder,
 132                                                     gboolean remove_to_trash);
 133
 134 void          modest_mail_operation_rename_folder  (ModestMailOperation *mail_op,
 135                                                     TnyFolder *folder,
 136                                                     const gchar *name);
 137
 138 void          modest_mail_operation_move_folder    (ModestMailOperation *mail_op,
 139                                                     TnyFolder *folder,
 140                                                     TnyFolderStore *parent);
 141
 142 void          modest_mail_operation_copy_folder    (ModestMailOperation *mail_op,
 143                                                     TnyFolder *folder,
 144                                                     TnyFolderStore *parent);
 145
 146 /* Functions that performs msg operations */
 147
 148 void          modest_mail_operation_copy_msg       (ModestMailOperation *mail_op,
 149                                                     TnyHeader *header,
 150                                                     TnyFolder *folder);
 151
 152 void          modest_mail_operation_move_msg       (ModestMailOperation *mail_op,
 153                                                     TnyHeader *header,
 154                                                     TnyFolder *folder);
 155
 156 void          modest_mail_operation_remove_msg     (ModestMailOperation *mail_op,
 157                                                     TnyHeader *header,
 158                                                     gboolean remove_to_trash);
 159
 160 /* Functions to control mail operations */
 161 guint     modest_mail_operation_get_task_done      (ModestMailOperation *mail_op);
 162
 163 guint     modest_mail_operation_get_task_total     (ModestMailOperation *mail_op);
 164
 165
 166 gboolean                  modest_mail_operation_is_finished (ModestMailOperation *mail_op);
 167
 168 ModestMailOperationStatus modest_mail_operation_get_status  (ModestMailOperation *mail_op);
 169
 170 const GError*             modest_mail_operation_get_error   (ModestMailOperation *mail_op);
 171
 172 void                      modest_mail_operation_cancel      (ModestMailOperation *mail_op);
 173
 174 G_END_DECLS
 175
 176 #endif /* __MODEST_MAIL_OPERATION_H__ */
 177