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_UNKNOWN,
82 } ModestMailOperationTypeOperation;
85 * ErrorCheckingUserCallback:
87 * @mail_op: the current mail operation.
88 * @user_data: generic data passed to user defined function.
90 * This function implements required actions to performs under error
93 typedef void (*ErrorCheckingUserCallback) (ModestMailOperation *mail_op, gpointer user_data);
96 * ErrorCheckingUserDataDestroyer:
98 * @user_data: generic data passed to user defined function.
100 * This function is used to destroy the user_data passed to the error
101 * checking user callback function
103 typedef void (*ErrorCheckingUserDataDestroyer) (gpointer user_data);
107 * GetMsgAsyncUserCallback:
109 * @mail_op: the current #ModestMailOperation.
110 * @header: a #TnyHeader summary item.
111 * @msg: a #TnyMsg message retrieved by async operation.
112 * @user_data: generic data passed to user defined function.
114 * This function will be called after get_msg_cb private function, which is
115 * used as tinymail operation callback. The private function fills private
116 * fields of mail operation and calls user defined callback if it exists.
118 typedef void (*GetMsgAsyncUserCallback) (ModestMailOperation *mail_op,
126 * GetMimePartSizeCallback:
128 * @mail_op: the current #ModestMailOperation.
129 * @size: size of the attachment
130 * @user_data: generic data passed to user defined function.
133 typedef void (*GetMimePartSizeCallback) (ModestMailOperation *mail_op,
138 * XferMsgsAsyncUserCallback:
140 * @obj: a #GObject generic object which has created current mail operation.
141 * @new_folder: the new instance of the #TnyFolder that has been transferred
142 * @user_data: generic data passed to user defined function.
144 * This function will be called after transfer_msgs_cb private function, which is
145 * used as tinymail operation callback. The private function fills private
146 * fields of mail operation and calls user defined callback if it exists.
148 typedef void (*XferMsgsAsyncUserCallback) (ModestMailOperation *mail_op,
153 * XferFolderAsyncUserCallback:
155 * @obj: a #GObject generic object which has created current mail operation.
156 * @new_folder: the new instance of the #TnyFolder that has been transferred
157 * @user_data: generic data passed to user defined function.
159 * This function will be called after transfer_msgs_cb private function, which is
160 * used as tinymail operation callback. The private function fills private
161 * fields of mail operation and calls user defined callback if it exists.
163 typedef void (*XferFolderAsyncUserCallback) (ModestMailOperation *mail_op,
164 TnyFolder *new_folder,
169 * RefreshAsyncUserCallback:
171 * @mail_op: the current #ModestMailOperation.
172 * @folder: a #TnyFolder which has been refreshed .
173 * @user_data: generic data passed to user defined function.
175 * This function will be called after refresh_folder_async_cb private function, which is
176 * used as tinymail operation callback. The private function fills private
177 * fields of mail operation and calls user defined callback if it exists.
179 typedef void (*RefreshAsyncUserCallback) (ModestMailOperation *mail_op,
184 * UpdateAccountCallback:
186 * @self: a #ModestMailOperation
187 * @new_headers: the list of new headers received
188 * @user_data: generic data passed to user defined function.
190 * This is the callback of the update_account operation. It informs
191 * the caller about the amount of new messages that have been
194 typedef void (*UpdateAccountCallback) (ModestMailOperation *self,
195 TnyList *new_headers,
199 * SaveToDraftsCallback:
201 * @self: a #ModestMailOperation
202 * @saved_draft: the new draft message that has been saved
203 * @user_data: generic data passed to user defined function.
205 * This is the callback of the save_to_drafts operation. It returns
206 * the newly created msg stored in the Drafts folder
208 typedef void (*SaveToDraftstCallback) (ModestMailOperation *self,
213 typedef gboolean (*RetrieveAllCallback) (GObject *source,
218 * CreateFolderUserCallback:
220 * @mail_op: the current #ModestMailOperation.
221 * @folder: a #TnyFolder summary item.
222 * @user_data: generic data passed to user defined function.
224 * This function will be called after get_msg_cb private function, which is
225 * used as tinymail operation callback. The private function fills private
226 * fields of mail operation and calls user defined callback if it exists.
228 typedef void (*CreateFolderUserCallback) (ModestMailOperation *mail_op,
229 TnyFolderStore *parent_folder,
230 TnyFolder *new_folder,
233 /* This struct represents the internal state of a mail operation in a
241 ModestMailOperationStatus status;
242 ModestMailOperationTypeOperation op_type;
243 } ModestMailOperationState;
246 struct _ModestMailOperation {
248 /* insert public members, if any */
251 struct _ModestMailOperationClass {
252 GObjectClass parent_class;
255 void (*progress_changed) (ModestMailOperation *self, ModestMailOperationState *state, gpointer user_data);
256 void (*operation_started) (ModestMailOperation *self, gpointer user_data);
257 void (*operation_finished) (ModestMailOperation *self, gpointer user_data);
260 /* member functions */
261 GType modest_mail_operation_get_type (void) G_GNUC_CONST;
264 * modest_mail_operation_new:
265 * @source: a #GObject which creates this new operation.
267 * Creates a new instance of class #ModestMailOperation, using parameters
268 * to initialize its private structure. @source parameter may be NULL.
270 ModestMailOperation* modest_mail_operation_new (GObject *source);
273 * modest_mail_operation_new_with_error_handling:
274 * @id: a #ModestMailOperationId identification of operation type.
275 * @source: a #GObject which creates this new operation.
276 * @error_handler: a #ErrorCheckingUserCallback function to performs operations when
279 * Creates a new instance of class #ModestMailOperation, using parameters
280 * to initialize its private structure. @source parameter may be NULL.
281 * @error_handler can not be NULL, but it will be returned an mail operation
282 * object without error handling capability.
284 ModestMailOperation* modest_mail_operation_new_with_error_handling (GObject *source,
285 ErrorCheckingUserCallback error_handler,
287 ErrorCheckingUserDataDestroyer error_handler_destroyer);
289 * modest_mail_operation_execute_error_handler
290 * @self: a #ModestMailOperation
292 * Executes error handler if exists. The error handler is the one that
293 * MUST free the user data passed to the
294 * modest_mail_operation_new_with_error_handling constructor
297 modest_mail_operation_execute_error_handler (ModestMailOperation *self);
300 * modest_mail_operation_get_type_operation
301 * @self: a #ModestMailOperation
303 * Gets the private op_type field of mail operation. This op_type
304 * identifies the class/type of mail operation.
306 ModestMailOperationTypeOperation
307 modest_mail_operation_get_type_operation (ModestMailOperation *self);
310 * modest_mail_operation_is_mine
311 * @self: a #ModestMailOperation
312 * @source: a #GObject to check if it have created @self operation.
314 * Check if @source object its owner of @self mail operation.
316 * returns: TRUE if source its owner, FALSE otherwise.
319 modest_mail_operation_is_mine (ModestMailOperation *self,
323 * modest_mail_operation_get_source
324 * @self: a #ModestMailOperation
326 * returns a new reference to the object that created the mail
327 * operation passed to the constructor, or NULL if none. The caller
328 * must free the new reference
331 modest_mail_operation_get_source (ModestMailOperation *self);
333 /* fill in other public functions, eg.: */
336 * modest_mail_operation_send_mail:
337 * @self: a #ModestMailOperation
338 * @transport_account: a non-NULL #TnyTransportAccount
339 * @msg: a non-NULL #TnyMsg
341 * Sends and already existing message using the provided
342 * #TnyTransportAccount. This operation is synchronous, so the
343 * #ModestMailOperation should not be added to any
344 * #ModestMailOperationQueue
346 void modest_mail_operation_send_mail (ModestMailOperation *self,
347 TnyTransportAccount *transport_account,
351 * modest_mail_operation_send_new_mail:
352 * @self: a #ModestMailOperation
353 * @transport_account: a non-NULL #TnyTransportAccount
354 * @draft_msg: a #TnyMsg of the origin draft message, if any
355 * @from: the email address of the mail sender
356 * @to: a non-NULL email address of the mail receiver
357 * @cc: a comma-separated list of email addresses where to send a carbon copy
358 * @bcc: a comma-separated list of email addresses where to send a blind carbon copy
359 * @subject: the subject of the new mail
360 * @plain_body: the plain text body of the new mail.
361 * @html_body: the html version of the body of the new mail. If NULL, the mail will
362 * be sent with the plain body only.
363 * @attachments_list: a #GList of attachments, each attachment must be a #TnyMimePart
364 * @images_list: a #GList of image attachments, each attachment must be a #TnyMimePart
366 * Sends a new mail message using the provided
367 * #TnyTransportAccount. This operation is synchronous, so the
368 * #ModestMailOperation should not be added to any
369 * #ModestMailOperationQueue
371 void modest_mail_operation_send_new_mail (ModestMailOperation *self,
372 TnyTransportAccount *transport_account,
378 const gchar *subject,
379 const gchar *plain_body,
380 const gchar *html_body,
381 const GList *attachments_list,
382 const GList *images_list,
383 const gchar *references,
384 const gchar *in_reply_to,
385 TnyHeaderFlags priority_flags);
389 * modest_mail_operation_save_to_drafts:
390 * @self: a #ModestMailOperation
391 * @transport_account: a non-NULL #TnyTransportAccount
392 * @draft_msg: the previous draft message, in case it's an update
393 * to an existing draft.
394 * @from: the email address of the mail sender
395 * @to: a non-NULL email address of the mail receiver
396 * @cc: a comma-separated list of email addresses where to send a carbon copy
397 * @bcc: a comma-separated list of email addresses where to send a blind carbon copy
398 * @subject: the subject of the new mail
399 * @plain_body: the plain text body of the new mail.
400 * @html_body: the html version of the body of the new mail. If NULL, the mail will
401 * be sent with the plain body only.
402 * @attachments_list: a #GList of attachments, each attachment must be a #TnyMimePart
403 * @images_list: a #GList of image attachments, each attachment must be a #TnyMimePart
404 * @callback: the user callback, will be called when the operation finishes
405 * @user_data: data that will be passed to the user callback
407 * Save a mail message to drafts using the provided
408 * #TnyTransportAccount. This operation is asynchronous.
411 void modest_mail_operation_save_to_drafts (ModestMailOperation *self,
412 TnyTransportAccount *transport_account,
418 const gchar *subject,
419 const gchar *plain_body,
420 const gchar *html_body,
421 const GList *attachments_list,
422 const GList *images_list,
423 TnyHeaderFlags priority_flags,
424 const gchar *references,
425 const gchar *in_reply_to,
426 SaveToDraftstCallback callback,
429 * modest_mail_operation_update_account:
430 * @self: a #ModestMailOperation
431 * @account_name: the id of a Modest account
432 * @poke_all: if TRUE it will also do a poke_status over all folders of the account
433 * @interactive: if TRUE the update account was scheduled by an interactive send receive
435 * Asynchronously refreshes the root folders of the given store
436 * account. The caller should add the #ModestMailOperation to a
437 * #ModestMailOperationQueue and then free it. The caller will be
438 * notified by the "progress_changed" signal each time the progress of
439 * the operation changes.
442 * <informalexample><programlisting>
443 * queue = modest_tny_platform_factory_get_modest_mail_operation_queue_instance (fact)
444 * mail_op = modest_mail_operation_new ();
445 * g_signal_connect (G_OBJECT (mail_op), "progress_changed", G_CALLBACK(on_progress_changed), NULL);
446 * modest_mail_operation_queue_add (queue, mail_op);
447 * modest_mail_operation_update_account (mail_op, account_name)
448 * g_object_unref (G_OBJECT (mail_op));
449 * </programlisting></informalexample>
451 * Note that the account_name *MUST* be a modest account name, not a
452 * tinymail store account name
455 void modest_mail_operation_update_account (ModestMailOperation *self,
456 const gchar *account_name,
458 gboolean interactive,
459 RetrieveAllCallback retrieve_all_cb,
460 UpdateAccountCallback callback,
463 /* Functions that perform store operations */
466 * modest_mail_operation_create_folder:
467 * @self: a #ModestMailOperation
468 * @parent: the #TnyFolderStore which is the parent of the new folder
469 * @name: the non-NULL new name for the new folder
471 * Creates a new folder as a children of a existing one. If the store
472 * account supports subscriptions this method also sets the new folder
473 * as subscribed. This operation is synchronous, so the
474 * #ModestMailOperation should not be added to any
475 * #ModestMailOperationQueue
477 * Returns: a newly created #TnyFolder or NULL in case of error.
479 void modest_mail_operation_create_folder (ModestMailOperation *self,
480 TnyFolderStore *parent,
482 CreateFolderUserCallback callback,
486 * modest_mail_operation_remove_folder:
487 * @self: a #ModestMailOperation
488 * @folder: a #TnyFolder
489 * @remove_to_trash: TRUE to move it to trash or FALSE to delete
492 * Removes a folder. This operation is synchronous, so the
493 * #ModestMailOperation should not be added to any
494 * #ModestMailOperationQueue
496 void modest_mail_operation_remove_folder (ModestMailOperation *self,
498 gboolean remove_to_trash);
501 * modest_mail_operation_rename_folder:
502 * @self: a #ModestMailOperation
503 * @folder: a #TnyFolder
504 * @name: a non-NULL name without "/"
506 * Renames a given folder with the provided new name. This operation
507 * is synchronous, so the #ModestMailOperation should not be added to
508 * any #ModestMailOperationQueue
510 void modest_mail_operation_rename_folder (ModestMailOperation *self,
513 XferFolderAsyncUserCallback user_callback,
517 * modest_mail_operation_xfer_folder:
518 * @self: a #ModestMailOperation
519 * @folder: a #TnyFolder
520 * @parent: the new parent of the folder as #TnyFolderStore
521 * @delete_original: wheter or not delete the original folder
522 * @user_callback: a #XferFolderAsyncUserCallback function to call after tinymail callback execution.
523 * @user_data: generic user data which will be passed to @user_callback function.
525 * Sets the given @folder as child of a provided #TnyFolderStore. This
526 * operation also transfers all the messages contained in the folder
527 * and all of his children folders with their messages as well. This
528 * operation is synchronous, so the #ModestMailOperation should not be
529 * added to any #ModestMailOperationQueue.
531 * If @delete_original is TRUE this function moves the original
532 * folder, if it is FALSE the it just copies it
535 void modest_mail_operation_xfer_folder (ModestMailOperation *self,
537 TnyFolderStore *parent,
538 gboolean delete_original,
539 XferFolderAsyncUserCallback user_callback,
543 /* Functions that performs msg operations */
546 * modest_mail_operation_xfer_msgs:
547 * @self: a #ModestMailOperation
548 * @header_list: a #TnyList of #TnyHeader to transfer
549 * @folder: the #TnyFolder where the messages will be transferred
550 * @delete_original: whether or not delete the source messages
551 * @user_callback: a #XferFolderAsyncUserCallback function to call after tinymail callback execution.
552 * @user_data: generic user data which will be passed to @user_callback function.
554 * Asynchronously transfers messages from their current folder to
555 * another one. The caller should add the #ModestMailOperation to a
556 * #ModestMailOperationQueue and then free it. The caller will be
557 * notified by the "progress_changed" when the operation is completed.
559 * If the @delete_original paramter is TRUE then this function moves
560 * the messages between folders, otherwise it copies them.
563 * <informalexample><programlisting>
564 * queue = modest_tny_platform_factory_get_modest_mail_operation_queue_instance (fact);
565 * mail_op = modest_mail_operation_new ();
566 * modest_mail_operation_queue_add (queue, mail_op);
567 * g_signal_connect (G_OBJECT (mail_op), "progress_changed", G_CALLBACK(on_progress_changed), queue);
569 * modest_mail_operation_xfer_msg (mail_op, headers, folder, TRUE);
571 * g_object_unref (G_OBJECT (mail_op));
572 * </programlisting></informalexample>
575 void modest_mail_operation_xfer_msgs (ModestMailOperation *self,
576 TnyList *header_list,
578 gboolean delete_original,
579 XferMsgsAsyncUserCallback user_callback,
583 * modest_mail_operation_remove_msgs:
584 * @self: a #ModestMailOperation
585 * @headers: the #TnyList of the messages to delete
586 * @remove_to_trash: TRUE to move it to trash or FALSE to delete it
589 * Deletes a list of messages.
591 void modest_mail_operation_remove_msgs (ModestMailOperation *self,
593 gboolean remove_to_trash);
596 * modest_mail_operation_get_msg:
597 * @self: a #ModestMailOperation
598 * @header_list: the #TnyHeader of the message to get
599 * @progress_feedback: a #gboolean. If %TRUE, we'll get progress bar feedback.
600 * @user_callback: a #GetMsgAsyncUserCallback function to call after tinymail callback execution.
601 * @user_data: generic user data which will be passed to @user_callback function.
603 * Gets a message from header using an user defined @callback function
604 * pased as argument. This operation is asynchronous, so the
605 * #ModestMailOperation should be added to #ModestMailOperationQueue
607 void modest_mail_operation_get_msg (ModestMailOperation *self,
609 gboolean progress_feedback,
610 GetMsgAsyncUserCallback user_callback,
613 * modest_mail_operation_get_msgs_full:
614 * @self: a #ModestMailOperation
615 * @header_list: a #TnyList of #TnyHeader objects to get and process
616 * @user_callback: a #TnyGetMsgCallback function to call after tinymail operation execution.
617 * @user_data: user data passed to both, user_callback and update_status_callback.
619 * Gets messages from headers list and process hem using @callback function
620 * pased as argument. This operation is asynchronous, so the
621 * #ModestMailOperation should be added to #ModestMailOperationQueue
623 void modest_mail_operation_get_msgs_full (ModestMailOperation *self,
624 TnyList *headers_list,
625 GetMsgAsyncUserCallback user_callback,
627 GDestroyNotify notify);
630 * modest_mail_operation_run_queue:
631 * @self: a #ModestMailOperation
632 * @queue: a #ModestTnySendQueue
634 * This mail operation is special. It should be running every time the send queue
635 * is running (after queue-start), and we should notify end of the operation
636 * after queue-end. Then, we should only set this queue on queue-start signal, and
637 * it will clean up the operation (notify end) on queue-end.
639 void modest_mail_operation_run_queue (ModestMailOperation *self,
640 ModestTnySendQueue *queue);
643 * modest_mail_operation_queue_wakeup:
644 * @self: a #ModestMailOperation
645 * @queue: a #ModestTnySendQueue
647 * This mail operation is special. It should be running every time the send queue
648 * wakeup is running and we should notify end of the operation
649 * after wakeup has done msg-sent notification.
651 void modest_mail_operation_queue_wakeup (ModestMailOperation *self,
652 ModestTnySendQueue *queue);
655 * modest_mail_operation_sync_folder:
656 * @self: a #ModestMailOperation
657 * @folder: a #TnyFolder
658 * @expunge: a #gboolean
660 * mail operation wrapper around tny_folder_sync () method, to keep modest
661 * running while we do that sync operation.
663 void modest_mail_operation_sync_folder (ModestMailOperation *self,
664 TnyFolder *folder, gboolean expunge);
667 * modest_mail_operation_shutdown:
668 * @self: a #ModestMailOperation
669 * @account_store: a #ModestTnyAccountStore
671 * disconnects all accounts in the account store (doing the proper syncs).
673 void modest_mail_operation_shutdown (ModestMailOperation *self,
674 ModestTnyAccountStore *account_store);
676 /* Functions to control mail operations */
678 * modest_mail_operation_get_task_done:
679 * @self: a #ModestMailOperation
681 * Gets the amount of work done for a given mail operation. This
682 * amount of work is an absolute value.
684 * Returns: the amount of work completed
686 guint modest_mail_operation_get_task_done (ModestMailOperation *self);
689 * modest_mail_operation_get_task_total:
690 * @self: a #ModestMailOperation
692 * Gets the total amount of work that must be done to complete a given
693 * mail operation. This amount of work is an absolute value.
695 * Returns: the total required amount of work
697 guint modest_mail_operation_get_task_total (ModestMailOperation *self);
701 * modest_mail_operation_is_finished:
702 * @self: a #ModestMailOperation
704 * Checks if the operation is finished. A #ModestMailOperation is
705 * finished if it's in any of the following states:
706 * MODEST_MAIL_OPERATION_STATUS_SUCCESS,
707 * MODEST_MAIL_OPERATION_STATUS_FAILED,
708 * MODEST_MAIL_OPERATION_STATUS_CANCELED or
709 * MODEST_MAIL_OPERATION_STATUS_FINISHED_WITH_ERRORS
711 * Returns: TRUE if the operation is finished, FALSE otherwise
713 gboolean modest_mail_operation_is_finished (ModestMailOperation *self);
716 * modest_mail_operation_is_finished:
717 * @self: a #ModestMailOperation
719 * Gets the current status of the given mail operation
721 * Returns: the current status or MODEST_MAIL_OPERATION_STATUS_INVALID in case of error
723 ModestMailOperationStatus modest_mail_operation_get_status (ModestMailOperation *self);
726 * modest_mail_operation_get_error:
727 * @self: a #ModestMailOperation
729 * Gets the error associated to the mail operation if exists
731 * Returns: the #GError associated to the #ModestMailOperation if it
732 * exists or NULL otherwise
734 const GError* modest_mail_operation_get_error (ModestMailOperation *self);
737 * modest_mail_operation_cancel:
738 * @self: a #ModestMailOperation
740 * Cancels an active mail operation
742 * Returns: TRUE if the operation was succesfully canceled, FALSE otherwise
744 gboolean modest_mail_operation_cancel (ModestMailOperation *self);
747 * modest_mail_operation_refresh_folder
748 * @self: a #ModestMailOperation
749 * @folder: the #TnyFolder to refresh
750 * @user_callback: the #RefreshAsyncUserCallback function to be called
751 * after internal refresh async callback was being executed.
753 * Refreshes the contents of a folder. After internal callback was executed,
754 * and all interna mail operation field were filled, if exists, it calls an
755 * user callback function to make UI operations which must be done after folder
758 void modest_mail_operation_refresh_folder (ModestMailOperation *self,
760 RefreshAsyncUserCallback user_callback,
764 * modest_mail_operation_get_account:
765 * @self: a #ModestMailOperation
767 * Gets the account associated to a mail operation
769 * Returns: the #TnyAccount associated to the #ModestMailOperation
771 TnyAccount *modest_mail_operation_get_account (ModestMailOperation *self);
775 * modest_mail_operation_noop:
776 * @self: a #ModestMailOperation
778 * Does nothing except emitting operation-started and
781 void modest_mail_operation_noop (ModestMailOperation *self);
785 * modest_mail_operation_to_string:
786 * @self: a #ModestMailOperation
788 * get a string representation of the mail operation (for debugging)
790 * Returns: a newly allocated string
792 gchar* modest_mail_operation_to_string (ModestMailOperation *self);
797 #endif /* __MODEST_MAIL_OPERATION_H__ */