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 * ModestMailOperationStatus:
52 * The state of a mail operation
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;
64 * ModestMailOperationId:
66 * The id for identifying the type of mail operation
69 MODEST_MAIL_OPERATION_TYPE_SEND,
70 MODEST_MAIL_OPERATION_TYPE_RECEIVE,
71 MODEST_MAIL_OPERATION_TYPE_OPEN,
72 MODEST_MAIL_OPERATION_TYPE_DELETE,
73 MODEST_MAIL_OPERATION_TYPE_INFO,
74 MODEST_MAIL_OPERATION_TYPE_UNKNOWN,
75 } ModestMailOperationTypeOperation;
78 * ErroCheckingAsyncUserCallback:
80 * @obj: a #GObject generic object which has created current mail operation.
81 * @user_data: generic data passed to user defined function.
83 * This function implements required actions to performs under error
86 typedef void (*ErrorCheckingUserCallback) (const GObject *obj, gpointer user_data);
89 * GetMsgAsyncUserCallback:
91 * @obj: a #GObject generic object which has created current mail operation.
92 * @msg: a #TnyMsg message retrieved by async operation.
93 * @user_data: generic data passed to user defined function.
95 * This function will be called after get_msg_cb private function, which is
96 * used as tinymail operation callback. The private function fills private
97 * fields of mail operation and calls user defined callback if it exists.
99 typedef void (*GetMsgAsyncUserCallback) (ModestMailOperation *mail_op,
105 * XferMsgAsynUserCallback:
107 * @obj: a #GObject generic object which has created current mail operation.
108 * @user_data: generic data passed to user defined function.
110 * This function will be called after transfer_msgs_cb private function, which is
111 * used as tinymail operation callback. The private function fills private
112 * fields of mail operation and calls user defined callback if it exists.
114 typedef void (*XferMsgsAsynUserCallback) (const GObject *obj, gpointer user_data);
117 /* This struct represents the internal state of a mail operation in a
123 ModestMailOperationStatus status;
124 ModestMailOperationTypeOperation op_type;
125 } ModestMailOperationState;
128 struct _ModestMailOperation {
130 /* insert public members, if any */
133 struct _ModestMailOperationClass {
134 GObjectClass parent_class;
137 void (*progress_changed) (ModestMailOperation *self, ModestMailOperationState *state, gpointer user_data);
140 /* member functions */
141 GType modest_mail_operation_get_type (void) G_GNUC_CONST;
144 * modest_mail_operation_new:
145 * @id: a #ModestMailOperationId identification of operation type.
146 * @source: a #GObject which creates this new operation.
148 * Creates a new instance of class #ModestMailOperation, using parameters
149 * to initialize its private structure. @source parameter may be NULL.
151 ModestMailOperation* modest_mail_operation_new (ModestMailOperationTypeOperation type,
155 * modest_mail_operation_new_with_error_handling:
156 * @id: a #ModestMailOperationId identification of operation type.
157 * @source: a #GObject which creates this new operation.
158 * @error_handler: a #ErrorCheckingUserCallback function to performs operations when
161 * Creates a new instance of class #ModestMailOperation, using parameters
162 * to initialize its private structure. @source parameter may be NULL.
163 * @error_handler can not be NULL, but it will be returned an mail operation
164 * object without error handling capability.
166 ModestMailOperation* modest_mail_operation_new_with_error_handling (ModestMailOperationTypeOperation op_type,
168 ErrorCheckingUserCallback error_handler);
170 * modest_mail_operation_execute_error_handler
171 * @self: a #ModestMailOperation
173 * Executes error handler, if it exists, passing @self objsect as
174 * user_data argument of error handling function.
177 modest_mail_operation_execute_error_handler (ModestMailOperation *self);
180 * modest_mail_operation_get_type_operation
181 * @self: a #ModestMailOperation
183 * Gets the private op_type field of mail operation. This op_type
184 * identifies the class/type of mail operation.
186 ModestMailOperationTypeOperation
187 modest_mail_operation_get_type_operation (ModestMailOperation *self);
190 * modest_mail_operation_is_mine
191 * @self: a #ModestMailOperation
192 * @source: a #GObject to check if it have created @self operation.
194 * Check if @source object its owner of @self mail operation.
196 * returns: TRUE if source its owner, FALSE otherwise.
199 modest_mail_operation_is_mine (ModestMailOperation *self,
203 * modest_mail_operation_get_source
204 * @self: a #ModestMailOperation
206 * returns a new reference to the object that created the mail
207 * operation passed to the constructor, or NULL if none. The caller
208 * must free the new reference
211 modest_mail_operation_get_source (ModestMailOperation *self);
213 /* fill in other public functions, eg.: */
216 * modest_mail_operation_send_mail:
217 * @self: a #ModestMailOperation
218 * @transport_account: a non-NULL #TnyTransportAccount
219 * @msg: a non-NULL #TnyMsg
221 * Sends and already existing message using the provided
222 * #TnyTransportAccount. This operation is synchronous, so the
223 * #ModestMailOperation should not be added to any
224 * #ModestMailOperationQueue
226 void modest_mail_operation_send_mail (ModestMailOperation *self,
227 TnyTransportAccount *transport_account,
231 * modest_mail_operation_send_new_mail:
232 * @self: a #ModestMailOperation
233 * @transport_account: a non-NULL #TnyTransportAccount
234 * @from: the email address of the mail sender
235 * @to: a non-NULL email address of the mail receiver
236 * @cc: a comma-separated list of email addresses where to send a carbon copy
237 * @bcc: a comma-separated list of email addresses where to send a blind carbon copy
238 * @subject: the subject of the new mail
239 * @plain_body: the plain text body of the new mail.
240 * @html_body: the html version of the body of the new mail. If NULL, the mail will
241 * be sent with the plain body only.
242 * @attachments_list: a #GList of attachments, each attachment must be a #TnyMimePart
244 * Sends a new mail message using the provided
245 * #TnyTransportAccount. This operation is synchronous, so the
246 * #ModestMailOperation should not be added to any
247 * #ModestMailOperationQueue
249 void modest_mail_operation_send_new_mail (ModestMailOperation *self,
250 TnyTransportAccount *transport_account,
255 const gchar *subject,
256 const gchar *plain_body,
257 const gchar *html_body,
258 const GList *attachments_list,
259 TnyHeaderFlags priority_flags);
263 * modest_mail_operation_save_to_drafts:
264 * @self: a #ModestMailOperation
265 * @transport_account: a non-NULL #TnyTransportAccount
266 * @from: the email address of the mail sender
267 * @to: a non-NULL email address of the mail receiver
268 * @cc: a comma-separated list of email addresses where to send a carbon copy
269 * @bcc: a comma-separated list of email addresses where to send a blind carbon copy
270 * @subject: the subject of the new mail
271 * @plain_body: the plain text body of the new mail.
272 * @html_body: the html version of the body of the new mail. If NULL, the mail will
273 * be sent with the plain body only.
274 * @attachments_list: a #GList of attachments, each attachment must be a #TnyMimePart
276 * Save a mail message to drafts using the provided
277 * #TnyTransportAccount. This operation is synchronous, so the
278 * #ModestMailOperation should not be added to any
279 * #ModestMailOperationQueue
281 void modest_mail_operation_save_to_drafts (ModestMailOperation *self,
282 TnyTransportAccount *transport_account,
287 const gchar *subject,
288 const gchar *plain_body,
289 const gchar *html_body,
290 const GList *attachments_list,
291 TnyHeaderFlags priority_flags);
293 * modest_mail_operation_update_account:
294 * @self: a #ModestMailOperation
295 * @account_name: the id of a Modest account
297 * Asynchronously refreshes the root folders of the given store
298 * account. The caller should add the #ModestMailOperation to a
299 * #ModestMailOperationQueue and then free it. The caller will be
300 * notified by the "progress_changed" signal each time the progress of
301 * the operation changes.
304 * <informalexample><programlisting>
305 * queue = modest_tny_platform_factory_get_modest_mail_operation_queue_instance (fact)
306 * mail_op = modest_mail_operation_new ();
307 * g_signal_connect (G_OBJECT (mail_op), "progress_changed", G_CALLBACK(on_progress_changed), NULL);
308 * modest_mail_operation_queue_add (queue, mail_op);
309 * modest_mail_operation_update_account (mail_op, account_name)
310 * g_object_unref (G_OBJECT (mail_op));
311 * </programlisting></informalexample>
313 * Note that the account_name *MUST* be a modest account name, not a
314 * tinymail store account name
316 * Returns: TRUE if the mail operation could be started, or FALSE otherwise
318 gboolean modest_mail_operation_update_account (ModestMailOperation *self,
319 const gchar *account_name);
321 /* Functions that perform store operations */
324 * modest_mail_operation_create_folder:
325 * @self: a #ModestMailOperation
326 * @parent: the #TnyFolderStore which is the parent of the new folder
327 * @name: the non-NULL new name for the new folder
329 * Creates a new folder as a children of a existing one. If the store
330 * account supports subscriptions this method also sets the new folder
331 * as subscribed. This operation is synchronous, so the
332 * #ModestMailOperation should not be added to any
333 * #ModestMailOperationQueue
335 * Returns: a newly created #TnyFolder or NULL in case of error.
337 TnyFolder* modest_mail_operation_create_folder (ModestMailOperation *self,
338 TnyFolderStore *parent,
342 * modest_mail_operation_remove_folder:
343 * @self: a #ModestMailOperation
344 * @folder: a #TnyFolder
345 * @remove_to_trash: TRUE to move it to trash or FALSE to delete
348 * Removes a folder. This operation is synchronous, so the
349 * #ModestMailOperation should not be added to any
350 * #ModestMailOperationQueue
352 void modest_mail_operation_remove_folder (ModestMailOperation *self,
354 gboolean remove_to_trash);
357 * modest_mail_operation_rename_folder:
358 * @self: a #ModestMailOperation
359 * @folder: a #TnyFolder
360 * @name: a non-NULL name without "/"
362 * Renames a given folder with the provided new name. This operation
363 * is synchronous, so the #ModestMailOperation should not be added to
364 * any #ModestMailOperationQueue
366 void modest_mail_operation_rename_folder (ModestMailOperation *self,
371 * modest_mail_operation_xfer_folder:
372 * @self: a #ModestMailOperation
373 * @folder: a #TnyFolder
374 * @parent: the new parent of the folder as #TnyFolderStore
375 * @delete_original: wheter or not delete the original folder
377 * Sets the given @folder as child of a provided #TnyFolderStore. This
378 * operation also transfers all the messages contained in the folder
379 * and all of his children folders with their messages as well. This
380 * operation is synchronous, so the #ModestMailOperation should not be
381 * added to any #ModestMailOperationQueue.
383 * If @delete_original is TRUE this function moves the original
384 * folder, if it is FALSE the it just copies it
387 void modest_mail_operation_xfer_folder (ModestMailOperation *self,
389 TnyFolderStore *parent,
390 gboolean delete_original);
392 /* Functions that performs msg operations */
395 * modest_mail_operation_xfer_msgs:
396 * @self: a #ModestMailOperation
397 * @header_list: a #TnyList of #TnyHeader to transfer
398 * @folder: the #TnyFolder where the messages will be transferred
399 * @delete_original: whether or not delete the source messages
400 * @user_callback: a #XferMsgsAsynUserCallback function to call after tinymail callback execution.
401 * @user_data: generic user data which will be passed to @user_callback function.
403 * Asynchronously transfers messages from their current folder to
404 * another one. The caller should add the #ModestMailOperation to a
405 * #ModestMailOperationQueue and then free it. The caller will be
406 * notified by the "progress_changed" when the operation is completed.
408 * If the @delete_original paramter is TRUE then this function moves
409 * the messages between folders, otherwise it copies them.
412 * <informalexample><programlisting>
413 * queue = modest_tny_platform_factory_get_modest_mail_operation_queue_instance (fact);
414 * mail_op = modest_mail_operation_new ();
415 * modest_mail_operation_queue_add (queue, mail_op);
416 * g_signal_connect (G_OBJECT (mail_op), "progress_changed", G_CALLBACK(on_progress_changed), queue);
418 * modest_mail_operation_xfer_msg (mail_op, headers, folder, TRUE);
420 * g_object_unref (G_OBJECT (mail_op));
421 * </programlisting></informalexample>
424 void modest_mail_operation_xfer_msgs (ModestMailOperation *self,
425 TnyList *header_list,
427 gboolean delete_original,
428 XferMsgsAsynUserCallback user_callback,
432 * modest_mail_operation_remove_msg:
433 * @self: a #ModestMailOperation
434 * @header: the #TnyHeader of the message to move
435 * @remove_to_trash: TRUE to move it to trash or FALSE to delete it
438 * Deletes a message. This operation is synchronous, so the
439 * #ModestMailOperation should not be added to any
440 * #ModestMailOperationQueue
442 void modest_mail_operation_remove_msg (ModestMailOperation *self,
444 gboolean remove_to_trash);
447 * modest_mail_operation_get_msg:
448 * @self: a #ModestMailOperation
449 * @header_list: the #TnyHeader of the message to get
450 * @user_callback: a #GetMsgAsyncUserCallback function to call after tinymail callback execution.
451 * @user_data: generic user data which will be passed to @user_callback function.
453 * Gets a message from header using an user defined @callback function
454 * pased as argument. This operation is asynchronous, so the
455 * #ModestMailOperation should be added to #ModestMailOperationQueue
457 void modest_mail_operation_get_msg (ModestMailOperation *self,
459 GetMsgAsyncUserCallback user_callback,
462 * modest_mail_operation_get_msgs_full:
463 * @self: a #ModestMailOperation
464 * @header_list: a #TnyList of #TnyHeader objects to get and process
465 * @user_callback: a #TnyGetMsgCallback function to call after tinymail operation execution.
466 * @user_data: user data passed to both, user_callback and update_status_callback.
468 * Gets messages from headers list and process hem using @callback function
469 * pased as argument. This operation is asynchronous, so the
470 * #ModestMailOperation should be added to #ModestMailOperationQueue
472 void modest_mail_operation_get_msgs_full (ModestMailOperation *self,
473 TnyList *headers_list,
474 GetMsgAsyncUserCallback user_callback,
476 GDestroyNotify notify);
478 /* Functions to control mail operations */
480 * modest_mail_operation_get_task_done:
481 * @self: a #ModestMailOperation
483 * Gets the amount of work done for a given mail operation. This
484 * amount of work is an absolute value.
486 * Returns: the amount of work completed
488 guint modest_mail_operation_get_task_done (ModestMailOperation *self);
491 * modest_mail_operation_get_task_total:
492 * @self: a #ModestMailOperation
494 * Gets the total amount of work that must be done to complete a given
495 * mail operation. This amount of work is an absolute value.
497 * Returns: the total required amount of work
499 guint modest_mail_operation_get_task_total (ModestMailOperation *self);
503 * modest_mail_operation_is_finished:
504 * @self: a #ModestMailOperation
506 * Checks if the operation is finished. A #ModestMailOperation is
507 * finished if it's in any of the following states:
508 * MODEST_MAIL_OPERATION_STATUS_SUCCESS,
509 * MODEST_MAIL_OPERATION_STATUS_FAILED,
510 * MODEST_MAIL_OPERATION_STATUS_CANCELED or
511 * MODEST_MAIL_OPERATION_STATUS_FINISHED_WITH_ERRORS
513 * Returns: TRUE if the operation is finished, FALSE otherwise
515 gboolean modest_mail_operation_is_finished (ModestMailOperation *self);
518 * modest_mail_operation_is_finished:
519 * @self: a #ModestMailOperation
521 * Gets the current status of the given mail operation
523 * Returns: the current status or MODEST_MAIL_OPERATION_STATUS_INVALID in case of error
525 ModestMailOperationStatus modest_mail_operation_get_status (ModestMailOperation *self);
528 * modest_mail_operation_get_error:
529 * @self: a #ModestMailOperation
531 * Gets the error associated to the mail operation if exists
533 * Returns: the #GError associated to the #ModestMailOperation if it
534 * exists or NULL otherwise
536 const GError* modest_mail_operation_get_error (ModestMailOperation *self);
539 * modest_mail_operation_cancel:
540 * @self: a #ModestMailOperation
542 * Cancels an active mail operation
544 * Returns: TRUE if the operation was succesfully canceled, FALSE otherwise
546 gboolean modest_mail_operation_cancel (ModestMailOperation *self);
549 * modest_mail_operation_refresh_folder
550 * @self: a #ModestMailOperation
551 * @folder: the #TnyFolder to refresh
553 * Refreshes the contents of a folder
555 void modest_mail_operation_refresh_folder (ModestMailOperation *self,
558 guint modest_mail_operation_get_id (ModestMailOperation *self);
560 guint modest_mail_operation_set_id (ModestMailOperation *self,
565 #endif /* __MODEST_MAIL_OPERATION_H__ */