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 * ErrorCheckingUserCallback:
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 * ErrorCheckingUserDataDestroyer:
92 * @user_data: generic data passed to user defined function.
94 * This function is used to destroy the user_data passed to the error
95 * checking user callback function
97 typedef void (*ErrorCheckingUserDataDestroyer) (gpointer user_data);
101 * GetMsgAsyncUserCallback:
103 * @mail_op: the current #ModestMailOperation.
104 * @header: a #TnyHeader summary item.
105 * @msg: a #TnyMsg message retrieved by async operation.
106 * @user_data: generic data passed to user defined function.
108 * This function will be called after get_msg_cb private function, which is
109 * used as tinymail operation callback. The private function fills private
110 * fields of mail operation and calls user defined callback if it exists.
112 typedef void (*GetMsgAsyncUserCallback) (ModestMailOperation *mail_op,
120 * GetMimePartSizeCallback:
122 * @mail_op: the current #ModestMailOperation.
123 * @size: size of the attachment
124 * @user_data: generic data passed to user defined function.
127 typedef void (*GetMimePartSizeCallback) (ModestMailOperation *mail_op,
132 * XferAsyncUserCallback:
134 * @obj: a #GObject generic object which has created current mail operation.
135 * @user_data: generic data passed to user defined function.
137 * This function will be called after transfer_msgs_cb private function, which is
138 * used as tinymail operation callback. The private function fills private
139 * fields of mail operation and calls user defined callback if it exists.
141 typedef void (*XferAsyncUserCallback) (ModestMailOperation *mail_op, gpointer user_data);
145 * RefreshAsyncUserCallback:
147 * @mail_op: the current #ModestMailOperation.
148 * @folder: a #TnyFolder which has been refreshed .
149 * @user_data: generic data passed to user defined function.
151 * This function will be called after refresh_folder_async_cb private function, which is
152 * used as tinymail operation callback. The private function fills private
153 * fields of mail operation and calls user defined callback if it exists.
155 typedef void (*RefreshAsyncUserCallback) (ModestMailOperation *mail_op,
160 * UpdateAccountCallback:
162 * @self: a #ModestMailOperation
163 * @new_headers: the list of new headers received
164 * @user_data: generic data passed to user defined function.
166 * This is the callback of the update_account operation. It informs
167 * the caller about the amount of new messages that have been
170 typedef void (*UpdateAccountCallback) (ModestMailOperation *self,
171 TnyList *new_headers,
176 * SaveToDraftsCallback:
178 * @self: a #ModestMailOperation
179 * @saved_draft: the new draft message that has been saved
180 * @user_data: generic data passed to user defined function.
182 * This is the callback of the save_to_drafts operation. It returns
183 * the newly created msg stored in the Drafts folder
185 typedef void (*SaveToDraftstCallback) (ModestMailOperation *self,
190 /* This struct represents the internal state of a mail operation in a
198 ModestMailOperationStatus status;
199 ModestMailOperationTypeOperation op_type;
200 } ModestMailOperationState;
203 struct _ModestMailOperation {
205 /* insert public members, if any */
208 struct _ModestMailOperationClass {
209 GObjectClass parent_class;
212 void (*progress_changed) (ModestMailOperation *self, ModestMailOperationState *state, gpointer user_data);
213 void (*operation_started) (ModestMailOperation *self, gpointer user_data);
214 void (*operation_finished) (ModestMailOperation *self, gpointer user_data);
217 /* member functions */
218 GType modest_mail_operation_get_type (void) G_GNUC_CONST;
221 * modest_mail_operation_new:
222 * @source: a #GObject which creates this new operation.
224 * Creates a new instance of class #ModestMailOperation, using parameters
225 * to initialize its private structure. @source parameter may be NULL.
227 ModestMailOperation* modest_mail_operation_new (GObject *source);
230 * modest_mail_operation_new_with_error_handling:
231 * @id: a #ModestMailOperationId identification of operation type.
232 * @source: a #GObject which creates this new operation.
233 * @error_handler: a #ErrorCheckingUserCallback function to performs operations when
236 * Creates a new instance of class #ModestMailOperation, using parameters
237 * to initialize its private structure. @source parameter may be NULL.
238 * @error_handler can not be NULL, but it will be returned an mail operation
239 * object without error handling capability.
241 ModestMailOperation* modest_mail_operation_new_with_error_handling (GObject *source,
242 ErrorCheckingUserCallback error_handler,
244 ErrorCheckingUserDataDestroyer error_handler_destroyer);
246 * modest_mail_operation_execute_error_handler
247 * @self: a #ModestMailOperation
249 * Executes error handler if exists. The error handler is the one that
250 * MUST free the user data passed to the
251 * modest_mail_operation_new_with_error_handling constructor
254 modest_mail_operation_execute_error_handler (ModestMailOperation *self);
257 * modest_mail_operation_get_type_operation
258 * @self: a #ModestMailOperation
260 * Gets the private op_type field of mail operation. This op_type
261 * identifies the class/type of mail operation.
263 ModestMailOperationTypeOperation
264 modest_mail_operation_get_type_operation (ModestMailOperation *self);
267 * modest_mail_operation_is_mine
268 * @self: a #ModestMailOperation
269 * @source: a #GObject to check if it have created @self operation.
271 * Check if @source object its owner of @self mail operation.
273 * returns: TRUE if source its owner, FALSE otherwise.
276 modest_mail_operation_is_mine (ModestMailOperation *self,
280 * modest_mail_operation_get_source
281 * @self: a #ModestMailOperation
283 * returns a new reference to the object that created the mail
284 * operation passed to the constructor, or NULL if none. The caller
285 * must free the new reference
288 modest_mail_operation_get_source (ModestMailOperation *self);
290 /* fill in other public functions, eg.: */
293 * modest_mail_operation_send_mail:
294 * @self: a #ModestMailOperation
295 * @transport_account: a non-NULL #TnyTransportAccount
296 * @msg: a non-NULL #TnyMsg
298 * Sends and already existing message using the provided
299 * #TnyTransportAccount. This operation is synchronous, so the
300 * #ModestMailOperation should not be added to any
301 * #ModestMailOperationQueue
303 void modest_mail_operation_send_mail (ModestMailOperation *self,
304 TnyTransportAccount *transport_account,
308 * modest_mail_operation_send_new_mail:
309 * @self: a #ModestMailOperation
310 * @transport_account: a non-NULL #TnyTransportAccount
311 * @draft_msg: a #TnyMsg of the origin draft message, if any
312 * @from: the email address of the mail sender
313 * @to: a non-NULL email address of the mail receiver
314 * @cc: a comma-separated list of email addresses where to send a carbon copy
315 * @bcc: a comma-separated list of email addresses where to send a blind carbon copy
316 * @subject: the subject of the new mail
317 * @plain_body: the plain text body of the new mail.
318 * @html_body: the html version of the body of the new mail. If NULL, the mail will
319 * be sent with the plain body only.
320 * @attachments_list: a #GList of attachments, each attachment must be a #TnyMimePart
321 * @images_list: a #GList of image attachments, each attachment must be a #TnyMimePart
323 * Sends a new mail message using the provided
324 * #TnyTransportAccount. This operation is synchronous, so the
325 * #ModestMailOperation should not be added to any
326 * #ModestMailOperationQueue
328 void modest_mail_operation_send_new_mail (ModestMailOperation *self,
329 TnyTransportAccount *transport_account,
335 const gchar *subject,
336 const gchar *plain_body,
337 const gchar *html_body,
338 const GList *attachments_list,
339 const GList *images_list,
340 TnyHeaderFlags priority_flags);
344 * modest_mail_operation_save_to_drafts:
345 * @self: a #ModestMailOperation
346 * @transport_account: a non-NULL #TnyTransportAccount
347 * @draft_msg: the previous draft message, in case it's an update
348 * to an existing draft.
349 * @from: the email address of the mail sender
350 * @to: a non-NULL email address of the mail receiver
351 * @cc: a comma-separated list of email addresses where to send a carbon copy
352 * @bcc: a comma-separated list of email addresses where to send a blind carbon copy
353 * @subject: the subject of the new mail
354 * @plain_body: the plain text body of the new mail.
355 * @html_body: the html version of the body of the new mail. If NULL, the mail will
356 * be sent with the plain body only.
357 * @attachments_list: a #GList of attachments, each attachment must be a #TnyMimePart
358 * @images_list: a #GList of image attachments, each attachment must be a #TnyMimePart
359 * @callback: the user callback, will be called when the operation finishes
360 * @user_data: data that will be passed to the user callback
362 * Save a mail message to drafts using the provided
363 * #TnyTransportAccount. This operation is asynchronous.
366 void modest_mail_operation_save_to_drafts (ModestMailOperation *self,
367 TnyTransportAccount *transport_account,
373 const gchar *subject,
374 const gchar *plain_body,
375 const gchar *html_body,
376 const GList *attachments_list,
377 const GList *images_list,
378 TnyHeaderFlags priority_flags,
379 SaveToDraftstCallback callback,
382 * modest_mail_operation_update_account:
383 * @self: a #ModestMailOperation
384 * @account_name: the id of a Modest account
386 * Asynchronously refreshes the root folders of the given store
387 * account. The caller should add the #ModestMailOperation to a
388 * #ModestMailOperationQueue and then free it. The caller will be
389 * notified by the "progress_changed" signal each time the progress of
390 * the operation changes.
393 * <informalexample><programlisting>
394 * queue = modest_tny_platform_factory_get_modest_mail_operation_queue_instance (fact)
395 * mail_op = modest_mail_operation_new ();
396 * g_signal_connect (G_OBJECT (mail_op), "progress_changed", G_CALLBACK(on_progress_changed), NULL);
397 * modest_mail_operation_queue_add (queue, mail_op);
398 * modest_mail_operation_update_account (mail_op, account_name)
399 * g_object_unref (G_OBJECT (mail_op));
400 * </programlisting></informalexample>
402 * Note that the account_name *MUST* be a modest account name, not a
403 * tinymail store account name
405 * Returns: TRUE if the mail operation could be started, or FALSE otherwise
407 gboolean modest_mail_operation_update_account (ModestMailOperation *self,
408 const gchar *account_name,
409 UpdateAccountCallback callback,
412 /* Functions that perform store operations */
415 * modest_mail_operation_create_folder:
416 * @self: a #ModestMailOperation
417 * @parent: the #TnyFolderStore which is the parent of the new folder
418 * @name: the non-NULL new name for the new folder
420 * Creates a new folder as a children of a existing one. If the store
421 * account supports subscriptions this method also sets the new folder
422 * as subscribed. This operation is synchronous, so the
423 * #ModestMailOperation should not be added to any
424 * #ModestMailOperationQueue
426 * Returns: a newly created #TnyFolder or NULL in case of error.
428 TnyFolder* modest_mail_operation_create_folder (ModestMailOperation *self,
429 TnyFolderStore *parent,
433 * modest_mail_operation_remove_folder:
434 * @self: a #ModestMailOperation
435 * @folder: a #TnyFolder
436 * @remove_to_trash: TRUE to move it to trash or FALSE to delete
439 * Removes a folder. This operation is synchronous, so the
440 * #ModestMailOperation should not be added to any
441 * #ModestMailOperationQueue
443 void modest_mail_operation_remove_folder (ModestMailOperation *self,
445 gboolean remove_to_trash);
448 * modest_mail_operation_rename_folder:
449 * @self: a #ModestMailOperation
450 * @folder: a #TnyFolder
451 * @name: a non-NULL name without "/"
453 * Renames a given folder with the provided new name. This operation
454 * is synchronous, so the #ModestMailOperation should not be added to
455 * any #ModestMailOperationQueue
457 void modest_mail_operation_rename_folder (ModestMailOperation *self,
462 * modest_mail_operation_xfer_folder:
463 * @self: a #ModestMailOperation
464 * @folder: a #TnyFolder
465 * @parent: the new parent of the folder as #TnyFolderStore
466 * @delete_original: wheter or not delete the original folder
467 * @user_callback: a #XferAsyncUserCallback function to call after tinymail callback execution.
468 * @user_data: generic user data which will be passed to @user_callback function.
470 * Sets the given @folder as child of a provided #TnyFolderStore. This
471 * operation also transfers all the messages contained in the folder
472 * and all of his children folders with their messages as well. This
473 * operation is synchronous, so the #ModestMailOperation should not be
474 * added to any #ModestMailOperationQueue.
476 * If @delete_original is TRUE this function moves the original
477 * folder, if it is FALSE the it just copies it
480 void modest_mail_operation_xfer_folder (ModestMailOperation *self,
482 TnyFolderStore *parent,
483 gboolean delete_original,
484 XferAsyncUserCallback user_callback,
488 /* Functions that performs msg operations */
491 * modest_mail_operation_xfer_msgs:
492 * @self: a #ModestMailOperation
493 * @header_list: a #TnyList of #TnyHeader to transfer
494 * @folder: the #TnyFolder where the messages will be transferred
495 * @delete_original: whether or not delete the source messages
496 * @user_callback: a #XferAsyncUserCallback function to call after tinymail callback execution.
497 * @user_data: generic user data which will be passed to @user_callback function.
499 * Asynchronously transfers messages from their current folder to
500 * another one. The caller should add the #ModestMailOperation to a
501 * #ModestMailOperationQueue and then free it. The caller will be
502 * notified by the "progress_changed" when the operation is completed.
504 * If the @delete_original paramter is TRUE then this function moves
505 * the messages between folders, otherwise it copies them.
508 * <informalexample><programlisting>
509 * queue = modest_tny_platform_factory_get_modest_mail_operation_queue_instance (fact);
510 * mail_op = modest_mail_operation_new ();
511 * modest_mail_operation_queue_add (queue, mail_op);
512 * g_signal_connect (G_OBJECT (mail_op), "progress_changed", G_CALLBACK(on_progress_changed), queue);
514 * modest_mail_operation_xfer_msg (mail_op, headers, folder, TRUE);
516 * g_object_unref (G_OBJECT (mail_op));
517 * </programlisting></informalexample>
520 void modest_mail_operation_xfer_msgs (ModestMailOperation *self,
521 TnyList *header_list,
523 gboolean delete_original,
524 XferAsyncUserCallback user_callback,
528 * modest_mail_operation_remove_msg:
529 * @self: a #ModestMailOperation
530 * @header: the #TnyHeader of the message to move
531 * @remove_to_trash: TRUE to move it to trash or FALSE to delete it
534 * Deletes a message. This operation is synchronous, so the
535 * #ModestMailOperation should not be added to any
536 * #ModestMailOperationQueue
538 void modest_mail_operation_remove_msg (ModestMailOperation *self,
540 gboolean remove_to_trash);
543 * modest_mail_operation_remove_msg:
544 * @self: a #ModestMailOperation
545 * @headers: the #TnyList of the messages to delete
546 * @remove_to_trash: TRUE to move it to trash or FALSE to delete it
549 * Deletes a list of messages. This operation is synchronous, so the
550 * #ModestMailOperation should not be added to any
551 * #ModestMailOperationQueue
553 void modest_mail_operation_remove_msgs (ModestMailOperation *self,
555 gboolean remove_to_trash);
558 * modest_mail_operation_get_msg:
559 * @self: a #ModestMailOperation
560 * @header_list: the #TnyHeader of the message to get
561 * @user_callback: a #GetMsgAsyncUserCallback function to call after tinymail callback execution.
562 * @user_data: generic user data which will be passed to @user_callback function.
564 * Gets a message from header using an user defined @callback function
565 * pased as argument. This operation is asynchronous, so the
566 * #ModestMailOperation should be added to #ModestMailOperationQueue
568 void modest_mail_operation_get_msg (ModestMailOperation *self,
570 GetMsgAsyncUserCallback user_callback,
573 * modest_mail_operation_get_msgs_full:
574 * @self: a #ModestMailOperation
575 * @header_list: a #TnyList of #TnyHeader objects to get and process
576 * @user_callback: a #TnyGetMsgCallback function to call after tinymail operation execution.
577 * @user_data: user data passed to both, user_callback and update_status_callback.
579 * Gets messages from headers list and process hem using @callback function
580 * pased as argument. This operation is asynchronous, so the
581 * #ModestMailOperation should be added to #ModestMailOperationQueue
583 void modest_mail_operation_get_msgs_full (ModestMailOperation *self,
584 TnyList *headers_list,
585 GetMsgAsyncUserCallback user_callback,
587 GDestroyNotify notify);
589 /* Functions to control mail operations */
591 * modest_mail_operation_get_task_done:
592 * @self: a #ModestMailOperation
594 * Gets the amount of work done for a given mail operation. This
595 * amount of work is an absolute value.
597 * Returns: the amount of work completed
599 guint modest_mail_operation_get_task_done (ModestMailOperation *self);
602 * modest_mail_operation_get_task_total:
603 * @self: a #ModestMailOperation
605 * Gets the total amount of work that must be done to complete a given
606 * mail operation. This amount of work is an absolute value.
608 * Returns: the total required amount of work
610 guint modest_mail_operation_get_task_total (ModestMailOperation *self);
614 * modest_mail_operation_is_finished:
615 * @self: a #ModestMailOperation
617 * Checks if the operation is finished. A #ModestMailOperation is
618 * finished if it's in any of the following states:
619 * MODEST_MAIL_OPERATION_STATUS_SUCCESS,
620 * MODEST_MAIL_OPERATION_STATUS_FAILED,
621 * MODEST_MAIL_OPERATION_STATUS_CANCELED or
622 * MODEST_MAIL_OPERATION_STATUS_FINISHED_WITH_ERRORS
624 * Returns: TRUE if the operation is finished, FALSE otherwise
626 gboolean modest_mail_operation_is_finished (ModestMailOperation *self);
629 * modest_mail_operation_is_finished:
630 * @self: a #ModestMailOperation
632 * Gets the current status of the given mail operation
634 * Returns: the current status or MODEST_MAIL_OPERATION_STATUS_INVALID in case of error
636 ModestMailOperationStatus modest_mail_operation_get_status (ModestMailOperation *self);
639 * modest_mail_operation_get_error:
640 * @self: a #ModestMailOperation
642 * Gets the error associated to the mail operation if exists
644 * Returns: the #GError associated to the #ModestMailOperation if it
645 * exists or NULL otherwise
647 const GError* modest_mail_operation_get_error (ModestMailOperation *self);
650 * modest_mail_operation_cancel:
651 * @self: a #ModestMailOperation
653 * Cancels an active mail operation
655 * Returns: TRUE if the operation was succesfully canceled, FALSE otherwise
657 gboolean modest_mail_operation_cancel (ModestMailOperation *self);
660 * modest_mail_operation_refresh_folder
661 * @self: a #ModestMailOperation
662 * @folder: the #TnyFolder to refresh
663 * @user_callback: the #RefreshAsyncUserCallback function to be called
664 * after internal refresh async callback was being executed.
666 * Refreshes the contents of a folder. After internal callback was executed,
667 * and all interna mail operation field were filled, if exists, it calls an
668 * user callback function to make UI operations which must be done after folder
671 void modest_mail_operation_refresh_folder (ModestMailOperation *self,
673 RefreshAsyncUserCallback user_callback,
676 TnyAccount *modest_mail_operation_get_account (ModestMailOperation *self);
680 #endif /* __MODEST_MAIL_OPERATION_H__ */