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>
38 /* convenience macros */
39 #define MODEST_TYPE_MAIL_OPERATION (modest_mail_operation_get_type())
40 #define MODEST_MAIL_OPERATION(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_MAIL_OPERATION,ModestMailOperation))
41 #define MODEST_MAIL_OPERATION_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_MAIL_OPERATION,GObject))
42 #define MODEST_IS_MAIL_OPERATION(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_MAIL_OPERATION))
43 #define MODEST_IS_MAIL_OPERATION_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_MAIL_OPERATION))
44 #define MODEST_MAIL_OPERATION_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_MAIL_OPERATION,ModestMailOperationClass))
46 typedef struct _ModestMailOperation ModestMailOperation;
47 typedef struct _ModestMailOperationClass ModestMailOperationClass;
50 * ModestMailOperationStatus:
52 * The state of a mail operation
54 typedef enum _ModestMailOperationStatus {
55 MODEST_MAIL_OPERATION_STATUS_INVALID,
56 MODEST_MAIL_OPERATION_STATUS_SUCCESS,
57 MODEST_MAIL_OPERATION_STATUS_FINISHED_WITH_ERRORS,
58 MODEST_MAIL_OPERATION_STATUS_FAILED,
59 MODEST_MAIL_OPERATION_STATUS_IN_PROGRESS,
60 MODEST_MAIL_OPERATION_STATUS_CANCELED
61 } ModestMailOperationStatus;
64 * ModestMailOperationId:
66 * The id for identifying the type of mail operation
69 MODEST_MAIL_OPERATION_TYPE_SEND,
70 MODEST_MAIL_OPERATION_TYPE_RECEIVE,
71 MODEST_MAIL_OPERATION_TYPE_OPEN,
72 MODEST_MAIL_OPERATION_TYPE_DELETE,
73 MODEST_MAIL_OPERATION_TYPE_INFO,
74 MODEST_MAIL_OPERATION_TYPE_UNKNOWN,
75 } ModestMailOperationTypeOperation;
78 * ErrorCheckingAsyncUserCallback:
80 * @mail_op: the current mail operation.
81 * @user_data: generic data passed to user defined function.
83 * This function implements required actions to performs under error
86 typedef void (*ErrorCheckingUserCallback) (ModestMailOperation *mail_op, gpointer user_data);
89 * GetMsgAsyncUserCallback:
91 * @obj: a #GObject generic object which has created current mail operation.
92 * @msg: a #TnyMsg message retrieved by async operation.
93 * @user_data: generic data passed to user defined function.
95 * This function will be called after get_msg_cb private function, which is
96 * used as tinymail operation callback. The private function fills private
97 * fields of mail operation and calls user defined callback if it exists.
99 typedef void (*GetMsgAsyncUserCallback) (ModestMailOperation *mail_op,
105 * XferMsgAsynUserCallback:
107 * @obj: a #GObject generic object which has created current mail operation.
108 * @user_data: generic data passed to user defined function.
110 * This function will be called after transfer_msgs_cb private function, which is
111 * used as tinymail operation callback. The private function fills private
112 * fields of mail operation and calls user defined callback if it exists.
114 typedef void (*XferMsgsAsynUserCallback) (const GObject *obj, gpointer user_data);
118 * RefreshAsyncUserCallback:
120 * @obj: a #GObject generic object which has created current mail operation.
121 * @folder: a #TnyFolder which has been refreshed .
122 * @user_data: generic data passed to user defined function.
124 * This function will be called after refresh_folder_async_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 (*RefreshAsyncUserCallback) (const GObject *obj,
133 * UpdateAccountCallback:
135 * @obj: a #GObject generic object which has created current mail operation.
136 * @new_messages: the amount of new messages received
137 * @user_data: generic data passed to user defined function.
139 * This is the callback of the update_account operation. It informs
140 * the caller about the amount of new messages that have been
143 typedef void (*UpdateAccountCallback) (ModestMailOperation *self,
147 /* This struct represents the internal state of a mail operation in a
155 ModestMailOperationStatus status;
156 ModestMailOperationTypeOperation op_type;
157 } ModestMailOperationState;
160 struct _ModestMailOperation {
162 /* insert public members, if any */
165 struct _ModestMailOperationClass {
166 GObjectClass parent_class;
169 void (*progress_changed) (ModestMailOperation *self, ModestMailOperationState *state, gpointer user_data);
172 /* member functions */
173 GType modest_mail_operation_get_type (void) G_GNUC_CONST;
176 * modest_mail_operation_new:
177 * @id: a #ModestMailOperationId identification of operation type.
178 * @source: a #GObject which creates this new operation.
180 * Creates a new instance of class #ModestMailOperation, using parameters
181 * to initialize its private structure. @source parameter may be NULL.
183 ModestMailOperation* modest_mail_operation_new (ModestMailOperationTypeOperation type,
187 * modest_mail_operation_new_with_error_handling:
188 * @id: a #ModestMailOperationId identification of operation type.
189 * @source: a #GObject which creates this new operation.
190 * @error_handler: a #ErrorCheckingUserCallback function to performs operations when
193 * Creates a new instance of class #ModestMailOperation, using parameters
194 * to initialize its private structure. @source parameter may be NULL.
195 * @error_handler can not be NULL, but it will be returned an mail operation
196 * object without error handling capability.
198 ModestMailOperation* modest_mail_operation_new_with_error_handling (ModestMailOperationTypeOperation op_type,
200 ErrorCheckingUserCallback error_handler,
203 * modest_mail_operation_execute_error_handler
204 * @self: a #ModestMailOperation
206 * Executes error handler if exists. The error handler is the one that
207 * MUST free the user data passed to the
208 * modest_mail_operation_new_with_error_handling constructor
211 modest_mail_operation_execute_error_handler (ModestMailOperation *self);
214 * modest_mail_operation_get_type_operation
215 * @self: a #ModestMailOperation
217 * Gets the private op_type field of mail operation. This op_type
218 * identifies the class/type of mail operation.
220 ModestMailOperationTypeOperation
221 modest_mail_operation_get_type_operation (ModestMailOperation *self);
224 * modest_mail_operation_is_mine
225 * @self: a #ModestMailOperation
226 * @source: a #GObject to check if it have created @self operation.
228 * Check if @source object its owner of @self mail operation.
230 * returns: TRUE if source its owner, FALSE otherwise.
233 modest_mail_operation_is_mine (ModestMailOperation *self,
237 * modest_mail_operation_get_source
238 * @self: a #ModestMailOperation
240 * returns a new reference to the object that created the mail
241 * operation passed to the constructor, or NULL if none. The caller
242 * must free the new reference
245 modest_mail_operation_get_source (ModestMailOperation *self);
247 /* fill in other public functions, eg.: */
250 * modest_mail_operation_send_mail:
251 * @self: a #ModestMailOperation
252 * @transport_account: a non-NULL #TnyTransportAccount
253 * @msg: a non-NULL #TnyMsg
255 * Sends and already existing message using the provided
256 * #TnyTransportAccount. This operation is synchronous, so the
257 * #ModestMailOperation should not be added to any
258 * #ModestMailOperationQueue
260 void modest_mail_operation_send_mail (ModestMailOperation *self,
261 TnyTransportAccount *transport_account,
265 * modest_mail_operation_send_new_mail:
266 * @self: a #ModestMailOperation
267 * @transport_account: a non-NULL #TnyTransportAccount
268 * @draft_msg: a #TnyMsg of the origin draft message, if any
269 * @from: the email address of the mail sender
270 * @to: a non-NULL email address of the mail receiver
271 * @cc: a comma-separated list of email addresses where to send a carbon copy
272 * @bcc: a comma-separated list of email addresses where to send a blind carbon copy
273 * @subject: the subject of the new mail
274 * @plain_body: the plain text body of the new mail.
275 * @html_body: the html version of the body of the new mail. If NULL, the mail will
276 * be sent with the plain body only.
277 * @attachments_list: a #GList of attachments, each attachment must be a #TnyMimePart
279 * Sends a new mail message using the provided
280 * #TnyTransportAccount. This operation is synchronous, so the
281 * #ModestMailOperation should not be added to any
282 * #ModestMailOperationQueue
284 void modest_mail_operation_send_new_mail (ModestMailOperation *self,
285 TnyTransportAccount *transport_account,
291 const gchar *subject,
292 const gchar *plain_body,
293 const gchar *html_body,
294 const GList *attachments_list,
295 TnyHeaderFlags priority_flags);
299 * modest_mail_operation_save_to_drafts:
300 * @self: a #ModestMailOperation
301 * @transport_account: a non-NULL #TnyTransportAccount
302 * @draft_msg: the previous draft message, in case it's an update
303 * to an existing draft.
304 * @from: the email address of the mail sender
305 * @to: a non-NULL email address of the mail receiver
306 * @cc: a comma-separated list of email addresses where to send a carbon copy
307 * @bcc: a comma-separated list of email addresses where to send a blind carbon copy
308 * @subject: the subject of the new mail
309 * @plain_body: the plain text body of the new mail.
310 * @html_body: the html version of the body of the new mail. If NULL, the mail will
311 * be sent with the plain body only.
312 * @attachments_list: a #GList of attachments, each attachment must be a #TnyMimePart
314 * Save a mail message to drafts using the provided
315 * #TnyTransportAccount. This operation is synchronous, so the
316 * #ModestMailOperation should not be added to any
317 * #ModestMailOperationQueue
319 void modest_mail_operation_save_to_drafts (ModestMailOperation *self,
320 TnyTransportAccount *transport_account,
326 const gchar *subject,
327 const gchar *plain_body,
328 const gchar *html_body,
329 const GList *attachments_list,
330 TnyHeaderFlags priority_flags);
332 * modest_mail_operation_update_account:
333 * @self: a #ModestMailOperation
334 * @account_name: the id of a Modest account
336 * Asynchronously refreshes the root folders of the given store
337 * account. The caller should add the #ModestMailOperation to a
338 * #ModestMailOperationQueue and then free it. The caller will be
339 * notified by the "progress_changed" signal each time the progress of
340 * the operation changes.
343 * <informalexample><programlisting>
344 * queue = modest_tny_platform_factory_get_modest_mail_operation_queue_instance (fact)
345 * mail_op = modest_mail_operation_new ();
346 * g_signal_connect (G_OBJECT (mail_op), "progress_changed", G_CALLBACK(on_progress_changed), NULL);
347 * modest_mail_operation_queue_add (queue, mail_op);
348 * modest_mail_operation_update_account (mail_op, account_name)
349 * g_object_unref (G_OBJECT (mail_op));
350 * </programlisting></informalexample>
352 * Note that the account_name *MUST* be a modest account name, not a
353 * tinymail store account name
355 * Returns: TRUE if the mail operation could be started, or FALSE otherwise
357 gboolean modest_mail_operation_update_account (ModestMailOperation *self,
358 const gchar *account_name,
359 UpdateAccountCallback callback,
362 /* Functions that perform store operations */
365 * modest_mail_operation_create_folder:
366 * @self: a #ModestMailOperation
367 * @parent: the #TnyFolderStore which is the parent of the new folder
368 * @name: the non-NULL new name for the new folder
370 * Creates a new folder as a children of a existing one. If the store
371 * account supports subscriptions this method also sets the new folder
372 * as subscribed. This operation is synchronous, so the
373 * #ModestMailOperation should not be added to any
374 * #ModestMailOperationQueue
376 * Returns: a newly created #TnyFolder or NULL in case of error.
378 TnyFolder* modest_mail_operation_create_folder (ModestMailOperation *self,
379 TnyFolderStore *parent,
383 * modest_mail_operation_remove_folder:
384 * @self: a #ModestMailOperation
385 * @folder: a #TnyFolder
386 * @remove_to_trash: TRUE to move it to trash or FALSE to delete
389 * Removes a folder. This operation is synchronous, so the
390 * #ModestMailOperation should not be added to any
391 * #ModestMailOperationQueue
393 void modest_mail_operation_remove_folder (ModestMailOperation *self,
395 gboolean remove_to_trash);
398 * modest_mail_operation_rename_folder:
399 * @self: a #ModestMailOperation
400 * @folder: a #TnyFolder
401 * @name: a non-NULL name without "/"
403 * Renames a given folder with the provided new name. This operation
404 * is synchronous, so the #ModestMailOperation should not be added to
405 * any #ModestMailOperationQueue
407 void modest_mail_operation_rename_folder (ModestMailOperation *self,
412 * modest_mail_operation_xfer_folder:
413 * @self: a #ModestMailOperation
414 * @folder: a #TnyFolder
415 * @parent: the new parent of the folder as #TnyFolderStore
416 * @delete_original: wheter or not delete the original folder
418 * Sets the given @folder as child of a provided #TnyFolderStore. This
419 * operation also transfers all the messages contained in the folder
420 * and all of his children folders with their messages as well. This
421 * operation is synchronous, so the #ModestMailOperation should not be
422 * added to any #ModestMailOperationQueue.
424 * If @delete_original is TRUE this function moves the original
425 * folder, if it is FALSE the it just copies it
428 void modest_mail_operation_xfer_folder (ModestMailOperation *self,
430 TnyFolderStore *parent,
431 gboolean delete_original);
433 /* Functions that performs msg operations */
436 * modest_mail_operation_xfer_msgs:
437 * @self: a #ModestMailOperation
438 * @header_list: a #TnyList of #TnyHeader to transfer
439 * @folder: the #TnyFolder where the messages will be transferred
440 * @delete_original: whether or not delete the source messages
441 * @user_callback: a #XferMsgsAsynUserCallback function to call after tinymail callback execution.
442 * @user_data: generic user data which will be passed to @user_callback function.
444 * Asynchronously transfers messages from their current folder to
445 * another one. The caller should add the #ModestMailOperation to a
446 * #ModestMailOperationQueue and then free it. The caller will be
447 * notified by the "progress_changed" when the operation is completed.
449 * If the @delete_original paramter is TRUE then this function moves
450 * the messages between folders, otherwise it copies them.
453 * <informalexample><programlisting>
454 * queue = modest_tny_platform_factory_get_modest_mail_operation_queue_instance (fact);
455 * mail_op = modest_mail_operation_new ();
456 * modest_mail_operation_queue_add (queue, mail_op);
457 * g_signal_connect (G_OBJECT (mail_op), "progress_changed", G_CALLBACK(on_progress_changed), queue);
459 * modest_mail_operation_xfer_msg (mail_op, headers, folder, TRUE);
461 * g_object_unref (G_OBJECT (mail_op));
462 * </programlisting></informalexample>
465 void modest_mail_operation_xfer_msgs (ModestMailOperation *self,
466 TnyList *header_list,
468 gboolean delete_original,
469 XferMsgsAsynUserCallback user_callback,
473 * modest_mail_operation_remove_msg:
474 * @self: a #ModestMailOperation
475 * @header: the #TnyHeader of the message to move
476 * @remove_to_trash: TRUE to move it to trash or FALSE to delete it
479 * Deletes a message. This operation is synchronous, so the
480 * #ModestMailOperation should not be added to any
481 * #ModestMailOperationQueue
483 void modest_mail_operation_remove_msg (ModestMailOperation *self,
485 gboolean remove_to_trash);
488 * modest_mail_operation_get_msg:
489 * @self: a #ModestMailOperation
490 * @header_list: the #TnyHeader of the message to get
491 * @user_callback: a #GetMsgAsyncUserCallback function to call after tinymail callback execution.
492 * @user_data: generic user data which will be passed to @user_callback function.
494 * Gets a message from header using an user defined @callback function
495 * pased as argument. This operation is asynchronous, so the
496 * #ModestMailOperation should be added to #ModestMailOperationQueue
498 void modest_mail_operation_get_msg (ModestMailOperation *self,
500 GetMsgAsyncUserCallback user_callback,
503 * modest_mail_operation_get_msgs_full:
504 * @self: a #ModestMailOperation
505 * @header_list: a #TnyList of #TnyHeader objects to get and process
506 * @user_callback: a #TnyGetMsgCallback function to call after tinymail operation execution.
507 * @user_data: user data passed to both, user_callback and update_status_callback.
509 * Gets messages from headers list and process hem using @callback function
510 * pased as argument. This operation is asynchronous, so the
511 * #ModestMailOperation should be added to #ModestMailOperationQueue
513 void modest_mail_operation_get_msgs_full (ModestMailOperation *self,
514 TnyList *headers_list,
515 GetMsgAsyncUserCallback user_callback,
517 GDestroyNotify notify);
519 /* Functions to control mail operations */
521 * modest_mail_operation_get_task_done:
522 * @self: a #ModestMailOperation
524 * Gets the amount of work done for a given mail operation. This
525 * amount of work is an absolute value.
527 * Returns: the amount of work completed
529 guint modest_mail_operation_get_task_done (ModestMailOperation *self);
532 * modest_mail_operation_get_task_total:
533 * @self: a #ModestMailOperation
535 * Gets the total amount of work that must be done to complete a given
536 * mail operation. This amount of work is an absolute value.
538 * Returns: the total required amount of work
540 guint modest_mail_operation_get_task_total (ModestMailOperation *self);
544 * modest_mail_operation_is_finished:
545 * @self: a #ModestMailOperation
547 * Checks if the operation is finished. A #ModestMailOperation is
548 * finished if it's in any of the following states:
549 * MODEST_MAIL_OPERATION_STATUS_SUCCESS,
550 * MODEST_MAIL_OPERATION_STATUS_FAILED,
551 * MODEST_MAIL_OPERATION_STATUS_CANCELED or
552 * MODEST_MAIL_OPERATION_STATUS_FINISHED_WITH_ERRORS
554 * Returns: TRUE if the operation is finished, FALSE otherwise
556 gboolean modest_mail_operation_is_finished (ModestMailOperation *self);
559 * modest_mail_operation_is_finished:
560 * @self: a #ModestMailOperation
562 * Gets the current status of the given mail operation
564 * Returns: the current status or MODEST_MAIL_OPERATION_STATUS_INVALID in case of error
566 ModestMailOperationStatus modest_mail_operation_get_status (ModestMailOperation *self);
569 * modest_mail_operation_get_error:
570 * @self: a #ModestMailOperation
572 * Gets the error associated to the mail operation if exists
574 * Returns: the #GError associated to the #ModestMailOperation if it
575 * exists or NULL otherwise
577 const GError* modest_mail_operation_get_error (ModestMailOperation *self);
580 * modest_mail_operation_cancel:
581 * @self: a #ModestMailOperation
583 * Cancels an active mail operation
585 * Returns: TRUE if the operation was succesfully canceled, FALSE otherwise
587 gboolean modest_mail_operation_cancel (ModestMailOperation *self);
590 * modest_mail_operation_refresh_folder
591 * @self: a #ModestMailOperation
592 * @folder: the #TnyFolder to refresh
593 * @user_callback: the #RefreshAsyncUserCallback function to be called
594 * after internal refresh async callback was being executed.
596 * Refreshes the contents of a folder. After internal callback was executed,
597 * and all interna mail operation field were filled, if exists, it calls an
598 * user callback function to make UI operations which must be done after folder
601 void modest_mail_operation_refresh_folder (ModestMailOperation *self,
603 RefreshAsyncUserCallback user_callback,
606 guint modest_mail_operation_get_id (ModestMailOperation *self);
608 guint modest_mail_operation_set_id (ModestMailOperation *self,
613 #endif /* __MODEST_MAIL_OPERATION_H__ */