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 <widgets/modest-msg-edit-window.h>
36 #include <modest-tny-send-queue.h>
37 #include <modest-tny-account-store.h>
41 /* convenience macros */
42 #define MODEST_TYPE_MAIL_OPERATION (modest_mail_operation_get_type())
43 #define MODEST_MAIL_OPERATION(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_MAIL_OPERATION,ModestMailOperation))
44 #define MODEST_MAIL_OPERATION_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_MAIL_OPERATION,GObject))
45 #define MODEST_IS_MAIL_OPERATION(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_MAIL_OPERATION))
46 #define MODEST_IS_MAIL_OPERATION_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_MAIL_OPERATION))
47 #define MODEST_MAIL_OPERATION_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_MAIL_OPERATION,ModestMailOperationClass))
49 typedef struct _ModestMailOperation ModestMailOperation;
50 typedef struct _ModestMailOperationClass ModestMailOperationClass;
53 * ModestMailOperationStatus:
55 * The state of a mail operation
57 typedef enum _ModestMailOperationStatus {
58 MODEST_MAIL_OPERATION_STATUS_INVALID,
59 MODEST_MAIL_OPERATION_STATUS_SUCCESS,
60 MODEST_MAIL_OPERATION_STATUS_FINISHED_WITH_ERRORS,
61 MODEST_MAIL_OPERATION_STATUS_FAILED,
62 MODEST_MAIL_OPERATION_STATUS_IN_PROGRESS,
63 MODEST_MAIL_OPERATION_STATUS_CANCELED
64 } ModestMailOperationStatus;
67 * ModestMailOperationId:
69 * The id for identifying the type of mail operation
72 MODEST_MAIL_OPERATION_TYPE_SEND,
73 MODEST_MAIL_OPERATION_TYPE_RECEIVE,
74 MODEST_MAIL_OPERATION_TYPE_SEND_AND_RECEIVE,
75 MODEST_MAIL_OPERATION_TYPE_OPEN,
76 MODEST_MAIL_OPERATION_TYPE_DELETE,
77 MODEST_MAIL_OPERATION_TYPE_INFO,
78 MODEST_MAIL_OPERATION_TYPE_RUN_QUEUE,
79 MODEST_MAIL_OPERATION_TYPE_SYNC_FOLDER,
80 MODEST_MAIL_OPERATION_TYPE_SHUTDOWN,
81 MODEST_MAIL_OPERATION_TYPE_QUEUE_WAKEUP,
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,
234 /* This struct represents the internal state of a mail operation in a
242 ModestMailOperationStatus status;
243 ModestMailOperationTypeOperation op_type;
244 } ModestMailOperationState;
247 struct _ModestMailOperation {
249 /* insert public members, if any */
252 struct _ModestMailOperationClass {
253 GObjectClass parent_class;
256 void (*progress_changed) (ModestMailOperation *self, ModestMailOperationState *state, gpointer user_data);
257 void (*operation_started) (ModestMailOperation *self, gpointer user_data);
258 void (*operation_finished) (ModestMailOperation *self, gpointer user_data);
261 /* member functions */
262 GType modest_mail_operation_get_type (void) G_GNUC_CONST;
265 * modest_mail_operation_new:
266 * @source: a #GObject which creates this new operation.
268 * Creates a new instance of class #ModestMailOperation, using parameters
269 * to initialize its private structure. @source parameter may be NULL.
271 ModestMailOperation* modest_mail_operation_new (GObject *source);
274 * modest_mail_operation_new_with_error_handling:
275 * @id: a #ModestMailOperationId identification of operation type.
276 * @source: a #GObject which creates this new operation.
277 * @error_handler: a #ErrorCheckingUserCallback function to performs operations when
280 * Creates a new instance of class #ModestMailOperation, using parameters
281 * to initialize its private structure. @source parameter may be NULL.
282 * @error_handler can not be NULL, but it will be returned an mail operation
283 * object without error handling capability.
285 ModestMailOperation* modest_mail_operation_new_with_error_handling (GObject *source,
286 ErrorCheckingUserCallback error_handler,
288 ErrorCheckingUserDataDestroyer error_handler_destroyer);
290 * modest_mail_operation_execute_error_handler
291 * @self: a #ModestMailOperation
293 * Executes error handler if exists. The error handler is the one that
294 * MUST free the user data passed to the
295 * modest_mail_operation_new_with_error_handling constructor
298 modest_mail_operation_execute_error_handler (ModestMailOperation *self);
301 * modest_mail_operation_get_type_operation
302 * @self: a #ModestMailOperation
304 * Gets the private op_type field of mail operation. This op_type
305 * identifies the class/type of mail operation.
307 ModestMailOperationTypeOperation
308 modest_mail_operation_get_type_operation (ModestMailOperation *self);
311 * modest_mail_operation_is_mine
312 * @self: a #ModestMailOperation
313 * @source: a #GObject to check if it have created @self operation.
315 * Check if @source object its owner of @self mail operation.
317 * returns: TRUE if source its owner, FALSE otherwise.
320 modest_mail_operation_is_mine (ModestMailOperation *self,
324 * modest_mail_operation_get_source
325 * @self: a #ModestMailOperation
327 * returns a new reference to the object that created the mail
328 * operation passed to the constructor, or NULL if none. The caller
329 * must free the new reference
332 modest_mail_operation_get_source (ModestMailOperation *self);
334 /* fill in other public functions, eg.: */
337 * modest_mail_operation_send_mail:
338 * @self: a #ModestMailOperation
339 * @transport_account: a non-NULL #TnyTransportAccount
340 * @msg: a non-NULL #TnyMsg
342 * Sends and already existing message using the provided
343 * #TnyTransportAccount. This operation is synchronous, so the
344 * #ModestMailOperation should not be added to any
345 * #ModestMailOperationQueue
347 void modest_mail_operation_send_mail (ModestMailOperation *self,
348 TnyTransportAccount *transport_account,
352 * modest_mail_operation_send_new_mail:
353 * @self: a #ModestMailOperation
354 * @transport_account: a non-NULL #TnyTransportAccount
355 * @draft_msg: a #TnyMsg of the origin draft message, if any
356 * @from: the email address of the mail sender
357 * @to: a non-NULL email address of the mail receiver
358 * @cc: a comma-separated list of email addresses where to send a carbon copy
359 * @bcc: a comma-separated list of email addresses where to send a blind carbon copy
360 * @subject: the subject of the new mail
361 * @plain_body: the plain text body of the new mail.
362 * @html_body: the html version of the body of the new mail. If NULL, the mail will
363 * be sent with the plain body only.
364 * @attachments_list: a #GList of attachments, each attachment must be a #TnyMimePart
365 * @images_list: a #GList of image attachments, each attachment must be a #TnyMimePart
367 * Sends a new mail message using the provided
368 * #TnyTransportAccount. This operation is synchronous, so the
369 * #ModestMailOperation should not be added to any
370 * #ModestMailOperationQueue
372 void modest_mail_operation_send_new_mail (ModestMailOperation *self,
373 TnyTransportAccount *transport_account,
379 const gchar *subject,
380 const gchar *plain_body,
381 const gchar *html_body,
382 const GList *attachments_list,
383 const GList *images_list,
384 const gchar *references,
385 const gchar *in_reply_to,
386 TnyHeaderFlags priority_flags);
390 * modest_mail_operation_save_to_drafts:
391 * @self: a #ModestMailOperation
392 * @transport_account: a non-NULL #TnyTransportAccount
393 * @draft_msg: the previous draft message, in case it's an update
394 * to an existing draft.
395 * @from: the email address of the mail sender
396 * @to: a non-NULL email address of the mail receiver
397 * @cc: a comma-separated list of email addresses where to send a carbon copy
398 * @bcc: a comma-separated list of email addresses where to send a blind carbon copy
399 * @subject: the subject of the new mail
400 * @plain_body: the plain text body of the new mail.
401 * @html_body: the html version of the body of the new mail. If NULL, the mail will
402 * be sent with the plain body only.
403 * @attachments_list: a #GList of attachments, each attachment must be a #TnyMimePart
404 * @images_list: a #GList of image attachments, each attachment must be a #TnyMimePart
405 * @callback: the user callback, will be called when the operation finishes
406 * @user_data: data that will be passed to the user callback
408 * Save a mail message to drafts using the provided
409 * #TnyTransportAccount. This operation is asynchronous.
412 void modest_mail_operation_save_to_drafts (ModestMailOperation *self,
413 TnyTransportAccount *transport_account,
419 const gchar *subject,
420 const gchar *plain_body,
421 const gchar *html_body,
422 const GList *attachments_list,
423 const GList *images_list,
424 TnyHeaderFlags priority_flags,
425 const gchar *references,
426 const gchar *in_reply_to,
427 SaveToDraftstCallback callback,
430 * modest_mail_operation_update_account:
431 * @self: a #ModestMailOperation
432 * @account_name: the id of a Modest account
433 * @poke_all: if TRUE it will also do a poke_status over all folders of the account
434 * @interactive: if TRUE the update account was scheduled by an interactive send receive
436 * Asynchronously refreshes the root folders of the given store
437 * account. The caller should add the #ModestMailOperation to a
438 * #ModestMailOperationQueue and then free it. The caller will be
439 * notified by the "progress_changed" signal each time the progress of
440 * the operation changes.
443 * <informalexample><programlisting>
444 * queue = modest_tny_platform_factory_get_modest_mail_operation_queue_instance (fact)
445 * mail_op = modest_mail_operation_new ();
446 * g_signal_connect (G_OBJECT (mail_op), "progress_changed", G_CALLBACK(on_progress_changed), NULL);
447 * modest_mail_operation_queue_add (queue, mail_op);
448 * modest_mail_operation_update_account (mail_op, account_name)
449 * g_object_unref (G_OBJECT (mail_op));
450 * </programlisting></informalexample>
452 * Note that the account_name *MUST* be a modest account name, not a
453 * tinymail store account name
456 void modest_mail_operation_update_account (ModestMailOperation *self,
457 const gchar *account_name,
459 gboolean interactive,
460 RetrieveAllCallback retrieve_all_cb,
461 UpdateAccountCallback callback,
464 /* Functions that perform store operations */
467 * modest_mail_operation_create_folder:
468 * @self: a #ModestMailOperation
469 * @parent: the #TnyFolderStore which is the parent of the new folder
470 * @name: the non-NULL new name for the new folder
472 * Creates a new folder as a children of a existing one. If the store
473 * account supports subscriptions this method also sets the new folder
474 * as subscribed. This operation is synchronous, so the
475 * #ModestMailOperation should not be added to any
476 * #ModestMailOperationQueue
478 * Returns: a newly created #TnyFolder or NULL in case of error.
480 void modest_mail_operation_create_folder (ModestMailOperation *self,
481 TnyFolderStore *parent,
483 CreateFolderUserCallback callback,
487 * modest_mail_operation_remove_folder:
488 * @self: a #ModestMailOperation
489 * @folder: a #TnyFolder
490 * @remove_to_trash: TRUE to move it to trash or FALSE to delete
493 * Removes a folder. This operation is synchronous, so the
494 * #ModestMailOperation should not be added to any
495 * #ModestMailOperationQueue
497 void modest_mail_operation_remove_folder (ModestMailOperation *self,
499 gboolean remove_to_trash);
502 * modest_mail_operation_rename_folder:
503 * @self: a #ModestMailOperation
504 * @folder: a #TnyFolder
505 * @name: a non-NULL name without "/"
507 * Renames a given folder with the provided new name. This operation
508 * is synchronous, so the #ModestMailOperation should not be added to
509 * any #ModestMailOperationQueue
511 void modest_mail_operation_rename_folder (ModestMailOperation *self,
514 XferFolderAsyncUserCallback user_callback,
518 * modest_mail_operation_xfer_folder:
519 * @self: a #ModestMailOperation
520 * @folder: a #TnyFolder
521 * @parent: the new parent of the folder as #TnyFolderStore
522 * @delete_original: wheter or not delete the original folder
523 * @user_callback: a #XferFolderAsyncUserCallback function to call after tinymail callback execution.
524 * @user_data: generic user data which will be passed to @user_callback function.
526 * Sets the given @folder as child of a provided #TnyFolderStore. This
527 * operation also transfers all the messages contained in the folder
528 * and all of his children folders with their messages as well. This
529 * operation is synchronous, so the #ModestMailOperation should not be
530 * added to any #ModestMailOperationQueue.
532 * If @delete_original is TRUE this function moves the original
533 * folder, if it is FALSE the it just copies it
536 void modest_mail_operation_xfer_folder (ModestMailOperation *self,
538 TnyFolderStore *parent,
539 gboolean delete_original,
540 XferFolderAsyncUserCallback user_callback,
544 /* Functions that performs msg operations */
547 * modest_mail_operation_xfer_msgs:
548 * @self: a #ModestMailOperation
549 * @header_list: a #TnyList of #TnyHeader to transfer
550 * @folder: the #TnyFolder where the messages will be transferred
551 * @delete_original: whether or not delete the source messages
552 * @user_callback: a #XferFolderAsyncUserCallback function to call after tinymail callback execution.
553 * @user_data: generic user data which will be passed to @user_callback function.
555 * Asynchronously transfers messages from their current folder to
556 * another one. The caller should add the #ModestMailOperation to a
557 * #ModestMailOperationQueue and then free it. The caller will be
558 * notified by the "progress_changed" when the operation is completed.
560 * If the @delete_original paramter is TRUE then this function moves
561 * the messages between folders, otherwise it copies them.
564 * <informalexample><programlisting>
565 * queue = modest_tny_platform_factory_get_modest_mail_operation_queue_instance (fact);
566 * mail_op = modest_mail_operation_new ();
567 * modest_mail_operation_queue_add (queue, mail_op);
568 * g_signal_connect (G_OBJECT (mail_op), "progress_changed", G_CALLBACK(on_progress_changed), queue);
570 * modest_mail_operation_xfer_msg (mail_op, headers, folder, TRUE);
572 * g_object_unref (G_OBJECT (mail_op));
573 * </programlisting></informalexample>
576 void modest_mail_operation_xfer_msgs (ModestMailOperation *self,
577 TnyList *header_list,
579 gboolean delete_original,
580 XferMsgsAsyncUserCallback user_callback,
584 * modest_mail_operation_remove_msg:
585 * @self: a #ModestMailOperation
586 * @headers: the #TnyList of the messages to delete
587 * @remove_to_trash: TRUE to move it to trash or FALSE to delete it
590 * Deletes a list of messages.
592 void modest_mail_operation_remove_msgs (ModestMailOperation *self,
594 gboolean remove_to_trash);
597 * modest_mail_operation_get_msg:
598 * @self: a #ModestMailOperation
599 * @header_list: the #TnyHeader of the message to get
600 * @progress_feedback: a #gboolean. If %TRUE, we'll get progress bar feedback.
601 * @user_callback: a #GetMsgAsyncUserCallback function to call after tinymail callback execution.
602 * @user_data: generic user data which will be passed to @user_callback function.
604 * Gets a message from header using an user defined @callback function
605 * pased as argument. This operation is asynchronous, so the
606 * #ModestMailOperation should be added to #ModestMailOperationQueue
608 void modest_mail_operation_get_msg (ModestMailOperation *self,
610 gboolean progress_feedback,
611 GetMsgAsyncUserCallback user_callback,
614 * modest_mail_operation_get_msgs_full:
615 * @self: a #ModestMailOperation
616 * @header_list: a #TnyList of #TnyHeader objects to get and process
617 * @user_callback: a #TnyGetMsgCallback function to call after tinymail operation execution.
618 * @user_data: user data passed to both, user_callback and update_status_callback.
620 * Gets messages from headers list and process hem using @callback function
621 * pased as argument. This operation is asynchronous, so the
622 * #ModestMailOperation should be added to #ModestMailOperationQueue
624 void modest_mail_operation_get_msgs_full (ModestMailOperation *self,
625 TnyList *headers_list,
626 GetMsgAsyncUserCallback user_callback,
628 GDestroyNotify notify);
631 * modest_mail_operation_run_queue:
632 * @self: a #ModestMailOperation
633 * @queue: a #ModestTnySendQueue
635 * This mail operation is special. It should be running every time the send queue
636 * is running (after queue-start), and we should notify end of the operation
637 * after queue-end. Then, we should only set this queue on queue-start signal, and
638 * it will clean up the operation (notify end) on queue-end.
640 void modest_mail_operation_run_queue (ModestMailOperation *self,
641 ModestTnySendQueue *queue);
644 * modest_mail_operation_queue_wakeup:
645 * @self: a #ModestMailOperation
646 * @queue: a #ModestTnySendQueue
648 * This mail operation is special. It should be running every time the send queue
649 * wakeup is running and we should notify end of the operation
650 * after wakeup has done msg-sent notification.
652 void modest_mail_operation_queue_wakeup (ModestMailOperation *self,
653 ModestTnySendQueue *queue);
656 * modest_mail_operation_sync_folder:
657 * @self: a #ModestMailOperation
658 * @folder: a #TnyFolder
659 * @expunge: a #gboolean
661 * mail operation wrapper around tny_folder_sync () method, to keep modest
662 * running while we do that sync operation.
664 void modest_mail_operation_sync_folder (ModestMailOperation *self,
665 TnyFolder *folder, gboolean expunge);
668 * modest_mail_operation_shutdown:
669 * @self: a #ModestMailOperation
670 * @account_store: a #ModestTnyAccountStore
672 * disconnects all accounts in the account store (doing the proper syncs).
674 void modest_mail_operation_shutdown (ModestMailOperation *self,
675 ModestTnyAccountStore *account_store);
677 /* Functions to control mail operations */
679 * modest_mail_operation_get_task_done:
680 * @self: a #ModestMailOperation
682 * Gets the amount of work done for a given mail operation. This
683 * amount of work is an absolute value.
685 * Returns: the amount of work completed
687 guint modest_mail_operation_get_task_done (ModestMailOperation *self);
690 * modest_mail_operation_get_task_total:
691 * @self: a #ModestMailOperation
693 * Gets the total amount of work that must be done to complete a given
694 * mail operation. This amount of work is an absolute value.
696 * Returns: the total required amount of work
698 guint modest_mail_operation_get_task_total (ModestMailOperation *self);
702 * modest_mail_operation_is_finished:
703 * @self: a #ModestMailOperation
705 * Checks if the operation is finished. A #ModestMailOperation is
706 * finished if it's in any of the following states:
707 * MODEST_MAIL_OPERATION_STATUS_SUCCESS,
708 * MODEST_MAIL_OPERATION_STATUS_FAILED,
709 * MODEST_MAIL_OPERATION_STATUS_CANCELED or
710 * MODEST_MAIL_OPERATION_STATUS_FINISHED_WITH_ERRORS
712 * Returns: TRUE if the operation is finished, FALSE otherwise
714 gboolean modest_mail_operation_is_finished (ModestMailOperation *self);
717 * modest_mail_operation_is_finished:
718 * @self: a #ModestMailOperation
720 * Gets the current status of the given mail operation
722 * Returns: the current status or MODEST_MAIL_OPERATION_STATUS_INVALID in case of error
724 ModestMailOperationStatus modest_mail_operation_get_status (ModestMailOperation *self);
727 * modest_mail_operation_get_error:
728 * @self: a #ModestMailOperation
730 * Gets the error associated to the mail operation if exists
732 * Returns: the #GError associated to the #ModestMailOperation if it
733 * exists or NULL otherwise
735 const GError* modest_mail_operation_get_error (ModestMailOperation *self);
738 * modest_mail_operation_cancel:
739 * @self: a #ModestMailOperation
741 * Cancels an active mail operation
743 * Returns: TRUE if the operation was succesfully canceled, FALSE otherwise
745 gboolean modest_mail_operation_cancel (ModestMailOperation *self);
748 * modest_mail_operation_refresh_folder
749 * @self: a #ModestMailOperation
750 * @folder: the #TnyFolder to refresh
751 * @user_callback: the #RefreshAsyncUserCallback function to be called
752 * after internal refresh async callback was being executed.
754 * Refreshes the contents of a folder. After internal callback was executed,
755 * and all interna mail operation field were filled, if exists, it calls an
756 * user callback function to make UI operations which must be done after folder
759 void modest_mail_operation_refresh_folder (ModestMailOperation *self,
761 RefreshAsyncUserCallback user_callback,
765 * modest_mail_operation_get_account:
766 * @self: a #ModestMailOperation
768 * Gets the account associated to a mail operation
770 * Returns: the #TnyAccount associated to the #ModestMailOperation
772 TnyAccount *modest_mail_operation_get_account (ModestMailOperation *self);
776 * modest_mail_operation_noop:
777 * @self: a #ModestMailOperation
779 * Does nothing except emitting operation-started and
782 void modest_mail_operation_noop (ModestMailOperation *self);
786 * modest_mail_operation_to_string:
787 * @self: a #ModestMailOperation
789 * get a string representation of the mail operation (for debugging)
791 * Returns: a newly allocated string
793 gchar* modest_mail_operation_to_string (ModestMailOperation *self);
798 #endif /* __MODEST_MAIL_OPERATION_H__ */