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,
234 * SyncFolderCallback:
236 * @self: a #ModestMailOperation
237 * @folder: the #TnyFolder to sync
238 * @user_data: generic data passed to user defined function.
240 * This is the callback of the sync_folder operation.
242 typedef void (*SyncFolderCallback) (ModestMailOperation *self,
247 /* This struct represents the internal state of a mail operation in a
255 ModestMailOperationStatus status;
256 ModestMailOperationTypeOperation op_type;
257 } ModestMailOperationState;
260 struct _ModestMailOperation {
262 /* insert public members, if any */
265 struct _ModestMailOperationClass {
266 GObjectClass parent_class;
269 void (*progress_changed) (ModestMailOperation *self, ModestMailOperationState *state, gpointer user_data);
270 void (*operation_started) (ModestMailOperation *self, gpointer user_data);
271 void (*operation_finished) (ModestMailOperation *self, gpointer user_data);
274 /* member functions */
275 GType modest_mail_operation_get_type (void) G_GNUC_CONST;
278 * modest_mail_operation_new:
279 * @source: a #GObject which creates this new operation.
281 * Creates a new instance of class #ModestMailOperation, using parameters
282 * to initialize its private structure. @source parameter may be NULL.
284 ModestMailOperation* modest_mail_operation_new (GObject *source);
287 * modest_mail_operation_new_with_error_handling:
288 * @id: a #ModestMailOperationId identification of operation type.
289 * @source: a #GObject which creates this new operation.
290 * @error_handler: a #ErrorCheckingUserCallback function to performs operations when
293 * Creates a new instance of class #ModestMailOperation, using parameters
294 * to initialize its private structure. @source parameter may be NULL.
295 * @error_handler can not be NULL, but it will be returned an mail operation
296 * object without error handling capability.
298 ModestMailOperation* modest_mail_operation_new_with_error_handling (GObject *source,
299 ErrorCheckingUserCallback error_handler,
301 ErrorCheckingUserDataDestroyer error_handler_destroyer);
303 * modest_mail_operation_execute_error_handler
304 * @self: a #ModestMailOperation
306 * Executes error handler if exists. The error handler is the one that
307 * MUST free the user data passed to the
308 * modest_mail_operation_new_with_error_handling constructor
311 modest_mail_operation_execute_error_handler (ModestMailOperation *self);
314 * modest_mail_operation_get_type_operation
315 * @self: a #ModestMailOperation
317 * Gets the private op_type field of mail operation. This op_type
318 * identifies the class/type of mail operation.
320 ModestMailOperationTypeOperation
321 modest_mail_operation_get_type_operation (ModestMailOperation *self);
324 * modest_mail_operation_is_mine
325 * @self: a #ModestMailOperation
326 * @source: a #GObject to check if it have created @self operation.
328 * Check if @source object its owner of @self mail operation.
330 * returns: TRUE if source its owner, FALSE otherwise.
333 modest_mail_operation_is_mine (ModestMailOperation *self,
337 * modest_mail_operation_get_source
338 * @self: a #ModestMailOperation
340 * returns a new reference to the object that created the mail
341 * operation passed to the constructor, or NULL if none. The caller
342 * must free the new reference
345 modest_mail_operation_get_source (ModestMailOperation *self);
347 /* fill in other public functions, eg.: */
350 * modest_mail_operation_send_mail:
351 * @self: a #ModestMailOperation
352 * @transport_account: a non-NULL #TnyTransportAccount
353 * @msg: a non-NULL #TnyMsg
355 * Sends and already existing message using the provided
356 * #TnyTransportAccount. This operation is synchronous, so the
357 * #ModestMailOperation should not be added to any
358 * #ModestMailOperationQueue
360 void modest_mail_operation_send_mail (ModestMailOperation *self,
361 TnyTransportAccount *transport_account,
365 * modest_mail_operation_send_new_mail:
366 * @self: a #ModestMailOperation
367 * @transport_account: a non-NULL #TnyTransportAccount
368 * @draft_msg: a #TnyMsg of the origin draft message, if any
369 * @from: the email address of the mail sender
370 * @to: a non-NULL email address of the mail receiver
371 * @cc: a comma-separated list of email addresses where to send a carbon copy
372 * @bcc: a comma-separated list of email addresses where to send a blind carbon copy
373 * @subject: the subject of the new mail
374 * @plain_body: the plain text body of the new mail.
375 * @html_body: the html version of the body of the new mail. If NULL, the mail will
376 * be sent with the plain body only.
377 * @attachments_list: a #GList of attachments, each attachment must be a #TnyMimePart
378 * @images_list: a #GList of image attachments, each attachment must be a #TnyMimePart
380 * Sends a new mail message using the provided
381 * #TnyTransportAccount. This operation is synchronous, so the
382 * #ModestMailOperation should not be added to any
383 * #ModestMailOperationQueue
385 void modest_mail_operation_send_new_mail (ModestMailOperation *self,
386 TnyTransportAccount *transport_account,
392 const gchar *subject,
393 const gchar *plain_body,
394 const gchar *html_body,
395 const GList *attachments_list,
396 const GList *images_list,
397 const gchar *references,
398 const gchar *in_reply_to,
399 TnyHeaderFlags priority_flags);
403 * modest_mail_operation_save_to_drafts:
404 * @self: a #ModestMailOperation
405 * @transport_account: a non-NULL #TnyTransportAccount
406 * @draft_msg: the previous draft message, in case it's an update
407 * to an existing draft.
408 * @from: the email address of the mail sender
409 * @to: a non-NULL email address of the mail receiver
410 * @cc: a comma-separated list of email addresses where to send a carbon copy
411 * @bcc: a comma-separated list of email addresses where to send a blind carbon copy
412 * @subject: the subject of the new mail
413 * @plain_body: the plain text body of the new mail.
414 * @html_body: the html version of the body of the new mail. If NULL, the mail will
415 * be sent with the plain body only.
416 * @attachments_list: a #GList of attachments, each attachment must be a #TnyMimePart
417 * @images_list: a #GList of image attachments, each attachment must be a #TnyMimePart
418 * @callback: the user callback, will be called when the operation finishes
419 * @user_data: data that will be passed to the user callback
421 * Save a mail message to drafts using the provided
422 * #TnyTransportAccount. This operation is asynchronous.
425 void modest_mail_operation_save_to_drafts (ModestMailOperation *self,
426 TnyTransportAccount *transport_account,
432 const gchar *subject,
433 const gchar *plain_body,
434 const gchar *html_body,
435 const GList *attachments_list,
436 const GList *images_list,
437 TnyHeaderFlags priority_flags,
438 const gchar *references,
439 const gchar *in_reply_to,
440 SaveToDraftstCallback callback,
443 * modest_mail_operation_update_account:
444 * @self: a #ModestMailOperation
445 * @account_name: the id of a Modest account
446 * @poke_all: if TRUE it will also do a poke_status over all folders of the account
447 * @interactive: if TRUE the update account was scheduled by an interactive send receive
449 * Asynchronously refreshes the root folders of the given store
450 * account. The caller should add the #ModestMailOperation to a
451 * #ModestMailOperationQueue and then free it. The caller will be
452 * notified by the "progress_changed" signal each time the progress of
453 * the operation changes.
456 * <informalexample><programlisting>
457 * queue = modest_tny_platform_factory_get_modest_mail_operation_queue_instance (fact)
458 * mail_op = modest_mail_operation_new ();
459 * g_signal_connect (G_OBJECT (mail_op), "progress_changed", G_CALLBACK(on_progress_changed), NULL);
460 * modest_mail_operation_queue_add (queue, mail_op);
461 * modest_mail_operation_update_account (mail_op, account_name)
462 * g_object_unref (G_OBJECT (mail_op));
463 * </programlisting></informalexample>
465 * Note that the account_name *MUST* be a modest account name, not a
466 * tinymail store account name
469 void modest_mail_operation_update_account (ModestMailOperation *self,
470 const gchar *account_name,
472 gboolean interactive,
473 UpdateAccountCallback callback,
476 /* Functions that perform store operations */
479 * modest_mail_operation_create_folder:
480 * @self: a #ModestMailOperation
481 * @parent: the #TnyFolderStore which is the parent of the new folder
482 * @name: the non-NULL new name for the new folder
484 * Creates a new folder as a children of a existing one. If the store
485 * account supports subscriptions this method also sets the new folder
486 * as subscribed. This operation is synchronous, so the
487 * #ModestMailOperation should not be added to any
488 * #ModestMailOperationQueue
490 * Returns: a newly created #TnyFolder or NULL in case of error.
492 void modest_mail_operation_create_folder (ModestMailOperation *self,
493 TnyFolderStore *parent,
495 CreateFolderUserCallback callback,
499 * modest_mail_operation_remove_folder:
500 * @self: a #ModestMailOperation
501 * @folder: a #TnyFolder
502 * @remove_to_trash: TRUE to move it to trash or FALSE to delete
505 * Removes a folder. This operation is synchronous, so the
506 * #ModestMailOperation should not be added to any
507 * #ModestMailOperationQueue
509 void modest_mail_operation_remove_folder (ModestMailOperation *self,
511 gboolean remove_to_trash);
514 * modest_mail_operation_rename_folder:
515 * @self: a #ModestMailOperation
516 * @folder: a #TnyFolder
517 * @name: a non-NULL name without "/"
519 * Renames a given folder with the provided new name. This operation
520 * is synchronous, so the #ModestMailOperation should not be added to
521 * any #ModestMailOperationQueue
523 void modest_mail_operation_rename_folder (ModestMailOperation *self,
526 XferFolderAsyncUserCallback user_callback,
530 * modest_mail_operation_xfer_folder:
531 * @self: a #ModestMailOperation
532 * @folder: a #TnyFolder
533 * @parent: the new parent of the folder as #TnyFolderStore
534 * @delete_original: wheter or not delete the original folder
535 * @user_callback: a #XferFolderAsyncUserCallback function to call after tinymail callback execution.
536 * @user_data: generic user data which will be passed to @user_callback function.
538 * Sets the given @folder as child of a provided #TnyFolderStore. This
539 * operation also transfers all the messages contained in the folder
540 * and all of his children folders with their messages as well. This
541 * operation is synchronous, so the #ModestMailOperation should not be
542 * added to any #ModestMailOperationQueue.
544 * If @delete_original is TRUE this function moves the original
545 * folder, if it is FALSE the it just copies it
548 void modest_mail_operation_xfer_folder (ModestMailOperation *self,
550 TnyFolderStore *parent,
551 gboolean delete_original,
552 XferFolderAsyncUserCallback user_callback,
556 /* Functions that performs msg operations */
559 * modest_mail_operation_xfer_msgs:
560 * @self: a #ModestMailOperation
561 * @header_list: a #TnyList of #TnyHeader to transfer
562 * @folder: the #TnyFolder where the messages will be transferred
563 * @delete_original: whether or not delete the source messages
564 * @user_callback: a #XferFolderAsyncUserCallback function to call after tinymail callback execution.
565 * @user_data: generic user data which will be passed to @user_callback function.
567 * Asynchronously transfers messages from their current folder to
568 * another one. The caller should add the #ModestMailOperation to a
569 * #ModestMailOperationQueue and then free it. The caller will be
570 * notified by the "progress_changed" when the operation is completed.
572 * If the @delete_original paramter is TRUE then this function moves
573 * the messages between folders, otherwise it copies them.
576 * <informalexample><programlisting>
577 * queue = modest_tny_platform_factory_get_modest_mail_operation_queue_instance (fact);
578 * mail_op = modest_mail_operation_new ();
579 * modest_mail_operation_queue_add (queue, mail_op);
580 * g_signal_connect (G_OBJECT (mail_op), "progress_changed", G_CALLBACK(on_progress_changed), queue);
582 * modest_mail_operation_xfer_msg (mail_op, headers, folder, TRUE);
584 * g_object_unref (G_OBJECT (mail_op));
585 * </programlisting></informalexample>
588 void modest_mail_operation_xfer_msgs (ModestMailOperation *self,
589 TnyList *header_list,
591 gboolean delete_original,
592 XferMsgsAsyncUserCallback user_callback,
596 * modest_mail_operation_remove_msgs:
597 * @self: a #ModestMailOperation
598 * @headers: the #TnyList of the messages to delete
599 * @remove_to_trash: TRUE to move it to trash or FALSE to delete it
602 * Deletes a list of messages.
604 void modest_mail_operation_remove_msgs (ModestMailOperation *self,
606 gboolean remove_to_trash);
609 * modest_mail_operation_get_msg_and_parts:
610 * @self: a #ModestMailOperation
611 * @header_list: the #TnyHeader of the message to get
612 * @progress_feedback: a #gboolean. If %TRUE, we'll get progress bar feedback.
613 * @user_callback: a #GetMsgAsyncUserCallback function to call after tinymail callback execution.
614 * @user_data: generic user data which will be passed to @user_callback function.
616 * Gets a message from header using an user defined @callback function
617 * pased as argument. This operation is asynchronous, so the
618 * #ModestMailOperation should be added to #ModestMailOperationQueue
620 * This operation also retrieves to cache all parts of the message. This is needed for
623 void modest_mail_operation_get_msg_and_parts (ModestMailOperation *self,
626 gboolean progress_feedback,
627 GetMsgAsyncUserCallback user_callback,
630 * modest_mail_operation_get_msg:
631 * @self: a #ModestMailOperation
632 * @header_list: the #TnyHeader of the message to get
633 * @progress_feedback: a #gboolean. If %TRUE, we'll get progress bar feedback.
634 * @user_callback: a #GetMsgAsyncUserCallback function to call after tinymail callback execution.
635 * @user_data: generic user data which will be passed to @user_callback function.
637 * Gets a message from header using an user defined @callback function
638 * pased as argument. This operation is asynchronous, so the
639 * #ModestMailOperation should be added to #ModestMailOperationQueue
641 void modest_mail_operation_get_msg (ModestMailOperation *self,
643 gboolean progress_feedback,
644 GetMsgAsyncUserCallback user_callback,
647 * modest_mail_operation_find_msg:
648 * @self: a #ModestMailOperation
650 * @progress_feedback: a #gboolean. If %TRUE, we'll get progress bar feedback.
651 * @user_callback: a #GetMsgAsyncUserCallback function to call after tinymail callback execution.
652 * @user_data: generic user data which will be passed to @user_callback function.
654 * Gets a message from a uid using an user defined @callback function
655 * pased as argument. This operation is asynchronous, so the
656 * #ModestMailOperation should be added to #ModestMailOperationQueue
658 void modest_mail_operation_find_msg (ModestMailOperation *self,
660 const gchar *msg_uid,
661 gboolean progress_feedback,
662 GetMsgAsyncUserCallback user_callback,
666 * modest_mail_operation_get_msgs_full:
667 * @self: a #ModestMailOperation
668 * @header_list: a #TnyList of #TnyHeader objects to get and process
669 * @user_callback: a #TnyGetMsgCallback function to call after tinymail operation execution.
670 * @user_data: user data passed to both, user_callback and update_status_callback.
672 * Gets messages from headers list and process hem using @callback function
673 * pased as argument. This operation is asynchronous, so the
674 * #ModestMailOperation should be added to #ModestMailOperationQueue
676 void modest_mail_operation_get_msgs_full (ModestMailOperation *self,
677 TnyList *headers_list,
678 GetMsgAsyncUserCallback user_callback,
680 GDestroyNotify notify);
683 * modest_mail_operation_run_queue:
684 * @self: a #ModestMailOperation
685 * @queue: a #ModestTnySendQueue
687 * This mail operation is special. It should be running every time the send queue
688 * is running (after queue-start), and we should notify end of the operation
689 * after queue-end. Then, we should only set this queue on queue-start signal, and
690 * it will clean up the operation (notify end) on queue-end.
692 void modest_mail_operation_run_queue (ModestMailOperation *self,
693 ModestTnySendQueue *queue);
696 * modest_mail_operation_queue_wakeup:
697 * @self: a #ModestMailOperation
698 * @queue: a #ModestTnySendQueue
700 * This mail operation is special. It should be running every time the send queue
701 * wakeup is running and we should notify end of the operation
702 * after wakeup has done msg-sent notification.
704 void modest_mail_operation_queue_wakeup (ModestMailOperation *self,
705 ModestTnySendQueue *queue);
708 * modest_mail_operation_sync_folder:
709 * @self: a #ModestMailOperation
710 * @folder: a #TnyFolder
711 * @expunge: a #gboolean
713 * mail operation wrapper around tny_folder_sync () method, to keep modest
714 * running while we do that sync operation.
716 void modest_mail_operation_sync_folder (ModestMailOperation *self,
719 SyncFolderCallback callback,
723 * modest_mail_operation_shutdown:
724 * @self: a #ModestMailOperation
725 * @account_store: a #ModestTnyAccountStore
727 * disconnects all accounts in the account store (doing the proper syncs).
729 void modest_mail_operation_shutdown (ModestMailOperation *self,
730 ModestTnyAccountStore *account_store);
732 /* Functions to control mail operations */
734 * modest_mail_operation_get_task_done:
735 * @self: a #ModestMailOperation
737 * Gets the amount of work done for a given mail operation. This
738 * amount of work is an absolute value.
740 * Returns: the amount of work completed
742 guint modest_mail_operation_get_task_done (ModestMailOperation *self);
745 * modest_mail_operation_get_task_total:
746 * @self: a #ModestMailOperation
748 * Gets the total amount of work that must be done to complete a given
749 * mail operation. This amount of work is an absolute value.
751 * Returns: the total required amount of work
753 guint modest_mail_operation_get_task_total (ModestMailOperation *self);
757 * modest_mail_operation_is_finished:
758 * @self: a #ModestMailOperation
760 * Checks if the operation is finished. A #ModestMailOperation is
761 * finished if it's in any of the following states:
762 * MODEST_MAIL_OPERATION_STATUS_SUCCESS,
763 * MODEST_MAIL_OPERATION_STATUS_FAILED,
764 * MODEST_MAIL_OPERATION_STATUS_CANCELED or
765 * MODEST_MAIL_OPERATION_STATUS_FINISHED_WITH_ERRORS
767 * Returns: TRUE if the operation is finished, FALSE otherwise
769 gboolean modest_mail_operation_is_finished (ModestMailOperation *self);
772 * modest_mail_operation_is_finished:
773 * @self: a #ModestMailOperation
775 * Gets the current status of the given mail operation
777 * Returns: the current status or MODEST_MAIL_OPERATION_STATUS_INVALID in case of error
779 ModestMailOperationStatus modest_mail_operation_get_status (ModestMailOperation *self);
782 * modest_mail_operation_get_error:
783 * @self: a #ModestMailOperation
785 * Gets the error associated to the mail operation if exists
787 * Returns: the #GError associated to the #ModestMailOperation if it
788 * exists or NULL otherwise
790 const GError* modest_mail_operation_get_error (ModestMailOperation *self);
793 * modest_mail_operation_cancel:
794 * @self: a #ModestMailOperation
796 * Cancels an active mail operation
798 * Returns: TRUE if the operation was succesfully canceled, FALSE otherwise
800 gboolean modest_mail_operation_cancel (ModestMailOperation *self);
803 * modest_mail_operation_refresh_folder
804 * @self: a #ModestMailOperation
805 * @folder: the #TnyFolder to refresh
806 * @user_callback: the #RefreshAsyncUserCallback function to be called
807 * after internal refresh async callback was being executed.
809 * Refreshes the contents of a folder. After internal callback was executed,
810 * and all interna mail operation field were filled, if exists, it calls an
811 * user callback function to make UI operations which must be done after folder
814 void modest_mail_operation_refresh_folder (ModestMailOperation *self,
816 RefreshAsyncUserCallback user_callback,
820 * modest_mail_operation_get_account:
821 * @self: a #ModestMailOperation
823 * Gets the account associated to a mail operation
825 * Returns: the #TnyAccount associated to the #ModestMailOperation
827 TnyAccount *modest_mail_operation_get_account (ModestMailOperation *self);
831 * modest_mail_operation_noop:
832 * @self: a #ModestMailOperation
834 * Does nothing except emitting operation-started and
837 void modest_mail_operation_noop (ModestMailOperation *self);
841 * modest_mail_operation_to_string:
842 * @self: a #ModestMailOperation
844 * get a string representation of the mail operation (for debugging)
846 * Returns: a newly allocated string
848 gchar* modest_mail_operation_to_string (ModestMailOperation *self);
853 #endif /* __MODEST_MAIL_OPERATION_H__ */