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>
35 #include <modest-tny-send-queue.h>
36 #include <modest-tny-account-store.h>
40 /* convenience macros */
41 #define MODEST_TYPE_MAIL_OPERATION (modest_mail_operation_get_type())
42 #define MODEST_MAIL_OPERATION(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_MAIL_OPERATION,ModestMailOperation))
43 #define MODEST_MAIL_OPERATION_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_MAIL_OPERATION,GObject))
44 #define MODEST_IS_MAIL_OPERATION(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_MAIL_OPERATION))
45 #define MODEST_IS_MAIL_OPERATION_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_MAIL_OPERATION))
46 #define MODEST_MAIL_OPERATION_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_MAIL_OPERATION,ModestMailOperationClass))
48 typedef struct _ModestMailOperation ModestMailOperation;
49 typedef struct _ModestMailOperationClass ModestMailOperationClass;
52 * ModestMailOperationStatus:
54 * The state of a mail operation
56 typedef enum _ModestMailOperationStatus {
57 MODEST_MAIL_OPERATION_STATUS_INVALID,
58 MODEST_MAIL_OPERATION_STATUS_SUCCESS,
59 MODEST_MAIL_OPERATION_STATUS_FINISHED_WITH_ERRORS,
60 MODEST_MAIL_OPERATION_STATUS_FAILED,
61 MODEST_MAIL_OPERATION_STATUS_IN_PROGRESS,
62 MODEST_MAIL_OPERATION_STATUS_CANCELED
63 } ModestMailOperationStatus;
66 * ModestMailOperationId:
68 * The id for identifying the type of mail operation
71 MODEST_MAIL_OPERATION_TYPE_SEND,
72 MODEST_MAIL_OPERATION_TYPE_RECEIVE,
73 MODEST_MAIL_OPERATION_TYPE_SEND_AND_RECEIVE,
74 MODEST_MAIL_OPERATION_TYPE_OPEN,
75 MODEST_MAIL_OPERATION_TYPE_DELETE,
76 MODEST_MAIL_OPERATION_TYPE_INFO,
77 MODEST_MAIL_OPERATION_TYPE_RUN_QUEUE,
78 MODEST_MAIL_OPERATION_TYPE_SYNC_FOLDER,
79 MODEST_MAIL_OPERATION_TYPE_SHUTDOWN,
80 MODEST_MAIL_OPERATION_TYPE_QUEUE_WAKEUP,
81 MODEST_MAIL_OPERATION_TYPE_UPDATE_FOLDER_COUNTS,
82 MODEST_MAIL_OPERATION_TYPE_UNKNOWN,
83 } ModestMailOperationTypeOperation;
86 * ErrorCheckingUserCallback:
88 * @mail_op: the current mail operation.
89 * @user_data: generic data passed to user defined function.
91 * This function implements required actions to performs under error
94 typedef void (*ErrorCheckingUserCallback) (ModestMailOperation *mail_op, gpointer user_data);
97 * ErrorCheckingUserDataDestroyer:
99 * @user_data: generic data passed to user defined function.
101 * This function is used to destroy the user_data passed to the error
102 * checking user callback function
104 typedef void (*ErrorCheckingUserDataDestroyer) (gpointer user_data);
108 * GetMsgAsyncUserCallback:
110 * @mail_op: the current #ModestMailOperation.
111 * @header: a #TnyHeader summary item.
112 * @msg: a #TnyMsg message retrieved by async operation.
113 * @user_data: generic data passed to user defined function.
115 * This function will be called after get_msg_cb private function, which is
116 * used as tinymail operation callback. The private function fills private
117 * fields of mail operation and calls user defined callback if it exists.
119 typedef void (*GetMsgAsyncUserCallback) (ModestMailOperation *mail_op,
127 * GetMimePartSizeCallback:
129 * @mail_op: the current #ModestMailOperation.
130 * @size: size of the attachment
131 * @user_data: generic data passed to user defined function.
134 typedef void (*GetMimePartSizeCallback) (ModestMailOperation *mail_op,
139 * XferMsgsAsyncUserCallback:
141 * @obj: a #GObject generic object which has created current mail operation.
142 * @new_folder: the new instance of the #TnyFolder that has been transferred
143 * @user_data: generic data passed to user defined function.
145 * This function will be called after transfer_msgs_cb private function, which is
146 * used as tinymail operation callback. The private function fills private
147 * fields of mail operation and calls user defined callback if it exists.
149 typedef void (*XferMsgsAsyncUserCallback) (ModestMailOperation *mail_op,
154 * XferFolderAsyncUserCallback:
156 * @obj: a #GObject generic object which has created current mail operation.
157 * @new_folder: the new instance of the #TnyFolder that has been transferred
158 * @user_data: generic data passed to user defined function.
160 * This function will be called after transfer_msgs_cb private function, which is
161 * used as tinymail operation callback. The private function fills private
162 * fields of mail operation and calls user defined callback if it exists.
164 typedef void (*XferFolderAsyncUserCallback) (ModestMailOperation *mail_op,
165 TnyFolder *new_folder,
170 * RefreshAsyncUserCallback:
172 * @mail_op: the current #ModestMailOperation.
173 * @folder: a #TnyFolder which has been refreshed .
174 * @user_data: generic data passed to user defined function.
176 * This function will be called after refresh_folder_async_cb private function, which is
177 * used as tinymail operation callback. The private function fills private
178 * fields of mail operation and calls user defined callback if it exists.
180 typedef void (*RefreshAsyncUserCallback) (ModestMailOperation *mail_op,
185 * UpdateAccountCallback:
187 * @self: a #ModestMailOperation
188 * @new_headers: the list of new headers received
189 * @user_data: generic data passed to user defined function.
191 * This is the callback of the update_account operation. It informs
192 * the caller about the amount of new messages that have been
195 typedef void (*UpdateAccountCallback) (ModestMailOperation *self,
196 TnyList *new_headers,
200 * SaveToDraftsCallback:
202 * @self: a #ModestMailOperation
203 * @saved_draft: the new draft message that has been saved
204 * @user_data: generic data passed to user defined function.
206 * This is the callback of the save_to_drafts operation. It returns
207 * the newly created msg stored in the Drafts folder
209 typedef void (*SaveToDraftstCallback) (ModestMailOperation *self,
214 typedef gboolean (*RetrieveAllCallback) (GObject *source,
219 * CreateFolderUserCallback:
221 * @mail_op: the current #ModestMailOperation.
222 * @folder: a #TnyFolder summary item.
223 * @user_data: generic data passed to user defined function.
225 * This function will be called after get_msg_cb private function, which is
226 * used as tinymail operation callback. The private function fills private
227 * fields of mail operation and calls user defined callback if it exists.
229 typedef void (*CreateFolderUserCallback) (ModestMailOperation *mail_op,
230 TnyFolderStore *parent_folder,
231 TnyFolder *new_folder,
235 * SyncFolderCallback:
237 * @self: a #ModestMailOperation
238 * @folder: the #TnyFolder to sync
239 * @user_data: generic data passed to user defined function.
241 * This is the callback of the sync_folder operation.
243 typedef void (*SyncFolderCallback) (ModestMailOperation *self,
248 /* This struct represents the internal state of a mail operation in a
256 ModestMailOperationStatus status;
257 ModestMailOperationTypeOperation op_type;
258 } ModestMailOperationState;
261 struct _ModestMailOperation {
263 /* insert public members, if any */
266 struct _ModestMailOperationClass {
267 GObjectClass parent_class;
270 void (*progress_changed) (ModestMailOperation *self, ModestMailOperationState *state, gpointer user_data);
271 void (*operation_started) (ModestMailOperation *self, gpointer user_data);
272 void (*operation_finished) (ModestMailOperation *self, gpointer user_data);
275 /* member functions */
276 GType modest_mail_operation_get_type (void) G_GNUC_CONST;
279 * modest_mail_operation_new:
280 * @source: a #GObject which creates this new operation.
282 * Creates a new instance of class #ModestMailOperation, using parameters
283 * to initialize its private structure. @source parameter may be NULL.
285 ModestMailOperation* modest_mail_operation_new (GObject *source);
288 * modest_mail_operation_new_with_error_handling:
289 * @id: a #ModestMailOperationId identification of operation type.
290 * @source: a #GObject which creates this new operation.
291 * @error_handler: a #ErrorCheckingUserCallback function to performs operations when
294 * Creates a new instance of class #ModestMailOperation, using parameters
295 * to initialize its private structure. @source parameter may be NULL.
296 * @error_handler can not be NULL, but it will be returned an mail operation
297 * object without error handling capability.
299 ModestMailOperation* modest_mail_operation_new_with_error_handling (GObject *source,
300 ErrorCheckingUserCallback error_handler,
302 ErrorCheckingUserDataDestroyer error_handler_destroyer);
304 * modest_mail_operation_execute_error_handler
305 * @self: a #ModestMailOperation
307 * Executes error handler if exists. The error handler is the one that
308 * MUST free the user data passed to the
309 * modest_mail_operation_new_with_error_handling constructor
312 modest_mail_operation_execute_error_handler (ModestMailOperation *self);
315 * modest_mail_operation_get_type_operation
316 * @self: a #ModestMailOperation
318 * Gets the private op_type field of mail operation. This op_type
319 * identifies the class/type of mail operation.
321 ModestMailOperationTypeOperation
322 modest_mail_operation_get_type_operation (ModestMailOperation *self);
325 * modest_mail_operation_is_mine
326 * @self: a #ModestMailOperation
327 * @source: a #GObject to check if it have created @self operation.
329 * Check if @source object its owner of @self mail operation.
331 * returns: TRUE if source its owner, FALSE otherwise.
334 modest_mail_operation_is_mine (ModestMailOperation *self,
338 * modest_mail_operation_get_source
339 * @self: a #ModestMailOperation
341 * returns a new reference to the object that created the mail
342 * operation passed to the constructor, or NULL if none. The caller
343 * must free the new reference
346 modest_mail_operation_get_source (ModestMailOperation *self);
348 /* fill in other public functions, eg.: */
351 * modest_mail_operation_send_mail:
352 * @self: a #ModestMailOperation
353 * @transport_account: a non-NULL #TnyTransportAccount
354 * @msg: a non-NULL #TnyMsg
356 * Sends and already existing message using the provided
357 * #TnyTransportAccount. This operation is synchronous, so the
358 * #ModestMailOperation should not be added to any
359 * #ModestMailOperationQueue
361 void modest_mail_operation_send_mail (ModestMailOperation *self,
362 TnyTransportAccount *transport_account,
366 * modest_mail_operation_send_new_mail:
367 * @self: a #ModestMailOperation
368 * @transport_account: a non-NULL #TnyTransportAccount
369 * @draft_msg: a #TnyMsg of the origin draft message, if any
370 * @from: the email address of the mail sender
371 * @to: a non-NULL email address of the mail receiver
372 * @cc: a comma-separated list of email addresses where to send a carbon copy
373 * @bcc: a comma-separated list of email addresses where to send a blind carbon copy
374 * @subject: the subject of the new mail
375 * @plain_body: the plain text body of the new mail.
376 * @html_body: the html version of the body of the new mail. If NULL, the mail will
377 * be sent with the plain body only.
378 * @attachments_list: a #GList of attachments, each attachment must be a #TnyMimePart
379 * @images_list: a #GList of image attachments, each attachment must be a #TnyMimePart
381 * Sends a new mail message using the provided
382 * #TnyTransportAccount. This operation is synchronous, so the
383 * #ModestMailOperation should not be added to any
384 * #ModestMailOperationQueue
386 void modest_mail_operation_send_new_mail (ModestMailOperation *self,
387 TnyTransportAccount *transport_account,
393 const gchar *subject,
394 const gchar *plain_body,
395 const gchar *html_body,
396 const GList *attachments_list,
397 const GList *images_list,
398 const gchar *references,
399 const gchar *in_reply_to,
400 TnyHeaderFlags priority_flags,
401 TnyList *header_pairs);
405 * modest_mail_operation_save_to_drafts:
406 * @self: a #ModestMailOperation
407 * @transport_account: a non-NULL #TnyTransportAccount
408 * @draft_msg: the previous draft message, in case it's an update
409 * to an existing draft.
410 * @from: the email address of the mail sender
411 * @to: a non-NULL email address of the mail receiver
412 * @cc: a comma-separated list of email addresses where to send a carbon copy
413 * @bcc: a comma-separated list of email addresses where to send a blind carbon copy
414 * @subject: the subject of the new mail
415 * @plain_body: the plain text body of the new mail.
416 * @html_body: the html version of the body of the new mail. If NULL, the mail will
417 * be sent with the plain body only.
418 * @attachments_list: a #GList of attachments, each attachment must be a #TnyMimePart
419 * @images_list: a #GList of image attachments, each attachment must be a #TnyMimePart
420 * @callback: the user callback, will be called when the operation finishes
421 * @user_data: data that will be passed to the user callback
423 * Save a mail message to drafts using the provided
424 * #TnyTransportAccount. This operation is asynchronous.
427 void modest_mail_operation_save_to_drafts (ModestMailOperation *self,
428 TnyTransportAccount *transport_account,
434 const gchar *subject,
435 const gchar *plain_body,
436 const gchar *html_body,
437 const GList *attachments_list,
438 const GList *images_list,
439 TnyHeaderFlags priority_flags,
440 const gchar *references,
441 const gchar *in_reply_to,
442 TnyList *header_pairs,
443 SaveToDraftstCallback callback,
446 * modest_mail_operation_update_account:
447 * @self: a #ModestMailOperation
448 * @account_name: the id of a Modest account
449 * @poke_all: if TRUE it will also do a poke_status over all folders of the account
450 * @interactive: if TRUE the update account was scheduled by an interactive send receive
452 * Asynchronously refreshes the root folders of the given store
453 * account. The caller should add the #ModestMailOperation to a
454 * #ModestMailOperationQueue and then free it. The caller will be
455 * notified by the "progress_changed" signal each time the progress of
456 * the operation changes.
459 * <informalexample><programlisting>
460 * queue = modest_tny_platform_factory_get_modest_mail_operation_queue_instance (fact)
461 * mail_op = modest_mail_operation_new ();
462 * g_signal_connect (G_OBJECT (mail_op), "progress_changed", G_CALLBACK(on_progress_changed), NULL);
463 * modest_mail_operation_queue_add (queue, mail_op);
464 * modest_mail_operation_update_account (mail_op, account_name)
465 * g_object_unref (G_OBJECT (mail_op));
466 * </programlisting></informalexample>
468 * Note that the account_name *MUST* be a modest account name, not a
469 * tinymail store account name
472 void modest_mail_operation_update_account (ModestMailOperation *self,
473 const gchar *account_name,
475 gboolean interactive,
476 UpdateAccountCallback callback,
480 * modest_mail_operation_update_folder_counts:
481 * @self: a #ModestMailOperation
482 * @account_name: the id of a Modest account
484 * Asynchronously refreshes the folder counts of the given store
487 void modest_mail_operation_update_folder_counts (ModestMailOperation *self,
488 const gchar *account_name);
490 /* Functions that perform store operations */
493 * modest_mail_operation_create_folder:
494 * @self: a #ModestMailOperation
495 * @parent: the #TnyFolderStore which is the parent of the new folder
496 * @name: the non-NULL new name for the new folder
498 * Creates a new folder as a children of a existing one. If the store
499 * account supports subscriptions this method also sets the new folder
500 * as subscribed. This operation is synchronous, so the
501 * #ModestMailOperation should not be added to any
502 * #ModestMailOperationQueue
504 * Returns: a newly created #TnyFolder or NULL in case of error.
506 void modest_mail_operation_create_folder (ModestMailOperation *self,
507 TnyFolderStore *parent,
509 CreateFolderUserCallback callback,
513 * modest_mail_operation_remove_folder:
514 * @self: a #ModestMailOperation
515 * @folder: a #TnyFolder
516 * @remove_to_trash: TRUE to move it to trash or FALSE to delete
519 * Removes a folder. This operation is synchronous, so the
520 * #ModestMailOperation should not be added to any
521 * #ModestMailOperationQueue
523 void modest_mail_operation_remove_folder (ModestMailOperation *self,
525 gboolean remove_to_trash);
528 * modest_mail_operation_rename_folder:
529 * @self: a #ModestMailOperation
530 * @folder: a #TnyFolder
531 * @name: a non-NULL name without "/"
533 * Renames a given folder with the provided new name. This operation
534 * is synchronous, so the #ModestMailOperation should not be added to
535 * any #ModestMailOperationQueue
537 void modest_mail_operation_rename_folder (ModestMailOperation *self,
540 XferFolderAsyncUserCallback user_callback,
544 * modest_mail_operation_xfer_folder:
545 * @self: a #ModestMailOperation
546 * @folder: a #TnyFolder
547 * @parent: the new parent of the folder as #TnyFolderStore
548 * @delete_original: wheter or not delete the original folder
549 * @user_callback: a #XferFolderAsyncUserCallback function to call after tinymail callback execution.
550 * @user_data: generic user data which will be passed to @user_callback function.
552 * Sets the given @folder as child of a provided #TnyFolderStore. This
553 * operation also transfers all the messages contained in the folder
554 * and all of his children folders with their messages as well. This
555 * operation is synchronous, so the #ModestMailOperation should not be
556 * added to any #ModestMailOperationQueue.
558 * If @delete_original is TRUE this function moves the original
559 * folder, if it is FALSE the it just copies it
562 void modest_mail_operation_xfer_folder (ModestMailOperation *self,
564 TnyFolderStore *parent,
565 gboolean delete_original,
566 XferFolderAsyncUserCallback user_callback,
570 /* Functions that performs msg operations */
573 * modest_mail_operation_xfer_msgs:
574 * @self: a #ModestMailOperation
575 * @header_list: a #TnyList of #TnyHeader to transfer
576 * @folder: the #TnyFolder where the messages will be transferred
577 * @delete_original: whether or not delete the source messages
578 * @user_callback: a #XferFolderAsyncUserCallback function to call after tinymail callback execution.
579 * @user_data: generic user data which will be passed to @user_callback function.
581 * Asynchronously transfers messages from their current folder to
582 * another one. The caller should add the #ModestMailOperation to a
583 * #ModestMailOperationQueue and then free it. The caller will be
584 * notified by the "progress_changed" when the operation is completed.
586 * If the @delete_original paramter is TRUE then this function moves
587 * the messages between folders, otherwise it copies them.
590 * <informalexample><programlisting>
591 * queue = modest_tny_platform_factory_get_modest_mail_operation_queue_instance (fact);
592 * mail_op = modest_mail_operation_new ();
593 * modest_mail_operation_queue_add (queue, mail_op);
594 * g_signal_connect (G_OBJECT (mail_op), "progress_changed", G_CALLBACK(on_progress_changed), queue);
596 * modest_mail_operation_xfer_msg (mail_op, headers, folder, TRUE);
598 * g_object_unref (G_OBJECT (mail_op));
599 * </programlisting></informalexample>
602 void modest_mail_operation_xfer_msgs (ModestMailOperation *self,
603 TnyList *header_list,
605 gboolean delete_original,
606 XferMsgsAsyncUserCallback user_callback,
610 * modest_mail_operation_remove_msgs:
611 * @self: a #ModestMailOperation
612 * @headers: the #TnyList of the messages to delete
613 * @remove_to_trash: TRUE to move it to trash or FALSE to delete it
616 * Deletes a list of messages.
618 void modest_mail_operation_remove_msgs (ModestMailOperation *self,
620 gboolean remove_to_trash);
623 * modest_mail_operation_get_msg_and_parts:
624 * @self: a #ModestMailOperation
625 * @header_list: the #TnyHeader of the message to get
626 * @progress_feedback: a #gboolean. If %TRUE, we'll get progress bar feedback.
627 * @user_callback: a #GetMsgAsyncUserCallback function to call after tinymail callback execution.
628 * @user_data: generic user data which will be passed to @user_callback function.
630 * Gets a message from header using an user defined @callback function
631 * pased as argument. This operation is asynchronous, so the
632 * #ModestMailOperation should be added to #ModestMailOperationQueue
634 * This operation also retrieves to cache all parts of the message. This is needed for
637 void modest_mail_operation_get_msg_and_parts (ModestMailOperation *self,
640 gboolean progress_feedback,
641 GetMsgAsyncUserCallback user_callback,
644 * modest_mail_operation_get_msg:
645 * @self: a #ModestMailOperation
646 * @header_list: the #TnyHeader of the message to get
647 * @progress_feedback: a #gboolean. If %TRUE, we'll get progress bar feedback.
648 * @user_callback: a #GetMsgAsyncUserCallback function to call after tinymail callback execution.
649 * @user_data: generic user data which will be passed to @user_callback function.
651 * Gets a message from header using an user defined @callback function
652 * pased as argument. This operation is asynchronous, so the
653 * #ModestMailOperation should be added to #ModestMailOperationQueue
655 void modest_mail_operation_get_msg (ModestMailOperation *self,
657 gboolean progress_feedback,
658 GetMsgAsyncUserCallback user_callback,
661 * modest_mail_operation_find_msg:
662 * @self: a #ModestMailOperation
664 * @progress_feedback: a #gboolean. If %TRUE, we'll get progress bar feedback.
665 * @user_callback: a #GetMsgAsyncUserCallback function to call after tinymail callback execution.
666 * @user_data: generic user data which will be passed to @user_callback function.
668 * Gets a message from a uid using an user defined @callback function
669 * pased as argument. This operation is asynchronous, so the
670 * #ModestMailOperation should be added to #ModestMailOperationQueue
672 void modest_mail_operation_find_msg (ModestMailOperation *self,
674 const gchar *msg_uid,
675 gboolean progress_feedback,
676 GetMsgAsyncUserCallback user_callback,
680 * modest_mail_operation_get_msgs_full:
681 * @self: a #ModestMailOperation
682 * @header_list: a #TnyList of #TnyHeader objects to get and process
683 * @user_callback: a #TnyGetMsgCallback function to call after tinymail operation execution.
684 * @user_data: user data passed to both, user_callback and update_status_callback.
686 * Gets messages from headers list and process hem using @callback function
687 * pased as argument. This operation is asynchronous, so the
688 * #ModestMailOperation should be added to #ModestMailOperationQueue
690 void modest_mail_operation_get_msgs_full (ModestMailOperation *self,
691 TnyList *headers_list,
692 GetMsgAsyncUserCallback user_callback,
694 GDestroyNotify notify);
697 * modest_mail_operation_run_queue:
698 * @self: a #ModestMailOperation
699 * @queue: a #ModestTnySendQueue
701 * This mail operation is special. It should be running every time the send queue
702 * is running (after queue-start), and we should notify end of the operation
703 * after queue-end. Then, we should only set this queue on queue-start signal, and
704 * it will clean up the operation (notify end) on queue-end.
706 void modest_mail_operation_run_queue (ModestMailOperation *self,
707 ModestTnySendQueue *queue);
710 * modest_mail_operation_queue_wakeup:
711 * @self: a #ModestMailOperation
712 * @queue: a #ModestTnySendQueue
714 * This mail operation is special. It should be running every time the send queue
715 * wakeup is running and we should notify end of the operation
716 * after wakeup has done msg-sent notification.
718 void modest_mail_operation_queue_wakeup (ModestMailOperation *self,
719 ModestTnySendQueue *queue);
722 * modest_mail_operation_sync_folder:
723 * @self: a #ModestMailOperation
724 * @folder: a #TnyFolder
725 * @expunge: a #gboolean
727 * mail operation wrapper around tny_folder_sync () method, to keep modest
728 * running while we do that sync operation.
730 void modest_mail_operation_sync_folder (ModestMailOperation *self,
733 SyncFolderCallback callback,
737 * modest_mail_operation_shutdown:
738 * @self: a #ModestMailOperation
739 * @account_store: a #ModestTnyAccountStore
741 * disconnects all accounts in the account store (doing the proper syncs).
743 void modest_mail_operation_shutdown (ModestMailOperation *self,
744 ModestTnyAccountStore *account_store);
746 /* Functions to control mail operations */
748 * modest_mail_operation_get_task_done:
749 * @self: a #ModestMailOperation
751 * Gets the amount of work done for a given mail operation. This
752 * amount of work is an absolute value.
754 * Returns: the amount of work completed
756 guint modest_mail_operation_get_task_done (ModestMailOperation *self);
759 * modest_mail_operation_get_task_total:
760 * @self: a #ModestMailOperation
762 * Gets the total amount of work that must be done to complete a given
763 * mail operation. This amount of work is an absolute value.
765 * Returns: the total required amount of work
767 guint modest_mail_operation_get_task_total (ModestMailOperation *self);
771 * modest_mail_operation_is_finished:
772 * @self: a #ModestMailOperation
774 * Checks if the operation is finished. A #ModestMailOperation is
775 * finished if it's in any of the following states:
776 * MODEST_MAIL_OPERATION_STATUS_SUCCESS,
777 * MODEST_MAIL_OPERATION_STATUS_FAILED,
778 * MODEST_MAIL_OPERATION_STATUS_CANCELED or
779 * MODEST_MAIL_OPERATION_STATUS_FINISHED_WITH_ERRORS
781 * Returns: TRUE if the operation is finished, FALSE otherwise
783 gboolean modest_mail_operation_is_finished (ModestMailOperation *self);
786 * modest_mail_operation_is_finished:
787 * @self: a #ModestMailOperation
789 * Gets the current status of the given mail operation
791 * Returns: the current status or MODEST_MAIL_OPERATION_STATUS_INVALID in case of error
793 ModestMailOperationStatus modest_mail_operation_get_status (ModestMailOperation *self);
796 * modest_mail_operation_get_error:
797 * @self: a #ModestMailOperation
799 * Gets the error associated to the mail operation if exists
801 * Returns: the #GError associated to the #ModestMailOperation if it
802 * exists or NULL otherwise
804 const GError* modest_mail_operation_get_error (ModestMailOperation *self);
807 * modest_mail_operation_cancel:
808 * @self: a #ModestMailOperation
810 * Cancels an active mail operation
812 * Returns: TRUE if the operation was succesfully canceled, FALSE otherwise
814 gboolean modest_mail_operation_cancel (ModestMailOperation *self);
817 * modest_mail_operation_refresh_folder
818 * @self: a #ModestMailOperation
819 * @folder: the #TnyFolder to refresh
820 * @user_callback: the #RefreshAsyncUserCallback function to be called
821 * after internal refresh async callback was being executed.
823 * Refreshes the contents of a folder. After internal callback was executed,
824 * and all interna mail operation field were filled, if exists, it calls an
825 * user callback function to make UI operations which must be done after folder
828 void modest_mail_operation_refresh_folder (ModestMailOperation *self,
830 RefreshAsyncUserCallback user_callback,
834 * modest_mail_operation_get_account:
835 * @self: a #ModestMailOperation
837 * Gets the account associated to a mail operation
839 * Returns: the #TnyAccount associated to the #ModestMailOperation
841 TnyAccount *modest_mail_operation_get_account (ModestMailOperation *self);
845 * modest_mail_operation_noop:
846 * @self: a #ModestMailOperation
848 * Does nothing except emitting operation-started and
851 void modest_mail_operation_noop (ModestMailOperation *self);
855 * modest_mail_operation_to_string:
856 * @self: a #ModestMailOperation
858 * get a string representation of the mail operation (for debugging)
860 * Returns: a newly allocated string
862 gchar* modest_mail_operation_to_string (ModestMailOperation *self);
867 #endif /* __MODEST_MAIL_OPERATION_H__ */