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 <tny-folder-store.h>
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))
46 typedef struct _ModestMailOperation ModestMailOperation;
47 typedef struct _ModestMailOperationClass ModestMailOperationClass;
50 * ModestMailOperationForwardType:
52 * How the original message will be forwarded to the recipient
54 typedef enum _ModestMailOperationForwardType {
55 MODEST_MAIL_OPERATION_FORWARD_TYPE_INLINE = 1,
56 MODEST_MAIL_OPERATION_FORWARD_TYPE_ATTACHMENT
57 } ModestMailOperationForwardType;
60 * ModestMailOperationReplyType:
62 * How the original message will be forwarded to the recipient
64 typedef enum _ModestMailOperationReplyType {
65 MODEST_MAIL_OPERATION_REPLY_TYPE_CITE = 1,
66 MODEST_MAIL_OPERATION_REPLY_TYPE_QUOTE
67 } ModestMailOperationReplyType;
70 * ModestMailOperationReplyMode:
72 * Who will be the recipients of the replied message
74 typedef enum _ModestMailOperationReplyMode {
75 MODEST_MAIL_OPERATION_REPLY_MODE_SENDER,
76 MODEST_MAIL_OPERATION_REPLY_MODE_LIST,
77 MODEST_MAIL_OPERATION_REPLY_MODE_ALL
78 } ModestMailOperationReplyMode;
81 * ModestMailOperationStatus:
83 * The state of a mail operation
85 typedef enum _ModestMailOperationStatus {
86 MODEST_MAIL_OPERATION_STATUS_INVALID,
87 MODEST_MAIL_OPERATION_STATUS_SUCCESS,
88 MODEST_MAIL_OPERATION_STATUS_FINISHED_WITH_ERRORS,
89 MODEST_MAIL_OPERATION_STATUS_FAILED,
90 MODEST_MAIL_OPERATION_STATUS_IN_PROGRESS,
91 MODEST_MAIL_OPERATION_STATUS_CANCELED
92 } ModestMailOperationStatus;
94 struct _ModestMailOperation {
96 /* insert public members, if any */
99 struct _ModestMailOperationClass {
100 GObjectClass parent_class;
103 void (*progress_changed) (ModestMailOperation *self, gpointer user_data);
106 /* member functions */
107 GType modest_mail_operation_get_type (void) G_GNUC_CONST;
109 /* typical parameter-less _new function */
110 ModestMailOperation* modest_mail_operation_new (void);
112 /* fill in other public functions, eg.: */
115 * modest_mail_operation_send_mail:
116 * @self: a #ModestMailOperation
117 * @transport_account: a non-NULL #TnyTransportAccount
118 * @msg: a non-NULL #TnyMsg
120 * Sends and already existing message using the provided
121 * #TnyTransportAccount. This operation is synchronous, so the
122 * #ModestMailOperation should not be added to any
123 * #ModestMailOperationQueue
125 void modest_mail_operation_send_mail (ModestMailOperation *self,
126 TnyTransportAccount *transport_account,
130 * modest_mail_operation_send_new_mail:
131 * @self: a #ModestMailOperation
132 * @transport_account: a non-NULL #TnyTransportAccount
133 * @from: the email address of the mail sender
134 * @to: a non-NULL email address of the mail receiver
135 * @cc: a comma-separated list of email addresses where to send a carbon copy
136 * @bcc: a comma-separated list of email addresses where to send a blind carbon copy
137 * @subject: the subject of the new mail
138 * @body: the body of the new mail
139 * @attachments_list: a #GList of attachments, each attachment must be a #TnyMimePart
141 * Sends a new mail message using the provided
142 * #TnyTransportAccount. This operation is synchronous, so the
143 * #ModestMailOperation should not be added to any
144 * #ModestMailOperationQueue
146 void modest_mail_operation_send_new_mail (ModestMailOperation *self,
147 TnyTransportAccount *transport_account,
152 const gchar *subject,
154 const GList *attachments_list);
157 * modest_mail_operation_create_forward_mail:
158 * @msg: a valid #TnyMsg instance
159 * @forward_type: the type of formatting used to create the forwarded message
161 * Creates a forwarded message from an existing one
163 * Returns: a new #TnyMsg, or NULL in case of error
165 TnyMsg* modest_mail_operation_create_forward_mail (TnyMsg *msg,
167 ModestMailOperationForwardType forward_type);
170 * modest_mail_operation_create_reply_mail:
171 * @msg: a valid #TnyMsg instance
172 * @reply_type: the type of formatting used to create the reply message
173 * @reply_mode: the mode of reply: to the sender only, to a mail list or to all
175 * Creates a new message to reply to an existing one
177 * Returns: Returns: a new #TnyMsg, or NULL in case of error
179 TnyMsg* modest_mail_operation_create_reply_mail (TnyMsg *msg,
181 ModestMailOperationReplyType reply_type,
182 ModestMailOperationReplyMode reply_mode);
185 * modest_mail_operation_update_account:
186 * @self: a #ModestMailOperation
187 * @store_account: a #TnyStoreAccount
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.
195 * <informalexample><programlisting>
196 * queue = modest_tny_platform_factory_get_modest_mail_operation_queue_instance (fact)
197 * mail_op = modest_mail_operation_new ();
198 * g_signal_connect (G_OBJECT (mail_op), "progress_changed", G_CALLBACK(on_progress_changed), queue);
199 * if (modest_mail_operation_update_account (mail_op, account))
201 * modest_mail_operation_queue_add (queue, mail_op);
203 * g_object_unref (G_OBJECT (mail_op));
204 * </programlisting></informalexample>
206 * Returns: TRUE if the mail operation could be started, or FALSE otherwise
208 gboolean modest_mail_operation_update_account (ModestMailOperation *self,
209 TnyStoreAccount *store_account);
211 /* Functions that perform store operations */
214 * modest_mail_operation_create_folder:
215 * @self: a #ModestMailOperation
216 * @parent: the #TnyFolderStore which is the parent of the new folder
217 * @name: the non-NULL new name for the new folder
219 * Creates a new folder as a children of a existing one. If the store
220 * account supports subscriptions this method also sets the new folder
221 * as subscribed. This operation is synchronous, so the
222 * #ModestMailOperation should not be added to any
223 * #ModestMailOperationQueue
225 * Returns: a newly created #TnyFolder or NULL in case of error.
227 TnyFolder* modest_mail_operation_create_folder (ModestMailOperation *self,
228 TnyFolderStore *parent,
232 * modest_mail_operation_remove_folder:
233 * @self: a #ModestMailOperation
234 * @folder: a #TnyFolder
235 * @remove_to_trash: TRUE to move it to trash or FALSE to delete
238 * Removes a folder. This operation is synchronous, so the
239 * #ModestMailOperation should not be added to any
240 * #ModestMailOperationQueue
242 void modest_mail_operation_remove_folder (ModestMailOperation *self,
244 gboolean remove_to_trash);
247 * modest_mail_operation_rename_folder:
248 * @self: a #ModestMailOperation
249 * @folder: a #TnyFolder
250 * @name: a non-NULL name without "/"
252 * Renames a given folder with the provided new name. This operation
253 * is synchronous, so the #ModestMailOperation should not be added to
254 * any #ModestMailOperationQueue
256 void modest_mail_operation_rename_folder (ModestMailOperation *self,
261 * modest_mail_operation_move_folder:
262 * @self: a #ModestMailOperation
263 * @folder: a #TnyFolder
264 * @parent: the new parent of the folder as #TnyFolderStore
266 * Sets the given @folder as child of a provided #TnyFolderStore. This
267 * operation moves also all the messages contained in the folder and
268 * all of his children folders with their messages as well. This
269 * operation is synchronous, so the #ModestMailOperation should not be
270 * added to any #ModestMailOperationQueue
272 void modest_mail_operation_move_folder (ModestMailOperation *self,
274 TnyFolderStore *parent);
277 * modest_mail_operation_copy_folder:
278 * @self: a #ModestMailOperation
279 * @folder: a #TnyFolder
280 * @parent: a #TnyFolderStore that will be the parent of the copied folder
282 * Sets a copy of the given @folder as child of a provided
283 * #TnyFolderStore. This operation copies also all the messages
284 * contained in the folder and all of his children folders with their
285 * messages as well. This operation is synchronous, so the
286 * #ModestMailOperation should not be added to any
287 * #ModestMailOperationQueue
289 void modest_mail_operation_copy_folder (ModestMailOperation *self,
291 TnyFolderStore *parent);
293 /* Functions that performs msg operations */
296 * modest_mail_operation_copy_msg:
297 * @self: a #ModestMailOperation
298 * @header: the #TnyHeader of the message to copy
299 * @folder: the #TnyFolder where the message will be copied
301 * Asynchronously copies a message from its current folder to another
302 * one. The caller should add the #ModestMailOperation to a
303 * #ModestMailOperationQueue and then free it. The caller will be
304 * notified by the "progress_changed" when the operation is completed.
307 * <informalexample><programlisting>
308 * queue = modest_tny_platform_factory_get_modest_mail_operation_queue_instance (fact);
309 * mail_op = modest_mail_operation_new ();
310 * if (modest_mail_operation_copy_msg (mail_op, account))
312 * g_signal_connect (G_OBJECT (mail_op), "progress_changed", G_CALLBACK(on_progress_changed), queue);
313 * modest_mail_operation_queue_add (queue, mail_op);
315 * g_object_unref (G_OBJECT (mail_op));
316 * </programlisting></informalexample>
318 * Returns: TRUE if the mail operation could be started, or FALSE otherwise
320 gboolean modest_mail_operation_copy_msg (ModestMailOperation *self,
325 * modest_mail_operation_move_msg:
326 * @self: a #ModestMailOperation
327 * @header: the #TnyHeader of the message to move
328 * @folder: the #TnyFolder where the message will be moved
330 * Asynchronously moves a message from its current folder to another
331 * one. The caller should add the #ModestMailOperation to a
332 * #ModestMailOperationQueue and then free it. The caller will be
333 * notified by the "progress_changed" when the operation is completed.
336 * <informalexample><programlisting>
337 * queue = modest_tny_platform_factory_get_modest_mail_operation_queue_instance (fact);
338 * mail_op = modest_mail_operation_new ();
339 * if (modest_mail_operation_move_msg (mail_op, account))
341 * g_signal_connect (G_OBJECT (mail_op), "progress_changed", G_CALLBACK(on_progress_changed), queue);
342 * modest_mail_operation_queue_add (queue, mail_op);
344 * g_object_unref (G_OBJECT (mail_op));
345 * </programlisting></informalexample>
347 * Returns: TRUE if the mail operation could be started, or FALSE otherwise
349 gboolean modest_mail_operation_move_msg (ModestMailOperation *self,
354 * modest_mail_operation_remove_msg:
355 * @self: a #ModestMailOperation
356 * @header: the #TnyHeader of the message to move
357 * @remove_to_trash: TRUE to move it to trash or FALSE to delete it
360 * Deletes a message. This operation is synchronous, so the
361 * #ModestMailOperation should not be added to any
362 * #ModestMailOperationQueue
364 void modest_mail_operation_remove_msg (ModestMailOperation *self,
366 gboolean remove_to_trash);
368 /* Functions to control mail operations */
370 * modest_mail_operation_get_task_done:
371 * @self: a #ModestMailOperation
373 * Gets the amount of work done for a given mail operation. This
374 * amount of work is an absolute value.
376 * Returns: the amount of work completed
378 guint modest_mail_operation_get_task_done (ModestMailOperation *self);
381 * modest_mail_operation_get_task_total:
382 * @self: a #ModestMailOperation
384 * Gets the total amount of work that must be done to complete a given
385 * mail operation. This amount of work is an absolute value.
387 * Returns: the total required amount of work
389 guint modest_mail_operation_get_task_total (ModestMailOperation *self);
393 * modest_mail_operation_is_finished:
394 * @self: a #ModestMailOperation
396 * Checks if the operation is finished. A #ModestMailOperation is
397 * finished if it's in any of the following states:
398 * MODEST_MAIL_OPERATION_STATUS_SUCCESS,
399 * MODEST_MAIL_OPERATION_STATUS_FAILED,
400 * MODEST_MAIL_OPERATION_STATUS_CANCELED or
401 * MODEST_MAIL_OPERATION_STATUS_FINISHED_WITH_ERRORS
403 * Returns: TRUE if the operation is finished, FALSE otherwise
405 gboolean modest_mail_operation_is_finished (ModestMailOperation *self);
408 * modest_mail_operation_is_finished:
409 * @self: a #ModestMailOperation
411 * Gets the current status of the given mail operation
413 * Returns: the current status or MODEST_MAIL_OPERATION_STATUS_INVALID in case of error
415 ModestMailOperationStatus modest_mail_operation_get_status (ModestMailOperation *self);
418 * modest_mail_operation_get_error:
419 * @self: a #ModestMailOperation
421 * Gets the error associated to the mail operation if exists
423 * Returns: the #GError associated to the #ModestMailOperation if it
424 * exists or NULL otherwise
426 const GError* modest_mail_operation_get_error (ModestMailOperation *self);
429 * modest_mail_operation_cancel:
430 * @self: a #ModestMailOperation
432 * Cancels an active mail operation
434 * Returns: TRUE if the operation was succesfully canceled, FALSE otherwise
436 gboolean modest_mail_operation_cancel (ModestMailOperation *self);
440 #endif /* __MODEST_MAIL_OPERATION_H__ */