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_FAILED,
  75         MODEST_MAIL_OPERATION_STATUS_IN_PROGRESS,
  76         MODEST_MAIL_OPERATION_STATUS_CANCELLED
  77 } ModestMailOperationStatus;
  78
  79 typedef void (*ModestUpdateAccountCallback) (ModestMailOperation *mail_op, gpointer user_data);
  80
  81 struct _ModestMailOperation {
  82          GObject parent;
  83         /* insert public members, if any */
  84 };
  85
  86 struct _ModestMailOperationClass {
  87         GObjectClass parent_class;
  88
  89         /* Signals */
  90         void (*progress_changed) (ModestMailOperation *mail_op, gpointer user_data);
  91 };
  92
  93 /* member functions */
  94 GType        modest_mail_operation_get_type    (void) G_GNUC_CONST;
  95
  96 /* typical parameter-less _new function */
  97 ModestMailOperation*    modest_mail_operation_new         (void);
  98
  99 /* fill in other public functions, eg.: */
 100 void    modest_mail_operation_send_mail       (ModestMailOperation *mail_op,
 101                                                TnyTransportAccount *transport_account,
 102                                                TnyMsg* msg);
 103
 104 void    modest_mail_operation_send_new_mail   (ModestMailOperation *mail_op,
 105                                                TnyTransportAccount *transport_account,
 106                                                const gchar *from,
 107                                                const gchar *to,
 108                                                const gchar *cc,
 109                                                const gchar *bcc,
 110                                                const gchar *subject,
 111                                                const gchar *body,
 112                                                const GList *attachments_list);
 113
 114 TnyMsg* modest_mail_operation_create_forward_mail (TnyMsg *msg,
 115                                                    const gchar *from,
 116                                                    ModestMailOperationForwardType forward_type);
 117
 118 TnyMsg* modest_mail_operation_create_reply_mail    (TnyMsg *msg,
 119                                                     const gchar *from,
 120                                                     ModestMailOperationReplyType reply_type,
 121                                                     ModestMailOperationReplyMode reply_mode);
 122
 123 void    modest_mail_operation_update_account       (ModestMailOperation *mail_op,
 124                                                     TnyStoreAccount *store_account,
 125                                                     ModestUpdateAccountCallback callback,
 126                                                     gpointer user_data);
 127
 128 /* Functions that perform store operations */
 129 TnyFolder*    modest_mail_operation_create_folder  (ModestMailOperation *mail_op,
 130                                                     TnyFolderStore *parent,
 131                                                     const gchar *name);
 132
 133 void          modest_mail_operation_remove_folder  (ModestMailOperation *mail_op,
 134                                                     TnyFolder *folder,
 135                                                     gboolean remove_to_trash);
 136
 137 void          modest_mail_operation_rename_folder  (ModestMailOperation *mail_op,
 138                                                     TnyFolder *folder,
 139                                                     const gchar *name);
 140
 141 void          modest_mail_operation_move_folder    (ModestMailOperation *mail_op,
 142                                                     TnyFolder *folder,
 143                                                     TnyFolderStore *parent);
 144
 145 void          modest_mail_operation_copy_folder    (ModestMailOperation *mail_op,
 146                                                     TnyFolder *folder,
 147                                                     TnyFolderStore *parent);
 148
 149 /* Functions that performs msg operations */
 150
 151 void          modest_mail_operation_copy_msg       (ModestMailOperation *mail_op,
 152                                                     TnyHeader *header,
 153                                                     TnyFolder *folder);
 154
 155 void          modest_mail_operation_move_msg       (ModestMailOperation *mail_op,
 156                                                     TnyHeader *header,
 157                                                     TnyFolder *folder);
 158
 159 void          modest_mail_operation_remove_msg     (ModestMailOperation *mail_op,
 160                                                     TnyHeader *header,
 161                                                     gboolean remove_to_trash);
 162
 163 /* Functions to control mail operations */
 164 guint     modest_mail_operation_get_task_done      (ModestMailOperation *mail_op);
 165
 166 guint     modest_mail_operation_get_task_total     (ModestMailOperation *mail_op);
 167
 168
 169 ModestMailOperationStatus modest_mail_operation_get_status (ModestMailOperation *mail_op);
 170
 171 const GError*             modest_mail_operation_get_error  (ModestMailOperation *mail_op);
 172
 173 void                      modest_mail_operation_cancel     (ModestMailOperation *mail_op);
 174
 175 G_END_DECLS
 176
 177 #endif /* __MODEST_MAIL_OPERATION_H__ */
 178