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,
175 * SaveToDraftsCallback:
177 * @self: a #ModestMailOperation
178 * @saved_draft: the new draft message that has been saved
179 * @user_data: generic data passed to user defined function.
181 * This is the callback of the save_to_drafts operation. It returns
182 * the newly created msg stored in the Drafts folder
184 typedef void (*SaveToDraftstCallback) (ModestMailOperation *self,
189 typedef gboolean (*RetrieveAllCallback) (GObject *source,
193 /* This struct represents the internal state of a mail operation in a
201 ModestMailOperationStatus status;
202 ModestMailOperationTypeOperation op_type;
203 } ModestMailOperationState;
206 struct _ModestMailOperation {
208 /* insert public members, if any */
211 struct _ModestMailOperationClass {
212 GObjectClass parent_class;
215 void (*progress_changed) (ModestMailOperation *self, ModestMailOperationState *state, gpointer user_data);
216 void (*operation_started) (ModestMailOperation *self, gpointer user_data);
217 void (*operation_finished) (ModestMailOperation *self, gpointer user_data);
220 /* member functions */
221 GType modest_mail_operation_get_type (void) G_GNUC_CONST;
224 * modest_mail_operation_new:
225 * @source: a #GObject which creates this new operation.
227 * Creates a new instance of class #ModestMailOperation, using parameters
228 * to initialize its private structure. @source parameter may be NULL.
230 ModestMailOperation* modest_mail_operation_new (GObject *source);
233 * modest_mail_operation_new_with_error_handling:
234 * @id: a #ModestMailOperationId identification of operation type.
235 * @source: a #GObject which creates this new operation.
236 * @error_handler: a #ErrorCheckingUserCallback function to performs operations when
239 * Creates a new instance of class #ModestMailOperation, using parameters
240 * to initialize its private structure. @source parameter may be NULL.
241 * @error_handler can not be NULL, but it will be returned an mail operation
242 * object without error handling capability.
244 ModestMailOperation* modest_mail_operation_new_with_error_handling (GObject *source,
245 ErrorCheckingUserCallback error_handler,
247 ErrorCheckingUserDataDestroyer error_handler_destroyer);
249 * modest_mail_operation_execute_error_handler
250 * @self: a #ModestMailOperation
252 * Executes error handler if exists. The error handler is the one that
253 * MUST free the user data passed to the
254 * modest_mail_operation_new_with_error_handling constructor
257 modest_mail_operation_execute_error_handler (ModestMailOperation *self);
260 * modest_mail_operation_get_type_operation
261 * @self: a #ModestMailOperation
263 * Gets the private op_type field of mail operation. This op_type
264 * identifies the class/type of mail operation.
266 ModestMailOperationTypeOperation
267 modest_mail_operation_get_type_operation (ModestMailOperation *self);
270 * modest_mail_operation_is_mine
271 * @self: a #ModestMailOperation
272 * @source: a #GObject to check if it have created @self operation.
274 * Check if @source object its owner of @self mail operation.
276 * returns: TRUE if source its owner, FALSE otherwise.
279 modest_mail_operation_is_mine (ModestMailOperation *self,
283 * modest_mail_operation_get_source
284 * @self: a #ModestMailOperation
286 * returns a new reference to the object that created the mail
287 * operation passed to the constructor, or NULL if none. The caller
288 * must free the new reference
291 modest_mail_operation_get_source (ModestMailOperation *self);
293 /* fill in other public functions, eg.: */
296 * modest_mail_operation_send_mail:
297 * @self: a #ModestMailOperation
298 * @transport_account: a non-NULL #TnyTransportAccount
299 * @msg: a non-NULL #TnyMsg
301 * Sends and already existing message using the provided
302 * #TnyTransportAccount. This operation is synchronous, so the
303 * #ModestMailOperation should not be added to any
304 * #ModestMailOperationQueue
306 void modest_mail_operation_send_mail (ModestMailOperation *self,
307 TnyTransportAccount *transport_account,
311 * modest_mail_operation_send_new_mail:
312 * @self: a #ModestMailOperation
313 * @transport_account: a non-NULL #TnyTransportAccount
314 * @draft_msg: a #TnyMsg of the origin draft message, if any
315 * @from: the email address of the mail sender
316 * @to: a non-NULL email address of the mail receiver
317 * @cc: a comma-separated list of email addresses where to send a carbon copy
318 * @bcc: a comma-separated list of email addresses where to send a blind carbon copy
319 * @subject: the subject of the new mail
320 * @plain_body: the plain text body of the new mail.
321 * @html_body: the html version of the body of the new mail. If NULL, the mail will
322 * be sent with the plain body only.
323 * @attachments_list: a #GList of attachments, each attachment must be a #TnyMimePart
324 * @images_list: a #GList of image attachments, each attachment must be a #TnyMimePart
326 * Sends a new mail message using the provided
327 * #TnyTransportAccount. This operation is synchronous, so the
328 * #ModestMailOperation should not be added to any
329 * #ModestMailOperationQueue
331 void modest_mail_operation_send_new_mail (ModestMailOperation *self,
332 TnyTransportAccount *transport_account,
338 const gchar *subject,
339 const gchar *plain_body,
340 const gchar *html_body,
341 const GList *attachments_list,
342 const GList *images_list,
343 TnyHeaderFlags priority_flags);
347 * modest_mail_operation_save_to_drafts:
348 * @self: a #ModestMailOperation
349 * @transport_account: a non-NULL #TnyTransportAccount
350 * @draft_msg: the previous draft message, in case it's an update
351 * to an existing draft.
352 * @from: the email address of the mail sender
353 * @to: a non-NULL email address of the mail receiver
354 * @cc: a comma-separated list of email addresses where to send a carbon copy
355 * @bcc: a comma-separated list of email addresses where to send a blind carbon copy
356 * @subject: the subject of the new mail
357 * @plain_body: the plain text body of the new mail.
358 * @html_body: the html version of the body of the new mail. If NULL, the mail will
359 * be sent with the plain body only.
360 * @attachments_list: a #GList of attachments, each attachment must be a #TnyMimePart
361 * @images_list: a #GList of image attachments, each attachment must be a #TnyMimePart
362 * @callback: the user callback, will be called when the operation finishes
363 * @user_data: data that will be passed to the user callback
365 * Save a mail message to drafts using the provided
366 * #TnyTransportAccount. This operation is asynchronous.
369 void modest_mail_operation_save_to_drafts (ModestMailOperation *self,
370 TnyTransportAccount *transport_account,
376 const gchar *subject,
377 const gchar *plain_body,
378 const gchar *html_body,
379 const GList *attachments_list,
380 const GList *images_list,
381 TnyHeaderFlags priority_flags,
382 SaveToDraftstCallback callback,
385 * modest_mail_operation_update_account:
386 * @self: a #ModestMailOperation
387 * @account_name: the id of a Modest account
388 * @poke_all: if TRUE it will also do a poke_status over all folders of the account
390 * Asynchronously refreshes the root folders of the given store
391 * account. The caller should add the #ModestMailOperation to a
392 * #ModestMailOperationQueue and then free it. The caller will be
393 * notified by the "progress_changed" signal each time the progress of
394 * the operation changes.
397 * <informalexample><programlisting>
398 * queue = modest_tny_platform_factory_get_modest_mail_operation_queue_instance (fact)
399 * mail_op = modest_mail_operation_new ();
400 * g_signal_connect (G_OBJECT (mail_op), "progress_changed", G_CALLBACK(on_progress_changed), NULL);
401 * modest_mail_operation_queue_add (queue, mail_op);
402 * modest_mail_operation_update_account (mail_op, account_name)
403 * g_object_unref (G_OBJECT (mail_op));
404 * </programlisting></informalexample>
406 * Note that the account_name *MUST* be a modest account name, not a
407 * tinymail store account name
410 void modest_mail_operation_update_account (ModestMailOperation *self,
411 const gchar *account_name,
413 RetrieveAllCallback retrieve_all_cb,
414 UpdateAccountCallback callback,
417 /* Functions that perform store operations */
420 * modest_mail_operation_create_folder:
421 * @self: a #ModestMailOperation
422 * @parent: the #TnyFolderStore which is the parent of the new folder
423 * @name: the non-NULL new name for the new folder
425 * Creates a new folder as a children of a existing one. If the store
426 * account supports subscriptions this method also sets the new folder
427 * as subscribed. This operation is synchronous, so the
428 * #ModestMailOperation should not be added to any
429 * #ModestMailOperationQueue
431 * Returns: a newly created #TnyFolder or NULL in case of error.
433 TnyFolder* modest_mail_operation_create_folder (ModestMailOperation *self,
434 TnyFolderStore *parent,
438 * modest_mail_operation_remove_folder:
439 * @self: a #ModestMailOperation
440 * @folder: a #TnyFolder
441 * @remove_to_trash: TRUE to move it to trash or FALSE to delete
444 * Removes a folder. This operation is synchronous, so the
445 * #ModestMailOperation should not be added to any
446 * #ModestMailOperationQueue
448 void modest_mail_operation_remove_folder (ModestMailOperation *self,
450 gboolean remove_to_trash);
453 * modest_mail_operation_rename_folder:
454 * @self: a #ModestMailOperation
455 * @folder: a #TnyFolder
456 * @name: a non-NULL name without "/"
458 * Renames a given folder with the provided new name. This operation
459 * is synchronous, so the #ModestMailOperation should not be added to
460 * any #ModestMailOperationQueue
462 void modest_mail_operation_rename_folder (ModestMailOperation *self,
467 * modest_mail_operation_xfer_folder:
468 * @self: a #ModestMailOperation
469 * @folder: a #TnyFolder
470 * @parent: the new parent of the folder as #TnyFolderStore
471 * @delete_original: wheter or not delete the original folder
472 * @user_callback: a #XferAsyncUserCallback function to call after tinymail callback execution.
473 * @user_data: generic user data which will be passed to @user_callback function.
475 * Sets the given @folder as child of a provided #TnyFolderStore. This
476 * operation also transfers all the messages contained in the folder
477 * and all of his children folders with their messages as well. This
478 * operation is synchronous, so the #ModestMailOperation should not be
479 * added to any #ModestMailOperationQueue.
481 * If @delete_original is TRUE this function moves the original
482 * folder, if it is FALSE the it just copies it
485 void modest_mail_operation_xfer_folder (ModestMailOperation *self,
487 TnyFolderStore *parent,
488 gboolean delete_original,
489 XferAsyncUserCallback user_callback,
493 /* Functions that performs msg operations */
496 * modest_mail_operation_xfer_msgs:
497 * @self: a #ModestMailOperation
498 * @header_list: a #TnyList of #TnyHeader to transfer
499 * @folder: the #TnyFolder where the messages will be transferred
500 * @delete_original: whether or not delete the source messages
501 * @user_callback: a #XferAsyncUserCallback function to call after tinymail callback execution.
502 * @user_data: generic user data which will be passed to @user_callback function.
504 * Asynchronously transfers messages from their current folder to
505 * another one. The caller should add the #ModestMailOperation to a
506 * #ModestMailOperationQueue and then free it. The caller will be
507 * notified by the "progress_changed" when the operation is completed.
509 * If the @delete_original paramter is TRUE then this function moves
510 * the messages between folders, otherwise it copies them.
513 * <informalexample><programlisting>
514 * queue = modest_tny_platform_factory_get_modest_mail_operation_queue_instance (fact);
515 * mail_op = modest_mail_operation_new ();
516 * modest_mail_operation_queue_add (queue, mail_op);
517 * g_signal_connect (G_OBJECT (mail_op), "progress_changed", G_CALLBACK(on_progress_changed), queue);
519 * modest_mail_operation_xfer_msg (mail_op, headers, folder, TRUE);
521 * g_object_unref (G_OBJECT (mail_op));
522 * </programlisting></informalexample>
525 void modest_mail_operation_xfer_msgs (ModestMailOperation *self,
526 TnyList *header_list,
528 gboolean delete_original,
529 XferAsyncUserCallback user_callback,
533 * modest_mail_operation_remove_msg:
534 * @self: a #ModestMailOperation
535 * @header: the #TnyHeader of the message to move
536 * @remove_to_trash: TRUE to move it to trash or FALSE to delete it
539 * Deletes a message. This operation is synchronous, so the
540 * #ModestMailOperation should not be added to any
541 * #ModestMailOperationQueue
543 void modest_mail_operation_remove_msg (ModestMailOperation *self,
545 gboolean remove_to_trash);
548 * modest_mail_operation_remove_msg:
549 * @self: a #ModestMailOperation
550 * @headers: the #TnyList of the messages to delete
551 * @remove_to_trash: TRUE to move it to trash or FALSE to delete it
554 * Deletes a list of messages. This operation is synchronous, so the
555 * #ModestMailOperation should not be added to any
556 * #ModestMailOperationQueue
558 void modest_mail_operation_remove_msgs (ModestMailOperation *self,
560 gboolean remove_to_trash);
563 * modest_mail_operation_get_msg:
564 * @self: a #ModestMailOperation
565 * @header_list: the #TnyHeader of the message to get
566 * @user_callback: a #GetMsgAsyncUserCallback function to call after tinymail callback execution.
567 * @user_data: generic user data which will be passed to @user_callback function.
569 * Gets a message from header using an user defined @callback function
570 * pased as argument. This operation is asynchronous, so the
571 * #ModestMailOperation should be added to #ModestMailOperationQueue
573 void modest_mail_operation_get_msg (ModestMailOperation *self,
575 GetMsgAsyncUserCallback user_callback,
578 * modest_mail_operation_get_msgs_full:
579 * @self: a #ModestMailOperation
580 * @header_list: a #TnyList of #TnyHeader objects to get and process
581 * @user_callback: a #TnyGetMsgCallback function to call after tinymail operation execution.
582 * @user_data: user data passed to both, user_callback and update_status_callback.
584 * Gets messages from headers list and process hem using @callback function
585 * pased as argument. This operation is asynchronous, so the
586 * #ModestMailOperation should be added to #ModestMailOperationQueue
588 void modest_mail_operation_get_msgs_full (ModestMailOperation *self,
589 TnyList *headers_list,
590 GetMsgAsyncUserCallback user_callback,
592 GDestroyNotify notify);
594 /* Functions to control mail operations */
596 * modest_mail_operation_get_task_done:
597 * @self: a #ModestMailOperation
599 * Gets the amount of work done for a given mail operation. This
600 * amount of work is an absolute value.
602 * Returns: the amount of work completed
604 guint modest_mail_operation_get_task_done (ModestMailOperation *self);
607 * modest_mail_operation_get_task_total:
608 * @self: a #ModestMailOperation
610 * Gets the total amount of work that must be done to complete a given
611 * mail operation. This amount of work is an absolute value.
613 * Returns: the total required amount of work
615 guint modest_mail_operation_get_task_total (ModestMailOperation *self);
619 * modest_mail_operation_is_finished:
620 * @self: a #ModestMailOperation
622 * Checks if the operation is finished. A #ModestMailOperation is
623 * finished if it's in any of the following states:
624 * MODEST_MAIL_OPERATION_STATUS_SUCCESS,
625 * MODEST_MAIL_OPERATION_STATUS_FAILED,
626 * MODEST_MAIL_OPERATION_STATUS_CANCELED or
627 * MODEST_MAIL_OPERATION_STATUS_FINISHED_WITH_ERRORS
629 * Returns: TRUE if the operation is finished, FALSE otherwise
631 gboolean modest_mail_operation_is_finished (ModestMailOperation *self);
634 * modest_mail_operation_is_finished:
635 * @self: a #ModestMailOperation
637 * Gets the current status of the given mail operation
639 * Returns: the current status or MODEST_MAIL_OPERATION_STATUS_INVALID in case of error
641 ModestMailOperationStatus modest_mail_operation_get_status (ModestMailOperation *self);
644 * modest_mail_operation_get_error:
645 * @self: a #ModestMailOperation
647 * Gets the error associated to the mail operation if exists
649 * Returns: the #GError associated to the #ModestMailOperation if it
650 * exists or NULL otherwise
652 const GError* modest_mail_operation_get_error (ModestMailOperation *self);
655 * modest_mail_operation_cancel:
656 * @self: a #ModestMailOperation
658 * Cancels an active mail operation
660 * Returns: TRUE if the operation was succesfully canceled, FALSE otherwise
662 gboolean modest_mail_operation_cancel (ModestMailOperation *self);
665 * modest_mail_operation_refresh_folder
666 * @self: a #ModestMailOperation
667 * @folder: the #TnyFolder to refresh
668 * @user_callback: the #RefreshAsyncUserCallback function to be called
669 * after internal refresh async callback was being executed.
671 * Refreshes the contents of a folder. After internal callback was executed,
672 * and all interna mail operation field were filled, if exists, it calls an
673 * user callback function to make UI operations which must be done after folder
676 void modest_mail_operation_refresh_folder (ModestMailOperation *self,
678 RefreshAsyncUserCallback user_callback,
682 * modest_mail_operation_get_account:
683 * @self: a #ModestMailOperation
685 * Gets the account associated to a mail operation
687 * Returns: the #TnyAccount associated to the #ModestMailOperation
689 TnyAccount *modest_mail_operation_get_account (ModestMailOperation *self);
693 * modest_mail_operation_noop:
694 * @self: a #ModestMailOperation
696 * Does nothing except emitting operation-started and
699 void modest_mail_operation_noop (ModestMailOperation *self);
703 #endif /* __MODEST_MAIL_OPERATION_H__ */