1 /* Copyright (c) 2006, Nokia Corporation
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
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.
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.
30 #ifndef __MODEST_MAIL_OPERATION_H__
31 #define __MODEST_MAIL_OPERATION_H__
33 #include <tny-transport-account.h>
34 #include "modest-tny-attachment.h"
35 /* other include files */
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))
47 typedef struct _ModestMailOperation ModestMailOperation;
48 typedef struct _ModestMailOperationClass ModestMailOperationClass;
50 /* typedef enum _ModestMailOperationForwardType ModestMailOperationForwardType; */
51 /* typedef enum _ModestMailOperationReplyType ModestMailOperationReplyType; */
52 /* typedef enum _ModestMailOperationReplyMode ModestMailOperationReplyMode; */
53 /* typedef enum _ModestMailOperationStatus ModestMailOperationStatus; */
55 typedef enum _ModestMailOperationForwardType {
56 MODEST_MAIL_OPERATION_FORWARD_TYPE_INLINE = 1,
57 MODEST_MAIL_OPERATION_FORWARD_TYPE_ATTACHMENT
58 } ModestMailOperationForwardType;
60 typedef enum _ModestMailOperationReplyType {
61 MODEST_MAIL_OPERATION_REPLY_TYPE_CITE = 1,
62 MODEST_MAIL_OPERATION_REPLY_TYPE_QUOTE
63 } ModestMailOperationReplyType;
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;
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;
79 typedef void (*ModestUpdateAccountCallback) (ModestMailOperation *mail_op, gpointer user_data);
81 struct _ModestMailOperation {
83 /* insert public members, if any */
86 struct _ModestMailOperationClass {
87 GObjectClass parent_class;
90 void (*progress_changed) (ModestMailOperation *mail_op, gpointer user_data);
93 /* member functions */
94 GType modest_mail_operation_get_type (void) G_GNUC_CONST;
96 /* typical parameter-less _new function */
97 ModestMailOperation* modest_mail_operation_new (void);
99 /* fill in other public functions, eg.: */
100 void modest_mail_operation_send_mail (ModestMailOperation *mail_op,
101 TnyTransportAccount *transport_account,
104 void modest_mail_operation_send_new_mail (ModestMailOperation *mail_op,
105 TnyTransportAccount *transport_account,
110 const gchar *subject,
112 const GList *attachments_list);
114 TnyMsg* modest_mail_operation_create_forward_mail (TnyMsg *msg,
116 ModestMailOperationForwardType forward_type);
118 TnyMsg* modest_mail_operation_create_reply_mail (TnyMsg *msg,
120 ModestMailOperationReplyType reply_type,
121 ModestMailOperationReplyMode reply_mode);
123 void modest_mail_operation_update_account (ModestMailOperation *mail_op,
124 TnyStoreAccount *store_account,
125 ModestUpdateAccountCallback callback,
128 /* Functions that perform store operations */
129 TnyFolder* modest_mail_operation_create_folder (ModestMailOperation *mail_op,
130 TnyFolderStore *parent,
133 void modest_mail_operation_remove_folder (ModestMailOperation *mail_op,
135 gboolean remove_to_trash);
137 void modest_mail_operation_rename_folder (ModestMailOperation *mail_op,
141 void modest_mail_operation_move_folder (ModestMailOperation *mail_op,
143 TnyFolderStore *parent);
145 void modest_mail_operation_copy_folder (ModestMailOperation *mail_op,
147 TnyFolderStore *parent);
149 /* Functions that performs msg operations */
151 void modest_mail_operation_copy_msg (ModestMailOperation *mail_op,
155 void modest_mail_operation_move_msg (ModestMailOperation *mail_op,
159 void modest_mail_operation_remove_msg (ModestMailOperation *mail_op,
161 gboolean remove_to_trash);
163 /* Functions to control mail operations */
164 guint modest_mail_operation_get_task_done (ModestMailOperation *mail_op);
166 guint modest_mail_operation_get_task_total (ModestMailOperation *mail_op);
169 ModestMailOperationStatus modest_mail_operation_get_status (ModestMailOperation *mail_op);
171 const GError* modest_mail_operation_get_error (ModestMailOperation *mail_op);
173 void modest_mail_operation_cancel (ModestMailOperation *mail_op);
177 #endif /* __MODEST_MAIL_OPERATION_H__ */