* check for a valid foldername
[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
37 G_BEGIN_DECLS
38
39 /* convenience macros */
40 #define MODEST_TYPE_MAIL_OPERATION             (modest_mail_operation_get_type())
41 #define MODEST_MAIL_OPERATION(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_MAIL_OPERATION,ModestMailOperation))
42 #define MODEST_MAIL_OPERATION_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_MAIL_OPERATION,GObject))
43 #define MODEST_IS_MAIL_OPERATION(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_MAIL_OPERATION))
44 #define MODEST_IS_MAIL_OPERATION_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_MAIL_OPERATION))
45 #define MODEST_MAIL_OPERATION_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_MAIL_OPERATION,ModestMailOperationClass))
46
47 typedef struct _ModestMailOperation      ModestMailOperation;
48 typedef struct _ModestMailOperationClass ModestMailOperationClass;
49
50 /**
51  * ModestMailOperationStatus:
52  *
53  * The state of a mail operation
54  */
55 typedef enum _ModestMailOperationStatus {
56         MODEST_MAIL_OPERATION_STATUS_INVALID,
57         MODEST_MAIL_OPERATION_STATUS_SUCCESS,
58         MODEST_MAIL_OPERATION_STATUS_FINISHED_WITH_ERRORS,
59         MODEST_MAIL_OPERATION_STATUS_FAILED,
60         MODEST_MAIL_OPERATION_STATUS_IN_PROGRESS,
61         MODEST_MAIL_OPERATION_STATUS_CANCELED
62 } ModestMailOperationStatus;
63
64 /**
65  * ModestMailOperationId:
66  *
67  * The id for identifying the type of mail operation
68  */
69 typedef enum {
70         MODEST_MAIL_OPERATION_TYPE_SEND,
71         MODEST_MAIL_OPERATION_TYPE_RECEIVE,
72         MODEST_MAIL_OPERATION_TYPE_OPEN,
73         MODEST_MAIL_OPERATION_TYPE_DELETE,
74         MODEST_MAIL_OPERATION_TYPE_INFO,
75         MODEST_MAIL_OPERATION_TYPE_UNKNOWN,
76 } ModestMailOperationTypeOperation;
77
78 /**
79  * ErrorCheckingAsyncUserCallback:
80  *
81  * @mail_op: the current mail operation.
82  * @user_data: generic data passed to user defined function.
83  *
84  * This function implements required actions to performs under error
85  * states.  
86  */
87 typedef void (*ErrorCheckingUserCallback) (ModestMailOperation *mail_op, gpointer user_data);
88
89 /**
90  * GetMsgAsyncUserCallback:
91  *
92  * @mail_op: the current #ModestMailOperation.
93  * @header: a #TnyHeader summary item.
94  * @msg: a #TnyMsg message retrieved by async operation.
95  * @user_data: generic data passed to user defined function.
96  *
97  * This function will be called after get_msg_cb private function, which is
98  * used as tinymail operation callback. The private function fills private 
99  * fields of mail operation and calls user defined callback if it exists.
100  */
101 typedef void (*GetMsgAsyncUserCallback) (ModestMailOperation *mail_op, 
102                                          TnyHeader *header, 
103                                          TnyMsg *msg, 
104                                          gpointer user_data);
105
106 /**
107  * GetMimePartSizeCallback:
108  *
109  * @mail_op: the current #ModestMailOperation.
110  * @size: size of the attachment
111  * @user_data: generic data passed to user defined function.
112  *
113  */
114 typedef void (*GetMimePartSizeCallback) (ModestMailOperation *mail_op, 
115                                          gssize size,
116                                          gpointer user_data);
117
118 /**
119  * XferMsgAsynUserCallback:
120  *
121  * @obj: a #GObject generic object which has created current mail operation.
122  * @user_data: generic data passed to user defined function.
123  *
124  * This function will be called after transfer_msgs_cb private function, which is
125  * used as tinymail operation callback. The private function fills private 
126  * fields of mail operation and calls user defined callback if it exists.
127  */
128 typedef void (*XferMsgsAsynUserCallback) (const GObject *obj, gpointer user_data);
129
130
131 /**
132  * RefreshAsyncUserCallback:
133  *
134  * @mail_op: the current #ModestMailOperation.
135  * @folder: a #TnyFolder which has been refreshed .
136  * @user_data: generic data passed to user defined function.
137  *
138  * This function will be called after refresh_folder_async_cb private function, which is
139  * used as tinymail operation callback. The private function fills private 
140  * fields of mail operation and calls user defined callback if it exists.
141  */
142 typedef void (*RefreshAsyncUserCallback) (ModestMailOperation *mail_op, 
143                                           TnyFolder *folder, 
144                                           gpointer user_data);
145
146 /**
147  * UpdateAccountCallback:
148  *
149  * @obj: a #GObject generic object which has created current mail operation.
150  * @new_messages: the amount of new messages received
151  * @user_data: generic data passed to user defined function.
152  *
153  * This is the callback of the update_account operation. It informs
154  * the caller about the amount of new messages that have been
155  * downloaded
156  */
157 typedef void (*UpdateAccountCallback) (ModestMailOperation *self, 
158                                        gint new_messages,
159                                        gpointer user_data);
160
161 /* This struct represents the internal state of a mail operation in a
162    given time */
163 typedef struct {
164         guint      done;
165         guint      total;
166         gdouble    bytes_done;
167         gdouble    bytes_total;
168         gboolean   finished;
169         ModestMailOperationStatus        status;
170         ModestMailOperationTypeOperation op_type;
171 } ModestMailOperationState;
172
173
174 struct _ModestMailOperation {
175          GObject parent;
176         /* insert public members, if any */
177 };
178
179 struct _ModestMailOperationClass {
180         GObjectClass parent_class;
181
182         /* Signals */
183         void (*progress_changed) (ModestMailOperation *self, ModestMailOperationState *state, gpointer user_data);
184 };
185
186 /* member functions */
187 GType        modest_mail_operation_get_type    (void) G_GNUC_CONST;
188
189 /**
190  * modest_mail_operation_new:
191  * @id: a #ModestMailOperationId identification of operation type.
192  * @source: a #GObject which creates this new operation.
193  * 
194  * Creates a new instance of class #ModestMailOperation, using parameters
195  * to initialize its private structure. @source parameter may be NULL.
196  **/
197 ModestMailOperation*    modest_mail_operation_new     (ModestMailOperationTypeOperation type,
198                                                        GObject *source);
199
200 /**
201  * modest_mail_operation_new_with_error_handling:
202  * @id: a #ModestMailOperationId identification of operation type.
203  * @source: a #GObject which creates this new operation.
204  * @error_handler: a #ErrorCheckingUserCallback function to performs operations when 
205  * an error occurs.
206  * 
207  * Creates a new instance of class #ModestMailOperation, using parameters
208  * to initialize its private structure. @source parameter may be NULL. 
209  * @error_handler can not be NULL, but it will be returned an mail operation
210  * object without error handling capability.
211  **/
212 ModestMailOperation*    modest_mail_operation_new_with_error_handling     (ModestMailOperationTypeOperation op_type,
213                                                                            GObject *source,
214                                                                            ErrorCheckingUserCallback error_handler,
215                                                                            gpointer user_data);
216 /**
217  * modest_mail_operation_execute_error_handler
218  * @self: a #ModestMailOperation
219  * 
220  * Executes error handler if exists. The error handler is the one that
221  * MUST free the user data passed to the
222  * modest_mail_operation_new_with_error_handling constructor
223  **/
224 void
225 modest_mail_operation_execute_error_handler (ModestMailOperation *self);
226
227 /**
228  * modest_mail_operation_get_type_operation
229  * @self: a #ModestMailOperation
230  * 
231  * Gets the private op_type field of mail operation. This op_type
232  * identifies the class/type of mail operation.
233  **/
234 ModestMailOperationTypeOperation
235 modest_mail_operation_get_type_operation (ModestMailOperation *self);
236
237 /**
238  * modest_mail_operation_is_mine
239  * @self: a #ModestMailOperation
240  * @source: a #GObject to check if it have created @self operation.
241  * 
242  * Check if @source object its owner of @self mail operation.
243  *
244  * returns: TRUE if source its owner, FALSE otherwise.
245  **/
246 gboolean 
247 modest_mail_operation_is_mine (ModestMailOperation *self, 
248                                GObject *me);
249
250 /**
251  * modest_mail_operation_get_source
252  * @self: a #ModestMailOperation
253  *
254  * returns a new reference to the object that created the mail
255  * operation passed to the constructor, or NULL if none. The caller
256  * must free the new reference
257  **/
258 GObject *
259 modest_mail_operation_get_source (ModestMailOperation *self);
260
261 /* fill in other public functions, eg.: */
262
263 /**
264  * modest_mail_operation_send_mail:
265  * @self: a #ModestMailOperation
266  * @transport_account: a non-NULL #TnyTransportAccount
267  * @msg: a non-NULL #TnyMsg
268  * 
269  * Sends and already existing message using the provided
270  * #TnyTransportAccount. This operation is synchronous, so the
271  * #ModestMailOperation should not be added to any
272  * #ModestMailOperationQueue
273   **/
274 void    modest_mail_operation_send_mail       (ModestMailOperation *self,
275                                                TnyTransportAccount *transport_account,
276                                                TnyMsg* msg);
277
278 /**
279  * modest_mail_operation_send_new_mail:
280  * @self: a #ModestMailOperation
281  * @transport_account: a non-NULL #TnyTransportAccount
282  * @draft_msg: a #TnyMsg of the origin draft message, if any
283  * @from: the email address of the mail sender
284  * @to: a non-NULL email address of the mail receiver
285  * @cc: a comma-separated list of email addresses where to send a carbon copy
286  * @bcc: a comma-separated list of email addresses where to send a blind carbon copy
287  * @subject: the subject of the new mail
288  * @plain_body: the plain text body of the new mail.
289  * @html_body: the html version of the body of the new mail. If NULL, the mail will
290  *             be sent with the plain body only.
291  * @attachments_list: a #GList of attachments, each attachment must be a #TnyMimePart
292  * 
293  * Sends a new mail message using the provided
294  * #TnyTransportAccount. This operation is synchronous, so the
295  * #ModestMailOperation should not be added to any
296  * #ModestMailOperationQueue
297   **/
298 void    modest_mail_operation_send_new_mail   (ModestMailOperation *self,
299                                                TnyTransportAccount *transport_account,
300                                                TnyMsg *draft_msg,
301                                                const gchar *from,
302                                                const gchar *to,
303                                                const gchar *cc,
304                                                const gchar *bcc,
305                                                const gchar *subject,
306                                                const gchar *plain_body,
307                                                const gchar *html_body,
308                                                const GList *attachments_list,
309                                                TnyHeaderFlags priority_flags);
310
311
312 /**
313  * modest_mail_operation_save_to_drafts:
314  * @self: a #ModestMailOperation
315  * @transport_account: a non-NULL #TnyTransportAccount
316  * @draft_msg: the previous draft message, in case it's an update
317  * to an existing draft.
318  * @from: the email address of the mail sender
319  * @to: a non-NULL email address of the mail receiver
320  * @cc: a comma-separated list of email addresses where to send a carbon copy
321  * @bcc: a comma-separated list of email addresses where to send a blind carbon copy
322  * @subject: the subject of the new mail
323  * @plain_body: the plain text body of the new mail.
324  * @html_body: the html version of the body of the new mail. If NULL, the mail will
325  *             be sent with the plain body only.
326  * @attachments_list: a #GList of attachments, each attachment must be a #TnyMimePart
327  * 
328  * Save a mail message to drafts using the provided
329  * #TnyTransportAccount. This operation is synchronous, so the
330  * #ModestMailOperation should not be added to any
331  * #ModestMailOperationQueue
332  *
333   **/
334 void modest_mail_operation_save_to_drafts   (ModestMailOperation *self,
335                                              TnyTransportAccount *transport_account,
336                                              TnyMsg *draft_msg,
337                                              ModestMsgEditWindow *edit_window,
338                                              const gchar *from,
339                                              const gchar *to,
340                                              const gchar *cc,
341                                              const gchar *bcc,
342                                              const gchar *subject,
343                                              const gchar *plain_body,
344                                              const gchar *html_body,
345                                              const GList *attachments_list,
346                                              TnyHeaderFlags priority_flags);
347 /**
348  * modest_mail_operation_update_account:
349  * @self: a #ModestMailOperation
350  * @account_name: the id of a Modest account
351  * 
352  * Asynchronously refreshes the root folders of the given store
353  * account. The caller should add the #ModestMailOperation to a
354  * #ModestMailOperationQueue and then free it. The caller will be
355  * notified by the "progress_changed" signal each time the progress of
356  * the operation changes.
357  *
358  * Example
359  * <informalexample><programlisting>
360  * queue = modest_tny_platform_factory_get_modest_mail_operation_queue_instance (fact)
361  * mail_op = modest_mail_operation_new ();
362  * g_signal_connect (G_OBJECT (mail_op), "progress_changed", G_CALLBACK(on_progress_changed), NULL);
363  * modest_mail_operation_queue_add (queue, mail_op);
364  * modest_mail_operation_update_account (mail_op, account_name)
365  * g_object_unref (G_OBJECT (mail_op));
366  * </programlisting></informalexample>
367  *
368  * Note that the account_name *MUST* be a modest account name, not a
369  * tinymail store account name
370  * 
371  * Returns: TRUE if the mail operation could be started, or FALSE otherwise
372  **/
373 gboolean      modest_mail_operation_update_account (ModestMailOperation *self,
374                                                     const gchar *account_name,
375                                                     UpdateAccountCallback callback,
376                                                     gpointer user_data);
377
378 /* Functions that perform store operations */
379
380 /**
381  * modest_mail_operation_create_folder:
382  * @self: a #ModestMailOperation
383  * @parent: the #TnyFolderStore which is the parent of the new folder
384  * @name: the non-NULL new name for the new folder
385  * 
386  * Creates a new folder as a children of a existing one. If the store
387  * account supports subscriptions this method also sets the new folder
388  * as subscribed. This operation is synchronous, so the
389  * #ModestMailOperation should not be added to any
390  * #ModestMailOperationQueue
391  * 
392  * Returns: a newly created #TnyFolder or NULL in case of error.
393  **/
394 TnyFolder*    modest_mail_operation_create_folder  (ModestMailOperation *self,
395                                                     TnyFolderStore *parent,
396                                                     const gchar *name);
397
398 /**
399  * modest_mail_operation_remove_folder:
400  * @self: a #ModestMailOperation
401  * @folder: a #TnyFolder
402  * @remove_to_trash: TRUE to move it to trash or FALSE to delete
403  * permanently
404  * 
405  * Removes a folder. This operation is synchronous, so the
406  * #ModestMailOperation should not be added to any
407  * #ModestMailOperationQueue
408  **/
409 void          modest_mail_operation_remove_folder  (ModestMailOperation *self,
410                                                     TnyFolder *folder,
411                                                     gboolean remove_to_trash);
412
413 /**
414  * modest_mail_operation_rename_folder:
415  * @self: a #ModestMailOperation
416  * @folder: a #TnyFolder
417  * @name: a non-NULL name without "/"
418  * 
419  * Renames a given folder with the provided new name. This operation
420  * is synchronous, so the #ModestMailOperation should not be added to
421  * any #ModestMailOperationQueue
422  **/
423 void          modest_mail_operation_rename_folder  (ModestMailOperation *self,
424                                                     TnyFolder *folder, 
425                                                     const gchar *name);
426
427 /**
428  * modest_mail_operation_xfer_folder:
429  * @self: a #ModestMailOperation
430  * @folder: a #TnyFolder
431  * @parent: the new parent of the folder as #TnyFolderStore
432  * @delete_original: wheter or not delete the original folder
433  * @user_callback: a #XferMsgsAsynUserCallback function to call after tinymail callback execution.
434  * @user_data: generic user data which will be passed to @user_callback function.
435  * 
436  * Sets the given @folder as child of a provided #TnyFolderStore. This
437  * operation also transfers all the messages contained in the folder
438  * and all of his children folders with their messages as well. This
439  * operation is synchronous, so the #ModestMailOperation should not be
440  * added to any #ModestMailOperationQueue.
441  *
442  * If @delete_original is TRUE this function moves the original
443  * folder, if it is FALSE the it just copies it
444  *
445  **/
446 void          modest_mail_operation_xfer_folder    (ModestMailOperation *self,
447                                                     TnyFolder *folder,
448                                                     TnyFolderStore *parent,
449                                                     gboolean delete_original,
450                                                     XferMsgsAsynUserCallback user_callback,
451                                                     gpointer user_data);
452                                                     
453
454 /* Functions that performs msg operations */
455
456 /**
457  * modest_mail_operation_xfer_msgs:
458  * @self: a #ModestMailOperation
459  * @header_list: a #TnyList of #TnyHeader to transfer
460  * @folder: the #TnyFolder where the messages will be transferred
461  * @delete_original: whether or not delete the source messages
462  * @user_callback: a #XferMsgsAsynUserCallback function to call after tinymail callback execution.
463  * @user_data: generic user data which will be passed to @user_callback function.
464  * 
465  * Asynchronously transfers messages from their current folder to
466  * another one. The caller should add the #ModestMailOperation to a
467  * #ModestMailOperationQueue and then free it. The caller will be
468  * notified by the "progress_changed" when the operation is completed.
469  *
470  * If the @delete_original paramter is TRUE then this function moves
471  * the messages between folders, otherwise it copies them.
472  * 
473  * Example
474  * <informalexample><programlisting>
475  * queue = modest_tny_platform_factory_get_modest_mail_operation_queue_instance (fact);
476  * mail_op = modest_mail_operation_new ();
477  * modest_mail_operation_queue_add (queue, mail_op);
478  * g_signal_connect (G_OBJECT (mail_op), "progress_changed", G_CALLBACK(on_progress_changed), queue);
479  *
480  * modest_mail_operation_xfer_msg (mail_op, headers, folder, TRUE);
481  * 
482  * g_object_unref (G_OBJECT (mail_op));
483  * </programlisting></informalexample>
484  *
485  **/
486 void          modest_mail_operation_xfer_msgs      (ModestMailOperation *self,
487                                                     TnyList *header_list, 
488                                                     TnyFolder *folder,
489                                                     gboolean delete_original,
490                                                     XferMsgsAsynUserCallback user_callback,
491                                                     gpointer user_data);
492
493 /**
494  * modest_mail_operation_remove_msg:
495  * @self: a #ModestMailOperation
496  * @header: the #TnyHeader of the message to move
497  * @remove_to_trash: TRUE to move it to trash or FALSE to delete it
498  * permanently
499  * 
500  * Deletes a message. This operation is synchronous, so the
501  * #ModestMailOperation should not be added to any
502  * #ModestMailOperationQueue
503  **/
504 void          modest_mail_operation_remove_msg     (ModestMailOperation *self,
505                                                     TnyHeader *header,
506                                                     gboolean remove_to_trash);
507
508 /**
509  * modest_mail_operation_get_msg:
510  * @self: a #ModestMailOperation
511  * @header_list: the #TnyHeader of the message to get
512  * @user_callback: a #GetMsgAsyncUserCallback function to call after tinymail callback execution.
513  * @user_data: generic user data which will be passed to @user_callback function.
514  * 
515  * Gets a message from header using an user defined @callback function
516  * pased as argument. This operation is asynchronous, so the
517  * #ModestMailOperation should be added to #ModestMailOperationQueue
518  **/
519 void          modest_mail_operation_get_msg     (ModestMailOperation *self,
520                                                  TnyHeader *header, 
521                                                  GetMsgAsyncUserCallback user_callback,
522                                                  gpointer user_data);
523 /**
524  * modest_mail_operation_get_msgs_full:
525  * @self: a #ModestMailOperation
526  * @header_list: a #TnyList of #TnyHeader objects to get and process
527  * @user_callback: a #TnyGetMsgCallback function to call after tinymail operation execution.
528  * @user_data: user data passed to both, user_callback and update_status_callback.
529  * 
530  * Gets messages from headers list and process hem using @callback function
531  * pased as argument. This operation is asynchronous, so the
532  * #ModestMailOperation should be added to #ModestMailOperationQueue
533  **/
534 void          modest_mail_operation_get_msgs_full   (ModestMailOperation *self,
535                                                      TnyList *headers_list,
536                                                      GetMsgAsyncUserCallback user_callback,
537                                                      gpointer user_data,
538                                                      GDestroyNotify notify);
539
540 /* Functions to control mail operations */
541 /**
542  * modest_mail_operation_get_task_done:
543  * @self: a #ModestMailOperation
544  * 
545  * Gets the amount of work done for a given mail operation. This
546  * amount of work is an absolute value.
547  * 
548  * Returns: the amount of work completed
549  **/
550 guint     modest_mail_operation_get_task_done      (ModestMailOperation *self);
551
552 /**
553  * modest_mail_operation_get_task_total:
554  * @self: a #ModestMailOperation
555  * 
556  * Gets the total amount of work that must be done to complete a given
557  * mail operation. This amount of work is an absolute value.
558  * 
559  * Returns: the total required amount of work
560  **/
561 guint     modest_mail_operation_get_task_total     (ModestMailOperation *self);
562
563
564 /**
565  * modest_mail_operation_is_finished:
566  * @self: a #ModestMailOperation
567  * 
568  * Checks if the operation is finished. A #ModestMailOperation is
569  * finished if it's in any of the following states:
570  * MODEST_MAIL_OPERATION_STATUS_SUCCESS,
571  * MODEST_MAIL_OPERATION_STATUS_FAILED,
572  * MODEST_MAIL_OPERATION_STATUS_CANCELED or
573  * MODEST_MAIL_OPERATION_STATUS_FINISHED_WITH_ERRORS
574  * 
575  * Returns: TRUE if the operation is finished, FALSE otherwise
576  **/
577 gboolean  modest_mail_operation_is_finished        (ModestMailOperation *self);
578
579 /**
580  * modest_mail_operation_is_finished:
581  * @self: a #ModestMailOperation
582  * 
583  * Gets the current status of the given mail operation
584  *
585  * Returns: the current status or MODEST_MAIL_OPERATION_STATUS_INVALID in case of error
586  **/
587 ModestMailOperationStatus modest_mail_operation_get_status  (ModestMailOperation *self);
588
589 /**
590  * modest_mail_operation_get_error:
591  * @self: a #ModestMailOperation
592  * 
593  * Gets the error associated to the mail operation if exists
594  * 
595  * Returns: the #GError associated to the #ModestMailOperation if it
596  * exists or NULL otherwise
597  **/
598 const GError*             modest_mail_operation_get_error   (ModestMailOperation *self);
599
600 /**
601  * modest_mail_operation_cancel:
602  * @self: a #ModestMailOperation
603  *
604  * Cancels an active mail operation
605  * 
606  * Returns: TRUE if the operation was succesfully canceled, FALSE otherwise
607  **/
608 gboolean  modest_mail_operation_cancel          (ModestMailOperation *self);
609
610 /**
611  * modest_mail_operation_refresh_folder
612  * @self: a #ModestMailOperation
613  * @folder: the #TnyFolder to refresh
614  * @user_callback: the #RefreshAsyncUserCallback function to be called
615  * after internal refresh async callback was being executed.
616  * 
617  * Refreshes the contents of a folder. After internal callback was executed, 
618  * and all interna mail operation field were filled, if exists, it calls an 
619  * user callback function to make UI operations which must be done after folder
620  * was refreshed.
621  */
622 void      modest_mail_operation_refresh_folder  (ModestMailOperation *self,
623                                                  TnyFolder *folder,
624                                                  RefreshAsyncUserCallback user_callback,
625                                                  gpointer user_data);
626
627 guint     modest_mail_operation_get_id          (ModestMailOperation *self);
628
629 guint     modest_mail_operation_set_id          (ModestMailOperation *self,
630                                                  guint id);
631
632 G_END_DECLS
633
634 #endif /* __MODEST_MAIL_OPERATION_H__ */
635