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>
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_UNKNOWN,
80 } ModestMailOperationTypeOperation;
83 * ErrorCheckingUserCallback:
85 * @mail_op: the current mail operation.
86 * @user_data: generic data passed to user defined function.
88 * This function implements required actions to performs under error
91 typedef void (*ErrorCheckingUserCallback) (ModestMailOperation *mail_op, gpointer user_data);
94 * ErrorCheckingUserDataDestroyer:
96 * @user_data: generic data passed to user defined function.
98 * This function is used to destroy the user_data passed to the error
99 * checking user callback function
101 typedef void (*ErrorCheckingUserDataDestroyer) (gpointer user_data);
105 * GetMsgAsyncUserCallback:
107 * @mail_op: the current #ModestMailOperation.
108 * @header: a #TnyHeader summary item.
109 * @msg: a #TnyMsg message retrieved by async operation.
110 * @user_data: generic data passed to user defined function.
112 * This function will be called after get_msg_cb private function, which is
113 * used as tinymail operation callback. The private function fills private
114 * fields of mail operation and calls user defined callback if it exists.
116 typedef void (*GetMsgAsyncUserCallback) (ModestMailOperation *mail_op,
124 * GetMimePartSizeCallback:
126 * @mail_op: the current #ModestMailOperation.
127 * @size: size of the attachment
128 * @user_data: generic data passed to user defined function.
131 typedef void (*GetMimePartSizeCallback) (ModestMailOperation *mail_op,
136 * XferMsgsAsyncUserCallback:
138 * @obj: a #GObject generic object which has created current mail operation.
139 * @new_folder: the new instance of the #TnyFolder that has been transferred
140 * @user_data: generic data passed to user defined function.
142 * This function will be called after transfer_msgs_cb private function, which is
143 * used as tinymail operation callback. The private function fills private
144 * fields of mail operation and calls user defined callback if it exists.
146 typedef void (*XferMsgsAsyncUserCallback) (ModestMailOperation *mail_op,
151 * XferFolderAsyncUserCallback:
153 * @obj: a #GObject generic object which has created current mail operation.
154 * @new_folder: the new instance of the #TnyFolder that has been transferred
155 * @user_data: generic data passed to user defined function.
157 * This function will be called after transfer_msgs_cb private function, which is
158 * used as tinymail operation callback. The private function fills private
159 * fields of mail operation and calls user defined callback if it exists.
161 typedef void (*XferFolderAsyncUserCallback) (ModestMailOperation *mail_op,
162 TnyFolder *new_folder,
167 * RefreshAsyncUserCallback:
169 * @mail_op: the current #ModestMailOperation.
170 * @folder: a #TnyFolder which has been refreshed .
171 * @user_data: generic data passed to user defined function.
173 * This function will be called after refresh_folder_async_cb private function, which is
174 * used as tinymail operation callback. The private function fills private
175 * fields of mail operation and calls user defined callback if it exists.
177 typedef void (*RefreshAsyncUserCallback) (ModestMailOperation *mail_op,
182 * UpdateAccountCallback:
184 * @self: a #ModestMailOperation
185 * @new_headers: the list of new headers received
186 * @user_data: generic data passed to user defined function.
188 * This is the callback of the update_account operation. It informs
189 * the caller about the amount of new messages that have been
192 typedef void (*UpdateAccountCallback) (ModestMailOperation *self,
193 TnyList *new_headers,
197 * SaveToDraftsCallback:
199 * @self: a #ModestMailOperation
200 * @saved_draft: the new draft message that has been saved
201 * @user_data: generic data passed to user defined function.
203 * This is the callback of the save_to_drafts operation. It returns
204 * the newly created msg stored in the Drafts folder
206 typedef void (*SaveToDraftstCallback) (ModestMailOperation *self,
211 typedef gboolean (*RetrieveAllCallback) (GObject *source,
216 * CreateFolderUserCallback:
218 * @mail_op: the current #ModestMailOperation.
219 * @folder: a #TnyFolder summary item.
220 * @user_data: generic data passed to user defined function.
222 * This function will be called after get_msg_cb private function, which is
223 * used as tinymail operation callback. The private function fills private
224 * fields of mail operation and calls user defined callback if it exists.
226 typedef void (*CreateFolderUserCallback) (ModestMailOperation *mail_op,
227 TnyFolderStore *parent_folder,
228 TnyFolder *new_folder,
231 /* This struct represents the internal state of a mail operation in a
239 ModestMailOperationStatus status;
240 ModestMailOperationTypeOperation op_type;
241 } ModestMailOperationState;
244 struct _ModestMailOperation {
246 /* insert public members, if any */
249 struct _ModestMailOperationClass {
250 GObjectClass parent_class;
253 void (*progress_changed) (ModestMailOperation *self, ModestMailOperationState *state, gpointer user_data);
254 void (*operation_started) (ModestMailOperation *self, gpointer user_data);
255 void (*operation_finished) (ModestMailOperation *self, gpointer user_data);
258 /* member functions */
259 GType modest_mail_operation_get_type (void) G_GNUC_CONST;
262 * modest_mail_operation_new:
263 * @source: a #GObject which creates this new operation.
265 * Creates a new instance of class #ModestMailOperation, using parameters
266 * to initialize its private structure. @source parameter may be NULL.
268 ModestMailOperation* modest_mail_operation_new (GObject *source);
271 * modest_mail_operation_new_with_error_handling:
272 * @id: a #ModestMailOperationId identification of operation type.
273 * @source: a #GObject which creates this new operation.
274 * @error_handler: a #ErrorCheckingUserCallback function to performs operations when
277 * Creates a new instance of class #ModestMailOperation, using parameters
278 * to initialize its private structure. @source parameter may be NULL.
279 * @error_handler can not be NULL, but it will be returned an mail operation
280 * object without error handling capability.
282 ModestMailOperation* modest_mail_operation_new_with_error_handling (GObject *source,
283 ErrorCheckingUserCallback error_handler,
285 ErrorCheckingUserDataDestroyer error_handler_destroyer);
287 * modest_mail_operation_execute_error_handler
288 * @self: a #ModestMailOperation
290 * Executes error handler if exists. The error handler is the one that
291 * MUST free the user data passed to the
292 * modest_mail_operation_new_with_error_handling constructor
295 modest_mail_operation_execute_error_handler (ModestMailOperation *self);
298 * modest_mail_operation_get_type_operation
299 * @self: a #ModestMailOperation
301 * Gets the private op_type field of mail operation. This op_type
302 * identifies the class/type of mail operation.
304 ModestMailOperationTypeOperation
305 modest_mail_operation_get_type_operation (ModestMailOperation *self);
308 * modest_mail_operation_is_mine
309 * @self: a #ModestMailOperation
310 * @source: a #GObject to check if it have created @self operation.
312 * Check if @source object its owner of @self mail operation.
314 * returns: TRUE if source its owner, FALSE otherwise.
317 modest_mail_operation_is_mine (ModestMailOperation *self,
321 * modest_mail_operation_get_source
322 * @self: a #ModestMailOperation
324 * returns a new reference to the object that created the mail
325 * operation passed to the constructor, or NULL if none. The caller
326 * must free the new reference
329 modest_mail_operation_get_source (ModestMailOperation *self);
331 /* fill in other public functions, eg.: */
334 * modest_mail_operation_send_mail:
335 * @self: a #ModestMailOperation
336 * @transport_account: a non-NULL #TnyTransportAccount
337 * @msg: a non-NULL #TnyMsg
339 * Sends and already existing message using the provided
340 * #TnyTransportAccount. This operation is synchronous, so the
341 * #ModestMailOperation should not be added to any
342 * #ModestMailOperationQueue
344 void modest_mail_operation_send_mail (ModestMailOperation *self,
345 TnyTransportAccount *transport_account,
349 * modest_mail_operation_send_new_mail:
350 * @self: a #ModestMailOperation
351 * @transport_account: a non-NULL #TnyTransportAccount
352 * @draft_msg: a #TnyMsg of the origin draft message, if any
353 * @from: the email address of the mail sender
354 * @to: a non-NULL email address of the mail receiver
355 * @cc: a comma-separated list of email addresses where to send a carbon copy
356 * @bcc: a comma-separated list of email addresses where to send a blind carbon copy
357 * @subject: the subject of the new mail
358 * @plain_body: the plain text body of the new mail.
359 * @html_body: the html version of the body of the new mail. If NULL, the mail will
360 * be sent with the plain body only.
361 * @attachments_list: a #GList of attachments, each attachment must be a #TnyMimePart
362 * @images_list: a #GList of image attachments, each attachment must be a #TnyMimePart
364 * Sends a new mail message using the provided
365 * #TnyTransportAccount. This operation is synchronous, so the
366 * #ModestMailOperation should not be added to any
367 * #ModestMailOperationQueue
369 void modest_mail_operation_send_new_mail (ModestMailOperation *self,
370 TnyTransportAccount *transport_account,
376 const gchar *subject,
377 const gchar *plain_body,
378 const gchar *html_body,
379 const GList *attachments_list,
380 const GList *images_list,
381 TnyHeaderFlags priority_flags);
385 * modest_mail_operation_save_to_drafts:
386 * @self: a #ModestMailOperation
387 * @transport_account: a non-NULL #TnyTransportAccount
388 * @draft_msg: the previous draft message, in case it's an update
389 * to an existing draft.
390 * @from: the email address of the mail sender
391 * @to: a non-NULL email address of the mail receiver
392 * @cc: a comma-separated list of email addresses where to send a carbon copy
393 * @bcc: a comma-separated list of email addresses where to send a blind carbon copy
394 * @subject: the subject of the new mail
395 * @plain_body: the plain text body of the new mail.
396 * @html_body: the html version of the body of the new mail. If NULL, the mail will
397 * be sent with the plain body only.
398 * @attachments_list: a #GList of attachments, each attachment must be a #TnyMimePart
399 * @images_list: a #GList of image attachments, each attachment must be a #TnyMimePart
400 * @callback: the user callback, will be called when the operation finishes
401 * @user_data: data that will be passed to the user callback
403 * Save a mail message to drafts using the provided
404 * #TnyTransportAccount. This operation is asynchronous.
407 void modest_mail_operation_save_to_drafts (ModestMailOperation *self,
408 TnyTransportAccount *transport_account,
414 const gchar *subject,
415 const gchar *plain_body,
416 const gchar *html_body,
417 const GList *attachments_list,
418 const GList *images_list,
419 TnyHeaderFlags priority_flags,
420 SaveToDraftstCallback callback,
423 * modest_mail_operation_update_account:
424 * @self: a #ModestMailOperation
425 * @account_name: the id of a Modest account
426 * @poke_all: if TRUE it will also do a poke_status over all folders of the account
428 * Asynchronously refreshes the root folders of the given store
429 * account. The caller should add the #ModestMailOperation to a
430 * #ModestMailOperationQueue and then free it. The caller will be
431 * notified by the "progress_changed" signal each time the progress of
432 * the operation changes.
435 * <informalexample><programlisting>
436 * queue = modest_tny_platform_factory_get_modest_mail_operation_queue_instance (fact)
437 * mail_op = modest_mail_operation_new ();
438 * g_signal_connect (G_OBJECT (mail_op), "progress_changed", G_CALLBACK(on_progress_changed), NULL);
439 * modest_mail_operation_queue_add (queue, mail_op);
440 * modest_mail_operation_update_account (mail_op, account_name)
441 * g_object_unref (G_OBJECT (mail_op));
442 * </programlisting></informalexample>
444 * Note that the account_name *MUST* be a modest account name, not a
445 * tinymail store account name
448 void modest_mail_operation_update_account (ModestMailOperation *self,
449 const gchar *account_name,
451 RetrieveAllCallback retrieve_all_cb,
452 UpdateAccountCallback callback,
455 /* Functions that perform store operations */
458 * modest_mail_operation_create_folder:
459 * @self: a #ModestMailOperation
460 * @parent: the #TnyFolderStore which is the parent of the new folder
461 * @name: the non-NULL new name for the new folder
463 * Creates a new folder as a children of a existing one. If the store
464 * account supports subscriptions this method also sets the new folder
465 * as subscribed. This operation is synchronous, so the
466 * #ModestMailOperation should not be added to any
467 * #ModestMailOperationQueue
469 * Returns: a newly created #TnyFolder or NULL in case of error.
471 void modest_mail_operation_create_folder (ModestMailOperation *self,
472 TnyFolderStore *parent,
474 CreateFolderUserCallback callback,
478 * modest_mail_operation_remove_folder:
479 * @self: a #ModestMailOperation
480 * @folder: a #TnyFolder
481 * @remove_to_trash: TRUE to move it to trash or FALSE to delete
484 * Removes a folder. This operation is synchronous, so the
485 * #ModestMailOperation should not be added to any
486 * #ModestMailOperationQueue
488 void modest_mail_operation_remove_folder (ModestMailOperation *self,
490 gboolean remove_to_trash);
493 * modest_mail_operation_rename_folder:
494 * @self: a #ModestMailOperation
495 * @folder: a #TnyFolder
496 * @name: a non-NULL name without "/"
498 * Renames a given folder with the provided new name. This operation
499 * is synchronous, so the #ModestMailOperation should not be added to
500 * any #ModestMailOperationQueue
502 void modest_mail_operation_rename_folder (ModestMailOperation *self,
505 XferFolderAsyncUserCallback user_callback,
509 * modest_mail_operation_xfer_folder:
510 * @self: a #ModestMailOperation
511 * @folder: a #TnyFolder
512 * @parent: the new parent of the folder as #TnyFolderStore
513 * @delete_original: wheter or not delete the original folder
514 * @user_callback: a #XferFolderAsyncUserCallback function to call after tinymail callback execution.
515 * @user_data: generic user data which will be passed to @user_callback function.
517 * Sets the given @folder as child of a provided #TnyFolderStore. This
518 * operation also transfers all the messages contained in the folder
519 * and all of his children folders with their messages as well. This
520 * operation is synchronous, so the #ModestMailOperation should not be
521 * added to any #ModestMailOperationQueue.
523 * If @delete_original is TRUE this function moves the original
524 * folder, if it is FALSE the it just copies it
527 void modest_mail_operation_xfer_folder (ModestMailOperation *self,
529 TnyFolderStore *parent,
530 gboolean delete_original,
531 XferFolderAsyncUserCallback user_callback,
535 /* Functions that performs msg operations */
538 * modest_mail_operation_xfer_msgs:
539 * @self: a #ModestMailOperation
540 * @header_list: a #TnyList of #TnyHeader to transfer
541 * @folder: the #TnyFolder where the messages will be transferred
542 * @delete_original: whether or not delete the source messages
543 * @user_callback: a #XferFolderAsyncUserCallback function to call after tinymail callback execution.
544 * @user_data: generic user data which will be passed to @user_callback function.
546 * Asynchronously transfers messages from their current folder to
547 * another one. The caller should add the #ModestMailOperation to a
548 * #ModestMailOperationQueue and then free it. The caller will be
549 * notified by the "progress_changed" when the operation is completed.
551 * If the @delete_original paramter is TRUE then this function moves
552 * the messages between folders, otherwise it copies them.
555 * <informalexample><programlisting>
556 * queue = modest_tny_platform_factory_get_modest_mail_operation_queue_instance (fact);
557 * mail_op = modest_mail_operation_new ();
558 * modest_mail_operation_queue_add (queue, mail_op);
559 * g_signal_connect (G_OBJECT (mail_op), "progress_changed", G_CALLBACK(on_progress_changed), queue);
561 * modest_mail_operation_xfer_msg (mail_op, headers, folder, TRUE);
563 * g_object_unref (G_OBJECT (mail_op));
564 * </programlisting></informalexample>
567 void modest_mail_operation_xfer_msgs (ModestMailOperation *self,
568 TnyList *header_list,
570 gboolean delete_original,
571 XferMsgsAsyncUserCallback user_callback,
575 * modest_mail_operation_remove_msg:
576 * @self: a #ModestMailOperation
577 * @header: the #TnyHeader of the message to move
578 * @remove_to_trash: TRUE to move it to trash or FALSE to delete it
581 * Deletes a message. This operation is synchronous, so the
582 * #ModestMailOperation should not be added to any
583 * #ModestMailOperationQueue
585 void modest_mail_operation_remove_msg (ModestMailOperation *self,
587 gboolean remove_to_trash);
590 * modest_mail_operation_remove_msg:
591 * @self: a #ModestMailOperation
592 * @headers: the #TnyList of the messages to delete
593 * @remove_to_trash: TRUE to move it to trash or FALSE to delete it
596 * Deletes a list of messages. This operation is synchronous, so the
597 * #ModestMailOperation should not be added to any
598 * #ModestMailOperationQueue
600 void modest_mail_operation_remove_msgs (ModestMailOperation *self,
602 gboolean remove_to_trash);
605 * modest_mail_operation_get_msg:
606 * @self: a #ModestMailOperation
607 * @header_list: the #TnyHeader of the message to get
608 * @user_callback: a #GetMsgAsyncUserCallback function to call after tinymail callback execution.
609 * @user_data: generic user data which will be passed to @user_callback function.
611 * Gets a message from header using an user defined @callback function
612 * pased as argument. This operation is asynchronous, so the
613 * #ModestMailOperation should be added to #ModestMailOperationQueue
615 void modest_mail_operation_get_msg (ModestMailOperation *self,
617 GetMsgAsyncUserCallback user_callback,
620 * modest_mail_operation_get_msgs_full:
621 * @self: a #ModestMailOperation
622 * @header_list: a #TnyList of #TnyHeader objects to get and process
623 * @user_callback: a #TnyGetMsgCallback function to call after tinymail operation execution.
624 * @user_data: user data passed to both, user_callback and update_status_callback.
626 * Gets messages from headers list and process hem using @callback function
627 * pased as argument. This operation is asynchronous, so the
628 * #ModestMailOperation should be added to #ModestMailOperationQueue
630 void modest_mail_operation_get_msgs_full (ModestMailOperation *self,
631 TnyList *headers_list,
632 GetMsgAsyncUserCallback user_callback,
634 GDestroyNotify notify);
637 * modest_mail_operation_run_queue:
638 * @self: a #ModestMailOperation
639 * @queue: a #ModestTnySendQueue
641 * This mail operation is special. It should be running every time the send queue
642 * is running (after queue-start), and we should notify end of the operation
643 * after queue-end. Then, we should only set this queue on queue-start signal, and
644 * it will clean up the operation (notify end) on queue-end.
646 void modest_mail_operation_run_queue (ModestMailOperation *self,
647 ModestTnySendQueue *queue);
650 * modest_mail_operation_sync_folder:
651 * @self: a #ModestMailOperation
652 * @folder: a #TnyFolder
653 * @expunge: a #gboolean
655 * mail operation wrapper around tny_folder_sync () method, to keep modest
656 * running while we do that sync operation.
658 void modest_mail_operation_sync_folder (ModestMailOperation *self,
659 TnyFolder *folder, gboolean expunge);
661 /* Functions to control mail operations */
663 * modest_mail_operation_get_task_done:
664 * @self: a #ModestMailOperation
666 * Gets the amount of work done for a given mail operation. This
667 * amount of work is an absolute value.
669 * Returns: the amount of work completed
671 guint modest_mail_operation_get_task_done (ModestMailOperation *self);
674 * modest_mail_operation_get_task_total:
675 * @self: a #ModestMailOperation
677 * Gets the total amount of work that must be done to complete a given
678 * mail operation. This amount of work is an absolute value.
680 * Returns: the total required amount of work
682 guint modest_mail_operation_get_task_total (ModestMailOperation *self);
686 * modest_mail_operation_is_finished:
687 * @self: a #ModestMailOperation
689 * Checks if the operation is finished. A #ModestMailOperation is
690 * finished if it's in any of the following states:
691 * MODEST_MAIL_OPERATION_STATUS_SUCCESS,
692 * MODEST_MAIL_OPERATION_STATUS_FAILED,
693 * MODEST_MAIL_OPERATION_STATUS_CANCELED or
694 * MODEST_MAIL_OPERATION_STATUS_FINISHED_WITH_ERRORS
696 * Returns: TRUE if the operation is finished, FALSE otherwise
698 gboolean modest_mail_operation_is_finished (ModestMailOperation *self);
701 * modest_mail_operation_is_finished:
702 * @self: a #ModestMailOperation
704 * Gets the current status of the given mail operation
706 * Returns: the current status or MODEST_MAIL_OPERATION_STATUS_INVALID in case of error
708 ModestMailOperationStatus modest_mail_operation_get_status (ModestMailOperation *self);
711 * modest_mail_operation_get_error:
712 * @self: a #ModestMailOperation
714 * Gets the error associated to the mail operation if exists
716 * Returns: the #GError associated to the #ModestMailOperation if it
717 * exists or NULL otherwise
719 const GError* modest_mail_operation_get_error (ModestMailOperation *self);
722 * modest_mail_operation_cancel:
723 * @self: a #ModestMailOperation
725 * Cancels an active mail operation
727 * Returns: TRUE if the operation was succesfully canceled, FALSE otherwise
729 gboolean modest_mail_operation_cancel (ModestMailOperation *self);
732 * modest_mail_operation_refresh_folder
733 * @self: a #ModestMailOperation
734 * @folder: the #TnyFolder to refresh
735 * @user_callback: the #RefreshAsyncUserCallback function to be called
736 * after internal refresh async callback was being executed.
738 * Refreshes the contents of a folder. After internal callback was executed,
739 * and all interna mail operation field were filled, if exists, it calls an
740 * user callback function to make UI operations which must be done after folder
743 void modest_mail_operation_refresh_folder (ModestMailOperation *self,
745 RefreshAsyncUserCallback user_callback,
749 * modest_mail_operation_get_account:
750 * @self: a #ModestMailOperation
752 * Gets the account associated to a mail operation
754 * Returns: the #TnyAccount associated to the #ModestMailOperation
756 TnyAccount *modest_mail_operation_get_account (ModestMailOperation *self);
760 * modest_mail_operation_noop:
761 * @self: a #ModestMailOperation
763 * Does nothing except emitting operation-started and
766 void modest_mail_operation_noop (ModestMailOperation *self);
770 * modest_mail_operation_to_string:
771 * @self: a #ModestMailOperation
773 * get a string representation of the mail operation (for debugging)
775 * Returns: a newly allocated string
777 gchar* modest_mail_operation_to_string (ModestMailOperation *self);
782 #endif /* __MODEST_MAIL_OPERATION_H__ */