1 /* Copyright (c) 2006, Nokia Corporation
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
8 * * Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * * Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * * Neither the name of the Nokia Corporation nor the names of its
14 * contributors may be used to endorse or promote products derived from
15 * this software without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
18 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
19 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
20 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
21 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
24 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
25 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
26 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 #ifndef __MODEST_MAIL_OPERATION_H__
31 #define __MODEST_MAIL_OPERATION_H__
33 #include <tny-transport-account.h>
34 #include <tny-folder-store.h>
35 #include <widgets/modest-msg-edit-window.h>
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))
47 typedef struct _ModestMailOperation ModestMailOperation;
48 typedef struct _ModestMailOperationClass ModestMailOperationClass;
51 * ModestMailOperationStatus:
53 * The state of a mail operation
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;
65 * ModestMailOperationId:
67 * The id for identifying the type of mail operation
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;
79 * ErrorCheckingAsyncUserCallback:
81 * @mail_op: the current mail operation.
82 * @user_data: generic data passed to user defined function.
84 * This function implements required actions to performs under error
87 typedef void (*ErrorCheckingUserCallback) (ModestMailOperation *mail_op, gpointer user_data);
90 * GetMsgAsyncUserCallback:
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.
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.
101 typedef void (*GetMsgAsyncUserCallback) (ModestMailOperation *mail_op,
107 * GetMimePartSizeCallback:
109 * @mail_op: the current #ModestMailOperation.
110 * @size: size of the attachment
111 * @user_data: generic data passed to user defined function.
114 typedef void (*GetMimePartSizeCallback) (ModestMailOperation *mail_op,
119 * XferAsyncUserCallback:
121 * @obj: a #GObject generic object which has created current mail operation.
122 * @user_data: generic data passed to user defined function.
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.
128 typedef void (*XferAsyncUserCallback) (ModestMailOperation *mail_op, gpointer user_data);
132 * RefreshAsyncUserCallback:
134 * @mail_op: the current #ModestMailOperation.
135 * @folder: a #TnyFolder which has been refreshed .
136 * @user_data: generic data passed to user defined function.
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.
142 typedef void (*RefreshAsyncUserCallback) (ModestMailOperation *mail_op,
147 * UpdateAccountCallback:
149 * @obj: a #GObject generic object which has created current mail operation.
150 * @new_headers: the list of new headers received
151 * @user_data: generic data passed to user defined function.
153 * This is the callback of the update_account operation. It informs
154 * the caller about the amount of new messages that have been
157 typedef void (*UpdateAccountCallback) (ModestMailOperation *self,
158 TnyList *new_headers,
161 /* This struct represents the internal state of a mail operation in a
169 ModestMailOperationStatus status;
170 ModestMailOperationTypeOperation op_type;
171 } ModestMailOperationState;
174 struct _ModestMailOperation {
176 /* insert public members, if any */
179 struct _ModestMailOperationClass {
180 GObjectClass parent_class;
183 void (*progress_changed) (ModestMailOperation *self, ModestMailOperationState *state, gpointer user_data);
186 /* member functions */
187 GType modest_mail_operation_get_type (void) G_GNUC_CONST;
190 * modest_mail_operation_new:
191 * @id: a #ModestMailOperationId identification of operation type.
192 * @source: a #GObject which creates this new operation.
194 * Creates a new instance of class #ModestMailOperation, using parameters
195 * to initialize its private structure. @source parameter may be NULL.
197 ModestMailOperation* modest_mail_operation_new (ModestMailOperationTypeOperation type,
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
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.
212 ModestMailOperation* modest_mail_operation_new_with_error_handling (ModestMailOperationTypeOperation op_type,
214 ErrorCheckingUserCallback error_handler,
217 * modest_mail_operation_execute_error_handler
218 * @self: a #ModestMailOperation
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
225 modest_mail_operation_execute_error_handler (ModestMailOperation *self);
228 * modest_mail_operation_get_type_operation
229 * @self: a #ModestMailOperation
231 * Gets the private op_type field of mail operation. This op_type
232 * identifies the class/type of mail operation.
234 ModestMailOperationTypeOperation
235 modest_mail_operation_get_type_operation (ModestMailOperation *self);
238 * modest_mail_operation_is_mine
239 * @self: a #ModestMailOperation
240 * @source: a #GObject to check if it have created @self operation.
242 * Check if @source object its owner of @self mail operation.
244 * returns: TRUE if source its owner, FALSE otherwise.
247 modest_mail_operation_is_mine (ModestMailOperation *self,
251 * modest_mail_operation_get_source
252 * @self: a #ModestMailOperation
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
259 modest_mail_operation_get_source (ModestMailOperation *self);
261 /* fill in other public functions, eg.: */
264 * modest_mail_operation_send_mail:
265 * @self: a #ModestMailOperation
266 * @transport_account: a non-NULL #TnyTransportAccount
267 * @msg: a non-NULL #TnyMsg
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
274 void modest_mail_operation_send_mail (ModestMailOperation *self,
275 TnyTransportAccount *transport_account,
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
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
298 void modest_mail_operation_send_new_mail (ModestMailOperation *self,
299 TnyTransportAccount *transport_account,
305 const gchar *subject,
306 const gchar *plain_body,
307 const gchar *html_body,
308 const GList *attachments_list,
309 TnyHeaderFlags priority_flags);
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
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
334 void modest_mail_operation_save_to_drafts (ModestMailOperation *self,
335 TnyTransportAccount *transport_account,
337 ModestMsgEditWindow *edit_window,
342 const gchar *subject,
343 const gchar *plain_body,
344 const gchar *html_body,
345 const GList *attachments_list,
346 TnyHeaderFlags priority_flags);
348 * modest_mail_operation_update_account:
349 * @self: a #ModestMailOperation
350 * @account_name: the id of a Modest account
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.
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>
368 * Note that the account_name *MUST* be a modest account name, not a
369 * tinymail store account name
371 * Returns: TRUE if the mail operation could be started, or FALSE otherwise
373 gboolean modest_mail_operation_update_account (ModestMailOperation *self,
374 const gchar *account_name,
375 UpdateAccountCallback callback,
378 /* Functions that perform store operations */
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
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
392 * Returns: a newly created #TnyFolder or NULL in case of error.
394 TnyFolder* modest_mail_operation_create_folder (ModestMailOperation *self,
395 TnyFolderStore *parent,
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
405 * Removes a folder. This operation is synchronous, so the
406 * #ModestMailOperation should not be added to any
407 * #ModestMailOperationQueue
409 void modest_mail_operation_remove_folder (ModestMailOperation *self,
411 gboolean remove_to_trash);
414 * modest_mail_operation_rename_folder:
415 * @self: a #ModestMailOperation
416 * @folder: a #TnyFolder
417 * @name: a non-NULL name without "/"
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
423 void modest_mail_operation_rename_folder (ModestMailOperation *self,
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 #XferAsyncUserCallback function to call after tinymail callback execution.
434 * @user_data: generic user data which will be passed to @user_callback function.
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.
442 * If @delete_original is TRUE this function moves the original
443 * folder, if it is FALSE the it just copies it
446 void modest_mail_operation_xfer_folder (ModestMailOperation *self,
448 TnyFolderStore *parent,
449 gboolean delete_original,
450 XferAsyncUserCallback user_callback,
454 /* Functions that performs msg operations */
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 #XferAsyncUserCallback function to call after tinymail callback execution.
463 * @user_data: generic user data which will be passed to @user_callback function.
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.
470 * If the @delete_original paramter is TRUE then this function moves
471 * the messages between folders, otherwise it copies them.
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);
480 * modest_mail_operation_xfer_msg (mail_op, headers, folder, TRUE);
482 * g_object_unref (G_OBJECT (mail_op));
483 * </programlisting></informalexample>
486 void modest_mail_operation_xfer_msgs (ModestMailOperation *self,
487 TnyList *header_list,
489 gboolean delete_original,
490 XferAsyncUserCallback user_callback,
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
500 * Deletes a message. This operation is synchronous, so the
501 * #ModestMailOperation should not be added to any
502 * #ModestMailOperationQueue
504 void modest_mail_operation_remove_msg (ModestMailOperation *self,
506 gboolean remove_to_trash);
509 * modest_mail_operation_remove_msg:
510 * @self: a #ModestMailOperation
511 * @headers: the #TnyList of the messages to delete
512 * @remove_to_trash: TRUE to move it to trash or FALSE to delete it
515 * Deletes a list of messages. This operation is synchronous, so the
516 * #ModestMailOperation should not be added to any
517 * #ModestMailOperationQueue
519 void modest_mail_operation_remove_msgs (ModestMailOperation *self,
521 gboolean remove_to_trash);
524 * modest_mail_operation_get_msg:
525 * @self: a #ModestMailOperation
526 * @header_list: the #TnyHeader of the message to get
527 * @user_callback: a #GetMsgAsyncUserCallback function to call after tinymail callback execution.
528 * @user_data: generic user data which will be passed to @user_callback function.
530 * Gets a message from header using an user defined @callback function
531 * pased as argument. This operation is asynchronous, so the
532 * #ModestMailOperation should be added to #ModestMailOperationQueue
534 void modest_mail_operation_get_msg (ModestMailOperation *self,
536 GetMsgAsyncUserCallback user_callback,
539 * modest_mail_operation_get_msgs_full:
540 * @self: a #ModestMailOperation
541 * @header_list: a #TnyList of #TnyHeader objects to get and process
542 * @user_callback: a #TnyGetMsgCallback function to call after tinymail operation execution.
543 * @user_data: user data passed to both, user_callback and update_status_callback.
545 * Gets messages from headers list and process hem using @callback function
546 * pased as argument. This operation is asynchronous, so the
547 * #ModestMailOperation should be added to #ModestMailOperationQueue
549 void modest_mail_operation_get_msgs_full (ModestMailOperation *self,
550 TnyList *headers_list,
551 GetMsgAsyncUserCallback user_callback,
553 GDestroyNotify notify);
555 /* Functions to control mail operations */
557 * modest_mail_operation_get_task_done:
558 * @self: a #ModestMailOperation
560 * Gets the amount of work done for a given mail operation. This
561 * amount of work is an absolute value.
563 * Returns: the amount of work completed
565 guint modest_mail_operation_get_task_done (ModestMailOperation *self);
568 * modest_mail_operation_get_task_total:
569 * @self: a #ModestMailOperation
571 * Gets the total amount of work that must be done to complete a given
572 * mail operation. This amount of work is an absolute value.
574 * Returns: the total required amount of work
576 guint modest_mail_operation_get_task_total (ModestMailOperation *self);
580 * modest_mail_operation_is_finished:
581 * @self: a #ModestMailOperation
583 * Checks if the operation is finished. A #ModestMailOperation is
584 * finished if it's in any of the following states:
585 * MODEST_MAIL_OPERATION_STATUS_SUCCESS,
586 * MODEST_MAIL_OPERATION_STATUS_FAILED,
587 * MODEST_MAIL_OPERATION_STATUS_CANCELED or
588 * MODEST_MAIL_OPERATION_STATUS_FINISHED_WITH_ERRORS
590 * Returns: TRUE if the operation is finished, FALSE otherwise
592 gboolean modest_mail_operation_is_finished (ModestMailOperation *self);
595 * modest_mail_operation_is_finished:
596 * @self: a #ModestMailOperation
598 * Gets the current status of the given mail operation
600 * Returns: the current status or MODEST_MAIL_OPERATION_STATUS_INVALID in case of error
602 ModestMailOperationStatus modest_mail_operation_get_status (ModestMailOperation *self);
605 * modest_mail_operation_get_error:
606 * @self: a #ModestMailOperation
608 * Gets the error associated to the mail operation if exists
610 * Returns: the #GError associated to the #ModestMailOperation if it
611 * exists or NULL otherwise
613 const GError* modest_mail_operation_get_error (ModestMailOperation *self);
616 * modest_mail_operation_cancel:
617 * @self: a #ModestMailOperation
619 * Cancels an active mail operation
621 * Returns: TRUE if the operation was succesfully canceled, FALSE otherwise
623 gboolean modest_mail_operation_cancel (ModestMailOperation *self);
626 * modest_mail_operation_refresh_folder
627 * @self: a #ModestMailOperation
628 * @folder: the #TnyFolder to refresh
629 * @user_callback: the #RefreshAsyncUserCallback function to be called
630 * after internal refresh async callback was being executed.
632 * Refreshes the contents of a folder. After internal callback was executed,
633 * and all interna mail operation field were filled, if exists, it calls an
634 * user callback function to make UI operations which must be done after folder
637 void modest_mail_operation_refresh_folder (ModestMailOperation *self,
639 RefreshAsyncUserCallback user_callback,
642 guint modest_mail_operation_get_id (ModestMailOperation *self);
644 guint modest_mail_operation_set_id (ModestMailOperation *self,
649 #endif /* __MODEST_MAIL_OPERATION_H__ */