Do ignore empty recipients when checking names
[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 <modest-tny-send-queue.h>
36 #include <modest-tny-account-store.h>
37
38 G_BEGIN_DECLS
39
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))
47
48 typedef struct _ModestMailOperation      ModestMailOperation;
49 typedef struct _ModestMailOperationClass ModestMailOperationClass;
50
51 /**
52  * ModestMailOperationStatus:
53  *
54  * The state of a mail operation
55  */
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;
64
65 /**
66  * ModestMailOperationId:
67  *
68  * The id for identifying the type of mail operation
69  */
70 typedef enum {
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;
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 /**
234  * SyncFolderCallback:
235  *
236  * @self: a #ModestMailOperation
237  * @folder: the #TnyFolder to sync
238  * @user_data: generic data passed to user defined function.
239  *
240  * This is the callback of the sync_folder operation.
241  */
242 typedef void (*SyncFolderCallback) (ModestMailOperation *self,
243                                     TnyFolder *folder,
244                                     gpointer user_data);
245
246
247 /* This struct represents the internal state of a mail operation in a
248    given time */
249 typedef struct {
250         guint      done;
251         guint      total;
252         gdouble    bytes_done;
253         gdouble    bytes_total;
254         gboolean   finished;
255         ModestMailOperationStatus        status;
256         ModestMailOperationTypeOperation op_type;
257 } ModestMailOperationState;
258
259
260 struct _ModestMailOperation {
261          GObject parent;
262         /* insert public members, if any */
263 };
264
265 struct _ModestMailOperationClass {
266         GObjectClass parent_class;
267
268         /* Signals */
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);
272 };
273
274 /* member functions */
275 GType        modest_mail_operation_get_type    (void) G_GNUC_CONST;
276
277 /**
278  * modest_mail_operation_new:
279  * @source: a #GObject which creates this new operation.
280  * 
281  * Creates a new instance of class #ModestMailOperation, using parameters
282  * to initialize its private structure. @source parameter may be NULL.
283  **/
284 ModestMailOperation*    modest_mail_operation_new     (GObject *source);
285
286 /**
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 
291  * an error occurs.
292  * 
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.
297  **/
298 ModestMailOperation*    modest_mail_operation_new_with_error_handling     (GObject *source,
299                                                                            ErrorCheckingUserCallback error_handler,
300                                                                            gpointer user_data,
301                                                                            ErrorCheckingUserDataDestroyer error_handler_destroyer);
302 /**
303  * modest_mail_operation_execute_error_handler
304  * @self: a #ModestMailOperation
305  * 
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
309  **/
310 void
311 modest_mail_operation_execute_error_handler (ModestMailOperation *self);
312
313 /**
314  * modest_mail_operation_get_type_operation
315  * @self: a #ModestMailOperation
316  * 
317  * Gets the private op_type field of mail operation. This op_type
318  * identifies the class/type of mail operation.
319  **/
320 ModestMailOperationTypeOperation
321 modest_mail_operation_get_type_operation (ModestMailOperation *self);
322
323 /**
324  * modest_mail_operation_is_mine
325  * @self: a #ModestMailOperation
326  * @source: a #GObject to check if it have created @self operation.
327  * 
328  * Check if @source object its owner of @self mail operation.
329  *
330  * returns: TRUE if source its owner, FALSE otherwise.
331  **/
332 gboolean 
333 modest_mail_operation_is_mine (ModestMailOperation *self, 
334                                GObject *me);
335
336 /**
337  * modest_mail_operation_get_source
338  * @self: a #ModestMailOperation
339  *
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
343  **/
344 GObject *
345 modest_mail_operation_get_source (ModestMailOperation *self);
346
347 /* fill in other public functions, eg.: */
348
349 /**
350  * modest_mail_operation_send_mail:
351  * @self: a #ModestMailOperation
352  * @transport_account: a non-NULL #TnyTransportAccount
353  * @msg: a non-NULL #TnyMsg
354  * 
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
359   **/
360 void    modest_mail_operation_send_mail       (ModestMailOperation *self,
361                                                TnyTransportAccount *transport_account,
362                                                TnyMsg* msg);
363
364 /**
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
379  * 
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
384   **/
385 void    modest_mail_operation_send_new_mail   (ModestMailOperation *self,
386                                                TnyTransportAccount *transport_account,
387                                                TnyMsg *draft_msg,
388                                                const gchar *from,
389                                                const gchar *to,
390                                                const gchar *cc,
391                                                const gchar *bcc,
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);
400
401
402 /**
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
420  *
421  * Save a mail message to drafts using the provided
422  * #TnyTransportAccount. This operation is asynchronous.
423  *
424   **/
425 void modest_mail_operation_save_to_drafts   (ModestMailOperation *self,
426                                              TnyTransportAccount *transport_account,
427                                              TnyMsg *draft_msg,
428                                              const gchar *from,
429                                              const gchar *to,
430                                              const gchar *cc,
431                                              const gchar *bcc,
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,
441                                              gpointer user_data);
442 /**
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
448  * 
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.
454  *
455  * Example
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>
464  *
465  * Note that the account_name *MUST* be a modest account name, not a
466  * tinymail store account name
467  * 
468  **/
469 void          modest_mail_operation_update_account (ModestMailOperation *self,
470                                                     const gchar *account_name,
471                                                     gboolean poke_all,
472                                                     gboolean interactive,
473                                                     UpdateAccountCallback callback,
474                                                     gpointer user_data);
475
476 /* Functions that perform store operations */
477
478 /**
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
483  * 
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
489  * 
490  * Returns: a newly created #TnyFolder or NULL in case of error.
491  **/
492 void    modest_mail_operation_create_folder  (ModestMailOperation *self,
493                                               TnyFolderStore *parent,
494                                               const gchar *name,
495                                               CreateFolderUserCallback callback,
496                                               gpointer user_data);
497
498 /**
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
503  * permanently
504  * 
505  * Removes a folder. This operation is synchronous, so the
506  * #ModestMailOperation should not be added to any
507  * #ModestMailOperationQueue
508  **/
509 void          modest_mail_operation_remove_folder  (ModestMailOperation *self,
510                                                     TnyFolder *folder,
511                                                     gboolean remove_to_trash);
512
513 /**
514  * modest_mail_operation_rename_folder:
515  * @self: a #ModestMailOperation
516  * @folder: a #TnyFolder
517  * @name: a non-NULL name without "/"
518  * 
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
522  **/
523 void          modest_mail_operation_rename_folder  (ModestMailOperation *self,
524                                                     TnyFolder *folder, 
525                                                     const gchar *name,
526                                                     XferFolderAsyncUserCallback user_callback,
527                                                     gpointer user_data);
528
529 /**
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.
537  * 
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.
543  *
544  * If @delete_original is TRUE this function moves the original
545  * folder, if it is FALSE the it just copies it
546  *
547  **/
548 void          modest_mail_operation_xfer_folder    (ModestMailOperation *self,
549                                                     TnyFolder *folder,
550                                                     TnyFolderStore *parent,
551                                                     gboolean delete_original,
552                                                     XferFolderAsyncUserCallback user_callback,
553                                                     gpointer user_data);
554                                                     
555
556 /* Functions that performs msg operations */
557
558 /**
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.
566  * 
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.
571  *
572  * If the @delete_original paramter is TRUE then this function moves
573  * the messages between folders, otherwise it copies them.
574  * 
575  * Example
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);
581  *
582  * modest_mail_operation_xfer_msg (mail_op, headers, folder, TRUE);
583  * 
584  * g_object_unref (G_OBJECT (mail_op));
585  * </programlisting></informalexample>
586  *
587  **/
588 void          modest_mail_operation_xfer_msgs      (ModestMailOperation *self,
589                                                     TnyList *header_list, 
590                                                     TnyFolder *folder,
591                                                     gboolean delete_original,
592                                                     XferMsgsAsyncUserCallback user_callback,
593                                                     gpointer user_data);
594
595 /**
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
600  * permanently
601  * 
602  * Deletes a list of messages.
603  **/
604 void          modest_mail_operation_remove_msgs     (ModestMailOperation *self,
605                                                      TnyList *headers,
606                                                      gboolean remove_to_trash);
607
608 /**
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.
615  * 
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
619  *
620  * This operation also retrieves to cache all parts of the message. This is needed for
621  * forward operation.
622  **/
623 void          modest_mail_operation_get_msg_and_parts     (ModestMailOperation *self,
624                                                            TnyHeader *header,
625                                                            TnyList *parts,
626                                                            gboolean progress_feedback,
627                                                            GetMsgAsyncUserCallback user_callback,
628                                                            gpointer user_data);
629 /**
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.
636  * 
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
640  **/
641 void          modest_mail_operation_get_msg     (ModestMailOperation *self,
642                                                  TnyHeader *header,
643                                                  gboolean progress_feedback,
644                                                  GetMsgAsyncUserCallback user_callback,
645                                                  gpointer user_data);
646 /**
647  * modest_mail_operation_find_msg:
648  * @self: a #ModestMailOperation
649  * @msg_uid: a string
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.
653  * 
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
657  **/
658 void          modest_mail_operation_find_msg     (ModestMailOperation *self,
659                                                   TnyFolder *folder,
660                                                   const gchar *msg_uid,
661                                                   gboolean progress_feedback,
662                                                   GetMsgAsyncUserCallback user_callback,
663                                                   gpointer user_data);
664
665 /**
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.
671  * 
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
675  **/
676 void          modest_mail_operation_get_msgs_full   (ModestMailOperation *self,
677                                                      TnyList *headers_list,
678                                                      GetMsgAsyncUserCallback user_callback,
679                                                      gpointer user_data,
680                                                      GDestroyNotify notify);
681
682 /**
683  * modest_mail_operation_run_queue:
684  * @self: a #ModestMailOperation
685  * @queue: a #ModestTnySendQueue
686  *
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.
691  */
692 void          modest_mail_operation_run_queue       (ModestMailOperation *self,
693                                                      ModestTnySendQueue *queue);
694
695 /**
696  * modest_mail_operation_queue_wakeup:
697  * @self: a #ModestMailOperation
698  * @queue: a #ModestTnySendQueue
699  *
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.
703  */
704 void          modest_mail_operation_queue_wakeup       (ModestMailOperation *self,
705                                                         ModestTnySendQueue *queue);
706
707 /**
708  * modest_mail_operation_sync_folder:
709  * @self: a #ModestMailOperation
710  * @folder: a #TnyFolder
711  * @expunge: a #gboolean
712  *
713  * mail operation wrapper around tny_folder_sync () method, to keep modest
714  * running while we do that sync operation.
715  */
716 void          modest_mail_operation_sync_folder     (ModestMailOperation *self,
717                                                      TnyFolder *folder,
718                                                      gboolean expunge,
719                                                      SyncFolderCallback callback,
720                                                      gpointer user_data);
721
722 /**
723  * modest_mail_operation_shutdown:
724  * @self: a #ModestMailOperation
725  * @account_store: a #ModestTnyAccountStore
726  *
727  * disconnects all accounts in the account store (doing the proper syncs).
728  */
729 void          modest_mail_operation_shutdown        (ModestMailOperation *self,
730                                                      ModestTnyAccountStore *account_store);
731
732 /* Functions to control mail operations */
733 /**
734  * modest_mail_operation_get_task_done:
735  * @self: a #ModestMailOperation
736  * 
737  * Gets the amount of work done for a given mail operation. This
738  * amount of work is an absolute value.
739  * 
740  * Returns: the amount of work completed
741  **/
742 guint     modest_mail_operation_get_task_done      (ModestMailOperation *self);
743
744 /**
745  * modest_mail_operation_get_task_total:
746  * @self: a #ModestMailOperation
747  * 
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.
750  * 
751  * Returns: the total required amount of work
752  **/
753 guint     modest_mail_operation_get_task_total     (ModestMailOperation *self);
754
755
756 /**
757  * modest_mail_operation_is_finished:
758  * @self: a #ModestMailOperation
759  * 
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
766  * 
767  * Returns: TRUE if the operation is finished, FALSE otherwise
768  **/
769 gboolean  modest_mail_operation_is_finished        (ModestMailOperation *self);
770
771 /**
772  * modest_mail_operation_is_finished:
773  * @self: a #ModestMailOperation
774  * 
775  * Gets the current status of the given mail operation
776  *
777  * Returns: the current status or MODEST_MAIL_OPERATION_STATUS_INVALID in case of error
778  **/
779 ModestMailOperationStatus modest_mail_operation_get_status  (ModestMailOperation *self);
780
781 /**
782  * modest_mail_operation_get_error:
783  * @self: a #ModestMailOperation
784  * 
785  * Gets the error associated to the mail operation if exists
786  * 
787  * Returns: the #GError associated to the #ModestMailOperation if it
788  * exists or NULL otherwise
789  **/
790 const GError*             modest_mail_operation_get_error   (ModestMailOperation *self);
791
792 /**
793  * modest_mail_operation_cancel:
794  * @self: a #ModestMailOperation
795  *
796  * Cancels an active mail operation
797  * 
798  * Returns: TRUE if the operation was succesfully canceled, FALSE otherwise
799  **/
800 gboolean  modest_mail_operation_cancel          (ModestMailOperation *self);
801
802 /**
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.
808  * 
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
812  * was refreshed.
813  */
814 void      modest_mail_operation_refresh_folder  (ModestMailOperation *self,
815                                                  TnyFolder *folder,
816                                                  RefreshAsyncUserCallback user_callback,
817                                                  gpointer user_data);
818
819 /**
820  * modest_mail_operation_get_account:
821  * @self: a #ModestMailOperation
822  * 
823  * Gets the account associated to a mail operation
824  * 
825  * Returns: the #TnyAccount associated to the #ModestMailOperation
826  **/
827 TnyAccount *modest_mail_operation_get_account   (ModestMailOperation *self);
828
829
830 /**
831  * modest_mail_operation_noop:
832  * @self: a #ModestMailOperation
833  * 
834  * Does nothing except emitting operation-started and
835  * operation-finished
836  **/
837 void modest_mail_operation_noop (ModestMailOperation *self);
838
839
840 /**
841  * modest_mail_operation_to_string:
842  * @self: a #ModestMailOperation
843  * 
844  * get a string representation of the mail operation (for debugging)
845  *
846  * Returns: a newly allocated string
847  **/
848 gchar* modest_mail_operation_to_string (ModestMailOperation *self);
849
850
851 G_END_DECLS
852
853 #endif /* __MODEST_MAIL_OPERATION_H__ */
854