* Fixes NB#91689. fixes a wrong check for ASCII
[modest] / src / modest-mail-operation.h
1 /* Copyright (c) 2006, Nokia Corporation
2  * All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *
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.
16  *
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.
28  */
29
30 #ifndef __MODEST_MAIL_OPERATION_H__
31 #define __MODEST_MAIL_OPERATION_H__
32
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>
38
39 G_BEGIN_DECLS
40
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))
48
49 typedef struct _ModestMailOperation      ModestMailOperation;
50 typedef struct _ModestMailOperationClass ModestMailOperationClass;
51
52 /**
53  * ModestMailOperationStatus:
54  *
55  * The state of a mail operation
56  */
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;
65
66 /**
67  * ModestMailOperationId:
68  *
69  * The id for identifying the type of mail operation
70  */
71 typedef enum {
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_UNKNOWN,
82 } ModestMailOperationTypeOperation;
83
84 /**
85  * ErrorCheckingUserCallback:
86  *
87  * @mail_op: the current mail operation.
88  * @user_data: generic data passed to user defined function.
89  *
90  * This function implements required actions to performs under error
91  * states.  
92  */
93 typedef void (*ErrorCheckingUserCallback) (ModestMailOperation *mail_op, gpointer user_data);
94
95 /**
96  * ErrorCheckingUserDataDestroyer:
97  *
98  * @user_data: generic data passed to user defined function.
99  *
100  * This function is used to destroy the user_data passed to the error
101  * checking user callback function
102  */
103 typedef void (*ErrorCheckingUserDataDestroyer) (gpointer user_data);
104
105
106 /**
107  * GetMsgAsyncUserCallback:
108  *
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.
113  *
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.
117  */
118 typedef void (*GetMsgAsyncUserCallback) (ModestMailOperation *mail_op, 
119                                          TnyHeader *header, 
120                                          gboolean canceled, 
121                                          TnyMsg *msg, 
122                                          GError *err,
123                                          gpointer user_data);
124
125 /**
126  * GetMimePartSizeCallback:
127  *
128  * @mail_op: the current #ModestMailOperation.
129  * @size: size of the attachment
130  * @user_data: generic data passed to user defined function.
131  *
132  */
133 typedef void (*GetMimePartSizeCallback) (ModestMailOperation *mail_op, 
134                                          gssize size,
135                                          gpointer user_data);
136
137 /**
138  * XferMsgsAsyncUserCallback:
139  *
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.
143  *
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.
147  */
148 typedef void (*XferMsgsAsyncUserCallback) (ModestMailOperation *mail_op, 
149                                            gpointer user_data);
150
151
152 /**
153  * XferFolderAsyncUserCallback:
154  *
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.
158  *
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.
162  */
163 typedef void (*XferFolderAsyncUserCallback) (ModestMailOperation *mail_op, 
164                                              TnyFolder *new_folder,
165                                              gpointer user_data);
166
167
168 /**
169  * RefreshAsyncUserCallback:
170  *
171  * @mail_op: the current #ModestMailOperation.
172  * @folder: a #TnyFolder which has been refreshed .
173  * @user_data: generic data passed to user defined function.
174  *
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.
178  */
179 typedef void (*RefreshAsyncUserCallback) (ModestMailOperation *mail_op, 
180                                           TnyFolder *folder, 
181                                           gpointer user_data);
182
183 /**
184  * UpdateAccountCallback:
185  *
186  * @self: a #ModestMailOperation
187  * @new_headers: the list of new headers received
188  * @user_data: generic data passed to user defined function.
189  *
190  * This is the callback of the update_account operation. It informs
191  * the caller about the amount of new messages that have been
192  * downloaded
193  */
194 typedef void (*UpdateAccountCallback) (ModestMailOperation *self, 
195                                        TnyList *new_headers,
196                                        gpointer user_data);
197
198 /**
199  * SaveToDraftsCallback:
200  *
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.
204  *
205  * This is the callback of the save_to_drafts operation. It returns
206  * the newly created msg stored in the Drafts folder
207  */
208 typedef void (*SaveToDraftstCallback) (ModestMailOperation *self, 
209                                        TnyMsg *saved_draft,
210                                        gpointer user_data);
211
212
213 typedef gboolean (*RetrieveAllCallback) (GObject *source,
214                                          guint num_msgs,
215                                          guint limit);
216
217 /**
218  * CreateFolderUserCallback:
219  *
220  * @mail_op: the current #ModestMailOperation.
221  * @folder: a #TnyFolder summary item.
222  * @user_data: generic data passed to user defined function.
223  *
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.
227  */
228 typedef void (*CreateFolderUserCallback) (ModestMailOperation *mail_op, 
229                                           TnyFolderStore *parent_folder,
230                                           TnyFolder *new_folder, 
231                                           gpointer user_data);
232
233 /* This struct represents the internal state of a mail operation in a
234    given time */
235 typedef struct {
236         guint      done;
237         guint      total;
238         gdouble    bytes_done;
239         gdouble    bytes_total;
240         gboolean   finished;
241         ModestMailOperationStatus        status;
242         ModestMailOperationTypeOperation op_type;
243 } ModestMailOperationState;
244
245
246 struct _ModestMailOperation {
247          GObject parent;
248         /* insert public members, if any */
249 };
250
251 struct _ModestMailOperationClass {
252         GObjectClass parent_class;
253
254         /* Signals */
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);
258 };
259
260 /* member functions */
261 GType        modest_mail_operation_get_type    (void) G_GNUC_CONST;
262
263 /**
264  * modest_mail_operation_new:
265  * @source: a #GObject which creates this new operation.
266  * 
267  * Creates a new instance of class #ModestMailOperation, using parameters
268  * to initialize its private structure. @source parameter may be NULL.
269  **/
270 ModestMailOperation*    modest_mail_operation_new     (GObject *source);
271
272 /**
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 
277  * an error occurs.
278  * 
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.
283  **/
284 ModestMailOperation*    modest_mail_operation_new_with_error_handling     (GObject *source,
285                                                                            ErrorCheckingUserCallback error_handler,
286                                                                            gpointer user_data,
287                                                                            ErrorCheckingUserDataDestroyer error_handler_destroyer);
288 /**
289  * modest_mail_operation_execute_error_handler
290  * @self: a #ModestMailOperation
291  * 
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
295  **/
296 void
297 modest_mail_operation_execute_error_handler (ModestMailOperation *self);
298
299 /**
300  * modest_mail_operation_get_type_operation
301  * @self: a #ModestMailOperation
302  * 
303  * Gets the private op_type field of mail operation. This op_type
304  * identifies the class/type of mail operation.
305  **/
306 ModestMailOperationTypeOperation
307 modest_mail_operation_get_type_operation (ModestMailOperation *self);
308
309 /**
310  * modest_mail_operation_is_mine
311  * @self: a #ModestMailOperation
312  * @source: a #GObject to check if it have created @self operation.
313  * 
314  * Check if @source object its owner of @self mail operation.
315  *
316  * returns: TRUE if source its owner, FALSE otherwise.
317  **/
318 gboolean 
319 modest_mail_operation_is_mine (ModestMailOperation *self, 
320                                GObject *me);
321
322 /**
323  * modest_mail_operation_get_source
324  * @self: a #ModestMailOperation
325  *
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
329  **/
330 GObject *
331 modest_mail_operation_get_source (ModestMailOperation *self);
332
333 /* fill in other public functions, eg.: */
334
335 /**
336  * modest_mail_operation_send_mail:
337  * @self: a #ModestMailOperation
338  * @transport_account: a non-NULL #TnyTransportAccount
339  * @msg: a non-NULL #TnyMsg
340  * 
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
345   **/
346 void    modest_mail_operation_send_mail       (ModestMailOperation *self,
347                                                TnyTransportAccount *transport_account,
348                                                TnyMsg* msg);
349
350 /**
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
365  * 
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
370   **/
371 void    modest_mail_operation_send_new_mail   (ModestMailOperation *self,
372                                                TnyTransportAccount *transport_account,
373                                                TnyMsg *draft_msg,
374                                                const gchar *from,
375                                                const gchar *to,
376                                                const gchar *cc,
377                                                const gchar *bcc,
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                                                TnyHeaderFlags priority_flags);
384
385
386 /**
387  * modest_mail_operation_save_to_drafts:
388  * @self: a #ModestMailOperation
389  * @transport_account: a non-NULL #TnyTransportAccount
390  * @draft_msg: the previous draft message, in case it's an update
391  * to an existing draft.
392  * @from: the email address of the mail sender
393  * @to: a non-NULL email address of the mail receiver
394  * @cc: a comma-separated list of email addresses where to send a carbon copy
395  * @bcc: a comma-separated list of email addresses where to send a blind carbon copy
396  * @subject: the subject of the new mail
397  * @plain_body: the plain text body of the new mail.
398  * @html_body: the html version of the body of the new mail. If NULL, the mail will
399  *             be sent with the plain body only.
400  * @attachments_list: a #GList of attachments, each attachment must be a #TnyMimePart
401  * @images_list: a #GList of image attachments, each attachment must be a #TnyMimePart
402  * @callback: the user callback, will be called when the operation finishes
403  * @user_data: data that will be passed to the user callback
404  *
405  * Save a mail message to drafts using the provided
406  * #TnyTransportAccount. This operation is asynchronous.
407  *
408   **/
409 void modest_mail_operation_save_to_drafts   (ModestMailOperation *self,
410                                              TnyTransportAccount *transport_account,
411                                              TnyMsg *draft_msg,
412                                              const gchar *from,
413                                              const gchar *to,
414                                              const gchar *cc,
415                                              const gchar *bcc,
416                                              const gchar *subject,
417                                              const gchar *plain_body,
418                                              const gchar *html_body,
419                                              const GList *attachments_list,
420                                              const GList *images_list,
421                                              TnyHeaderFlags priority_flags,
422                                              SaveToDraftstCallback callback,
423                                              gpointer user_data);
424 /**
425  * modest_mail_operation_update_account:
426  * @self: a #ModestMailOperation
427  * @account_name: the id of a Modest account
428  * @poke_all: if TRUE it will also do a poke_status over all folders of the account
429  * @interactive: if TRUE the update account was scheduled by an interactive send receive
430  * 
431  * Asynchronously refreshes the root folders of the given store
432  * account. The caller should add the #ModestMailOperation to a
433  * #ModestMailOperationQueue and then free it. The caller will be
434  * notified by the "progress_changed" signal each time the progress of
435  * the operation changes.
436  *
437  * Example
438  * <informalexample><programlisting>
439  * queue = modest_tny_platform_factory_get_modest_mail_operation_queue_instance (fact)
440  * mail_op = modest_mail_operation_new ();
441  * g_signal_connect (G_OBJECT (mail_op), "progress_changed", G_CALLBACK(on_progress_changed), NULL);
442  * modest_mail_operation_queue_add (queue, mail_op);
443  * modest_mail_operation_update_account (mail_op, account_name)
444  * g_object_unref (G_OBJECT (mail_op));
445  * </programlisting></informalexample>
446  *
447  * Note that the account_name *MUST* be a modest account name, not a
448  * tinymail store account name
449  * 
450  **/
451 void          modest_mail_operation_update_account (ModestMailOperation *self,
452                                                     const gchar *account_name,
453                                                     gboolean poke_all,
454                                                     gboolean interactive,
455                                                     RetrieveAllCallback retrieve_all_cb,
456                                                     UpdateAccountCallback callback,
457                                                     gpointer user_data);
458
459 /* Functions that perform store operations */
460
461 /**
462  * modest_mail_operation_create_folder:
463  * @self: a #ModestMailOperation
464  * @parent: the #TnyFolderStore which is the parent of the new folder
465  * @name: the non-NULL new name for the new folder
466  * 
467  * Creates a new folder as a children of a existing one. If the store
468  * account supports subscriptions this method also sets the new folder
469  * as subscribed. This operation is synchronous, so the
470  * #ModestMailOperation should not be added to any
471  * #ModestMailOperationQueue
472  * 
473  * Returns: a newly created #TnyFolder or NULL in case of error.
474  **/
475 void    modest_mail_operation_create_folder  (ModestMailOperation *self,
476                                               TnyFolderStore *parent,
477                                               const gchar *name,
478                                               CreateFolderUserCallback callback,
479                                               gpointer user_data);
480
481 /**
482  * modest_mail_operation_remove_folder:
483  * @self: a #ModestMailOperation
484  * @folder: a #TnyFolder
485  * @remove_to_trash: TRUE to move it to trash or FALSE to delete
486  * permanently
487  * 
488  * Removes a folder. This operation is synchronous, so the
489  * #ModestMailOperation should not be added to any
490  * #ModestMailOperationQueue
491  **/
492 void          modest_mail_operation_remove_folder  (ModestMailOperation *self,
493                                                     TnyFolder *folder,
494                                                     gboolean remove_to_trash);
495
496 /**
497  * modest_mail_operation_rename_folder:
498  * @self: a #ModestMailOperation
499  * @folder: a #TnyFolder
500  * @name: a non-NULL name without "/"
501  * 
502  * Renames a given folder with the provided new name. This operation
503  * is synchronous, so the #ModestMailOperation should not be added to
504  * any #ModestMailOperationQueue
505  **/
506 void          modest_mail_operation_rename_folder  (ModestMailOperation *self,
507                                                     TnyFolder *folder, 
508                                                     const gchar *name,
509                                                     XferFolderAsyncUserCallback user_callback,
510                                                     gpointer user_data);
511
512 /**
513  * modest_mail_operation_xfer_folder:
514  * @self: a #ModestMailOperation
515  * @folder: a #TnyFolder
516  * @parent: the new parent of the folder as #TnyFolderStore
517  * @delete_original: wheter or not delete the original folder
518  * @user_callback: a #XferFolderAsyncUserCallback function to call after tinymail callback execution.
519  * @user_data: generic user data which will be passed to @user_callback function.
520  * 
521  * Sets the given @folder as child of a provided #TnyFolderStore. This
522  * operation also transfers all the messages contained in the folder
523  * and all of his children folders with their messages as well. This
524  * operation is synchronous, so the #ModestMailOperation should not be
525  * added to any #ModestMailOperationQueue.
526  *
527  * If @delete_original is TRUE this function moves the original
528  * folder, if it is FALSE the it just copies it
529  *
530  **/
531 void          modest_mail_operation_xfer_folder    (ModestMailOperation *self,
532                                                     TnyFolder *folder,
533                                                     TnyFolderStore *parent,
534                                                     gboolean delete_original,
535                                                     XferFolderAsyncUserCallback user_callback,
536                                                     gpointer user_data);
537                                                     
538
539 /* Functions that performs msg operations */
540
541 /**
542  * modest_mail_operation_xfer_msgs:
543  * @self: a #ModestMailOperation
544  * @header_list: a #TnyList of #TnyHeader to transfer
545  * @folder: the #TnyFolder where the messages will be transferred
546  * @delete_original: whether or not delete the source messages
547  * @user_callback: a #XferFolderAsyncUserCallback function to call after tinymail callback execution.
548  * @user_data: generic user data which will be passed to @user_callback function.
549  * 
550  * Asynchronously transfers messages from their current folder to
551  * another one. The caller should add the #ModestMailOperation to a
552  * #ModestMailOperationQueue and then free it. The caller will be
553  * notified by the "progress_changed" when the operation is completed.
554  *
555  * If the @delete_original paramter is TRUE then this function moves
556  * the messages between folders, otherwise it copies them.
557  * 
558  * Example
559  * <informalexample><programlisting>
560  * queue = modest_tny_platform_factory_get_modest_mail_operation_queue_instance (fact);
561  * mail_op = modest_mail_operation_new ();
562  * modest_mail_operation_queue_add (queue, mail_op);
563  * g_signal_connect (G_OBJECT (mail_op), "progress_changed", G_CALLBACK(on_progress_changed), queue);
564  *
565  * modest_mail_operation_xfer_msg (mail_op, headers, folder, TRUE);
566  * 
567  * g_object_unref (G_OBJECT (mail_op));
568  * </programlisting></informalexample>
569  *
570  **/
571 void          modest_mail_operation_xfer_msgs      (ModestMailOperation *self,
572                                                     TnyList *header_list, 
573                                                     TnyFolder *folder,
574                                                     gboolean delete_original,
575                                                     XferMsgsAsyncUserCallback user_callback,
576                                                     gpointer user_data);
577
578 /**
579  * modest_mail_operation_remove_msg:
580  * @self: a #ModestMailOperation
581  * @headers: the #TnyList of the messages to delete
582  * @remove_to_trash: TRUE to move it to trash or FALSE to delete it
583  * permanently
584  * 
585  * Deletes a list of messages.
586  **/
587 void          modest_mail_operation_remove_msgs     (ModestMailOperation *self,
588                                                      TnyList *headers,
589                                                      gboolean remove_to_trash);
590
591 /**
592  * modest_mail_operation_get_msg:
593  * @self: a #ModestMailOperation
594  * @header_list: the #TnyHeader of the message to get
595  * @progress_feedback: a #gboolean. If %TRUE, we'll get progress bar feedback.
596  * @user_callback: a #GetMsgAsyncUserCallback function to call after tinymail callback execution.
597  * @user_data: generic user data which will be passed to @user_callback function.
598  * 
599  * Gets a message from header using an user defined @callback function
600  * pased as argument. This operation is asynchronous, so the
601  * #ModestMailOperation should be added to #ModestMailOperationQueue
602  **/
603 void          modest_mail_operation_get_msg     (ModestMailOperation *self,
604                                                  TnyHeader *header,
605                                                  gboolean progress_feedback,
606                                                  GetMsgAsyncUserCallback user_callback,
607                                                  gpointer user_data);
608 /**
609  * modest_mail_operation_get_msgs_full:
610  * @self: a #ModestMailOperation
611  * @header_list: a #TnyList of #TnyHeader objects to get and process
612  * @user_callback: a #TnyGetMsgCallback function to call after tinymail operation execution.
613  * @user_data: user data passed to both, user_callback and update_status_callback.
614  * 
615  * Gets messages from headers list and process hem using @callback function
616  * pased as argument. This operation is asynchronous, so the
617  * #ModestMailOperation should be added to #ModestMailOperationQueue
618  **/
619 void          modest_mail_operation_get_msgs_full   (ModestMailOperation *self,
620                                                      TnyList *headers_list,
621                                                      GetMsgAsyncUserCallback user_callback,
622                                                      gpointer user_data,
623                                                      GDestroyNotify notify);
624
625 /**
626  * modest_mail_operation_run_queue:
627  * @self: a #ModestMailOperation
628  * @queue: a #ModestTnySendQueue
629  *
630  * This mail operation is special. It should be running every time the send queue
631  * is running (after queue-start), and we should notify end of the operation
632  * after queue-end. Then, we should only set this queue on queue-start signal, and
633  * it will clean up the operation (notify end) on queue-end.
634  */
635 void          modest_mail_operation_run_queue       (ModestMailOperation *self,
636                                                      ModestTnySendQueue *queue);
637
638 /**
639  * modest_mail_operation_sync_folder:
640  * @self: a #ModestMailOperation
641  * @folder: a #TnyFolder
642  * @expunge: a #gboolean
643  *
644  * mail operation wrapper around tny_folder_sync () method, to keep modest
645  * running while we do that sync operation.
646  */
647 void          modest_mail_operation_sync_folder     (ModestMailOperation *self,
648                                                      TnyFolder *folder, gboolean expunge);
649
650 /**
651  * modest_mail_operation_shutdown:
652  * @self: a #ModestMailOperation
653  * @account_store: a #ModestTnyAccountStore
654  *
655  * disconnects all accounts in the account store (doing the proper syncs).
656  */
657 void          modest_mail_operation_shutdown        (ModestMailOperation *self,
658                                                      ModestTnyAccountStore *account_store);
659
660 /* Functions to control mail operations */
661 /**
662  * modest_mail_operation_get_task_done:
663  * @self: a #ModestMailOperation
664  * 
665  * Gets the amount of work done for a given mail operation. This
666  * amount of work is an absolute value.
667  * 
668  * Returns: the amount of work completed
669  **/
670 guint     modest_mail_operation_get_task_done      (ModestMailOperation *self);
671
672 /**
673  * modest_mail_operation_get_task_total:
674  * @self: a #ModestMailOperation
675  * 
676  * Gets the total amount of work that must be done to complete a given
677  * mail operation. This amount of work is an absolute value.
678  * 
679  * Returns: the total required amount of work
680  **/
681 guint     modest_mail_operation_get_task_total     (ModestMailOperation *self);
682
683
684 /**
685  * modest_mail_operation_is_finished:
686  * @self: a #ModestMailOperation
687  * 
688  * Checks if the operation is finished. A #ModestMailOperation is
689  * finished if it's in any of the following states:
690  * MODEST_MAIL_OPERATION_STATUS_SUCCESS,
691  * MODEST_MAIL_OPERATION_STATUS_FAILED,
692  * MODEST_MAIL_OPERATION_STATUS_CANCELED or
693  * MODEST_MAIL_OPERATION_STATUS_FINISHED_WITH_ERRORS
694  * 
695  * Returns: TRUE if the operation is finished, FALSE otherwise
696  **/
697 gboolean  modest_mail_operation_is_finished        (ModestMailOperation *self);
698
699 /**
700  * modest_mail_operation_is_finished:
701  * @self: a #ModestMailOperation
702  * 
703  * Gets the current status of the given mail operation
704  *
705  * Returns: the current status or MODEST_MAIL_OPERATION_STATUS_INVALID in case of error
706  **/
707 ModestMailOperationStatus modest_mail_operation_get_status  (ModestMailOperation *self);
708
709 /**
710  * modest_mail_operation_get_error:
711  * @self: a #ModestMailOperation
712  * 
713  * Gets the error associated to the mail operation if exists
714  * 
715  * Returns: the #GError associated to the #ModestMailOperation if it
716  * exists or NULL otherwise
717  **/
718 const GError*             modest_mail_operation_get_error   (ModestMailOperation *self);
719
720 /**
721  * modest_mail_operation_cancel:
722  * @self: a #ModestMailOperation
723  *
724  * Cancels an active mail operation
725  * 
726  * Returns: TRUE if the operation was succesfully canceled, FALSE otherwise
727  **/
728 gboolean  modest_mail_operation_cancel          (ModestMailOperation *self);
729
730 /**
731  * modest_mail_operation_refresh_folder
732  * @self: a #ModestMailOperation
733  * @folder: the #TnyFolder to refresh
734  * @user_callback: the #RefreshAsyncUserCallback function to be called
735  * after internal refresh async callback was being executed.
736  * 
737  * Refreshes the contents of a folder. After internal callback was executed, 
738  * and all interna mail operation field were filled, if exists, it calls an 
739  * user callback function to make UI operations which must be done after folder
740  * was refreshed.
741  */
742 void      modest_mail_operation_refresh_folder  (ModestMailOperation *self,
743                                                  TnyFolder *folder,
744                                                  RefreshAsyncUserCallback user_callback,
745                                                  gpointer user_data);
746
747 /**
748  * modest_mail_operation_get_account:
749  * @self: a #ModestMailOperation
750  * 
751  * Gets the account associated to a mail operation
752  * 
753  * Returns: the #TnyAccount associated to the #ModestMailOperation
754  **/
755 TnyAccount *modest_mail_operation_get_account   (ModestMailOperation *self);
756
757
758 /**
759  * modest_mail_operation_noop:
760  * @self: a #ModestMailOperation
761  * 
762  * Does nothing except emitting operation-started and
763  * operation-finished
764  **/
765 void modest_mail_operation_noop (ModestMailOperation *self);
766
767
768 /**
769  * modest_mail_operation_to_string:
770  * @self: a #ModestMailOperation
771  * 
772  * get a string representation of the mail operation (for debugging)
773  *
774  * Returns: a newly allocated string
775  **/
776 gchar* modest_mail_operation_to_string (ModestMailOperation *self);
777
778
779 G_END_DECLS
780
781 #endif /* __MODEST_MAIL_OPERATION_H__ */
782