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
68 typedef enum _ModestMailOperationId {
69 MODEST_MAIL_OPERATION_ID_SEND,
70 MODEST_MAIL_OPERATION_ID_RECEIVE,
71 MODEST_MAIL_OPERATION_ID_OPEN,
72 MODEST_MAIL_OPERATION_ID_DELETE,
73 MODEST_MAIL_OPERATION_ID_INFO,
74 MODEST_MAIL_OPERATION_ID_UNKNOWN,
75 } ModestMailOperationId;
78 struct _ModestMailOperation {
80 /* insert public members, if any */
83 struct _ModestMailOperationClass {
84 GObjectClass parent_class;
87 void (*progress_changed) (ModestMailOperation *self, gpointer user_data);
91 * ErroCheckingAsyncUserCallback:
93 * @obj: a #GObject generic object which has created current mail operation.
94 * @user_data: generic data passed to user defined function.
96 * This function implements required actions to performs under error
99 typedef void (*ErrorCheckingUserCallback) (const GObject *obj, gpointer user_data);
102 * GetMsgAsynUserCallback:
104 * @obj: a #GObject generic object which has created current mail operation.
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 (*GetMsgAsynUserCallback) (const GObject *obj, TnyMsg *msg, gpointer user_data);
115 * XferMsgAsynUserCallback:
117 * @obj: a #GObject generic object which has created current mail operation.
118 * @user_data: generic data passed to user defined function.
120 * This function will be called after transfer_msgs_cb private function, which is
121 * used as tinymail operation callback. The private function fills private
122 * fields of mail operation and calls user defined callback if it exists.
124 typedef void (*XferMsgsAsynUserCallback) (const GObject *obj, gpointer user_data);
127 /* member functions */
128 GType modest_mail_operation_get_type (void) G_GNUC_CONST;
131 * modest_mail_operation_new:
132 * @id: a #ModestMailOperationId identification of operation type.
133 * @source: a #GObject which creates this new operation.
135 * Creates a new instance of class #ModestMailOperation, using parameters
136 * to initialize its private structure. @source parameter may be NULL.
138 ModestMailOperation* modest_mail_operation_new (ModestMailOperationId id,
142 * modest_mail_operation_new_with_error_handling:
143 * @id: a #ModestMailOperationId identification of operation type.
144 * @source: a #GObject which creates this new operation.
145 * @error_handler: a #ErrorCheckingUserCallback function to performs operations when
148 * Creates a new instance of class #ModestMailOperation, using parameters
149 * to initialize its private structure. @source parameter may be NULL.
150 * @error_handler can not be NULL, but it will be returned an mail operation
151 * object without error handling capability.
153 ModestMailOperation* modest_mail_operation_new_with_error_handling (ModestMailOperationId id,
155 ErrorCheckingUserCallback error_handler);
157 * modest_mail_operation_get_id
158 * @self: a #ModestMailOperation
160 * Executes error handler, if it exists, passing @self objsect as
161 * user_data argument of error handling function.
164 modest_mail_operation_execute_error_handler (ModestMailOperation *self);
167 * modest_mail_operation_get_id
168 * @self: a #ModestMailOperation
170 * Gets the private id field of mail operation. This id identifies
171 * the class/type of mail operation.
173 ModestMailOperationId
174 modest_mail_operation_get_id (ModestMailOperation *self);
177 * modest_mail_operation_is_mine
178 * @self: a #ModestMailOperation
179 * @source: a #GObject to check if it have created @self operation.
181 * Check if @source object its owner of @self mail operation.
183 * returns: TRUE if source its owner, FALSE otherwise.
186 modest_mail_operation_is_mine (ModestMailOperation *self,
189 /* fill in other public functions, eg.: */
192 * modest_mail_operation_send_mail:
193 * @self: a #ModestMailOperation
194 * @transport_account: a non-NULL #TnyTransportAccount
195 * @msg: a non-NULL #TnyMsg
197 * Sends and already existing message using the provided
198 * #TnyTransportAccount. This operation is synchronous, so the
199 * #ModestMailOperation should not be added to any
200 * #ModestMailOperationQueue
202 void modest_mail_operation_send_mail (ModestMailOperation *self,
203 TnyTransportAccount *transport_account,
207 * modest_mail_operation_send_new_mail:
208 * @self: a #ModestMailOperation
209 * @transport_account: a non-NULL #TnyTransportAccount
210 * @from: the email address of the mail sender
211 * @to: a non-NULL email address of the mail receiver
212 * @cc: a comma-separated list of email addresses where to send a carbon copy
213 * @bcc: a comma-separated list of email addresses where to send a blind carbon copy
214 * @subject: the subject of the new mail
215 * @plain_body: the plain text body of the new mail.
216 * @html_body: the html version of the body of the new mail. If NULL, the mail will
217 * be sent with the plain body only.
218 * @attachments_list: a #GList of attachments, each attachment must be a #TnyMimePart
220 * Sends a new mail message using the provided
221 * #TnyTransportAccount. This operation is synchronous, so the
222 * #ModestMailOperation should not be added to any
223 * #ModestMailOperationQueue
225 void modest_mail_operation_send_new_mail (ModestMailOperation *self,
226 TnyTransportAccount *transport_account,
231 const gchar *subject,
232 const gchar *plain_body,
233 const gchar *html_body,
234 const GList *attachments_list,
235 TnyHeaderFlags priority_flags);
239 * modest_mail_operation_save_to_drafts:
240 * @self: a #ModestMailOperation
241 * @transport_account: a non-NULL #TnyTransportAccount
242 * @from: the email address of the mail sender
243 * @to: a non-NULL email address of the mail receiver
244 * @cc: a comma-separated list of email addresses where to send a carbon copy
245 * @bcc: a comma-separated list of email addresses where to send a blind carbon copy
246 * @subject: the subject of the new mail
247 * @plain_body: the plain text body of the new mail.
248 * @html_body: the html version of the body of the new mail. If NULL, the mail will
249 * be sent with the plain body only.
250 * @attachments_list: a #GList of attachments, each attachment must be a #TnyMimePart
252 * Save a mail message to drafts using the provided
253 * #TnyTransportAccount. This operation is synchronous, so the
254 * #ModestMailOperation should not be added to any
255 * #ModestMailOperationQueue
257 void modest_mail_operation_save_to_drafts (ModestMailOperation *self,
258 TnyTransportAccount *transport_account,
263 const gchar *subject,
264 const gchar *plain_body,
265 const gchar *html_body,
266 const GList *attachments_list,
267 TnyHeaderFlags priority_flags);
269 * modest_mail_operation_update_account:
270 * @self: a #ModestMailOperation
271 * @account_name: the id of a Modest account
273 * Asynchronously refreshes the root folders of the given store
274 * account. The caller should add the #ModestMailOperation to a
275 * #ModestMailOperationQueue and then free it. The caller will be
276 * notified by the "progress_changed" signal each time the progress of
277 * the operation changes.
280 * <informalexample><programlisting>
281 * queue = modest_tny_platform_factory_get_modest_mail_operation_queue_instance (fact)
282 * mail_op = modest_mail_operation_new ();
283 * g_signal_connect (G_OBJECT (mail_op), "progress_changed", G_CALLBACK(on_progress_changed), NULL);
284 * modest_mail_operation_queue_add (queue, mail_op);
285 * modest_mail_operation_update_account (mail_op, account_name)
286 * g_object_unref (G_OBJECT (mail_op));
287 * </programlisting></informalexample>
289 * Note that the account_name *MUST* be a modest account name, not a
290 * tinymail store account name
292 * Returns: TRUE if the mail operation could be started, or FALSE otherwise
294 gboolean modest_mail_operation_update_account (ModestMailOperation *self,
295 const gchar *account_name);
297 /* Functions that perform store operations */
300 * modest_mail_operation_create_folder:
301 * @self: a #ModestMailOperation
302 * @parent: the #TnyFolderStore which is the parent of the new folder
303 * @name: the non-NULL new name for the new folder
305 * Creates a new folder as a children of a existing one. If the store
306 * account supports subscriptions this method also sets the new folder
307 * as subscribed. This operation is synchronous, so the
308 * #ModestMailOperation should not be added to any
309 * #ModestMailOperationQueue
311 * Returns: a newly created #TnyFolder or NULL in case of error.
313 TnyFolder* modest_mail_operation_create_folder (ModestMailOperation *self,
314 TnyFolderStore *parent,
318 * modest_mail_operation_remove_folder:
319 * @self: a #ModestMailOperation
320 * @folder: a #TnyFolder
321 * @remove_to_trash: TRUE to move it to trash or FALSE to delete
324 * Removes a folder. This operation is synchronous, so the
325 * #ModestMailOperation should not be added to any
326 * #ModestMailOperationQueue
328 void modest_mail_operation_remove_folder (ModestMailOperation *self,
330 gboolean remove_to_trash);
333 * modest_mail_operation_rename_folder:
334 * @self: a #ModestMailOperation
335 * @folder: a #TnyFolder
336 * @name: a non-NULL name without "/"
338 * Renames a given folder with the provided new name. This operation
339 * is synchronous, so the #ModestMailOperation should not be added to
340 * any #ModestMailOperationQueue
342 void modest_mail_operation_rename_folder (ModestMailOperation *self,
347 * modest_mail_operation_xfer_folder:
348 * @self: a #ModestMailOperation
349 * @folder: a #TnyFolder
350 * @parent: the new parent of the folder as #TnyFolderStore
351 * @delete_original: wheter or not delete the original folder
353 * Sets the given @folder as child of a provided #TnyFolderStore. This
354 * operation also transfers all the messages contained in the folder
355 * and all of his children folders with their messages as well. This
356 * operation is synchronous, so the #ModestMailOperation should not be
357 * added to any #ModestMailOperationQueue.
359 * If @delete_original is TRUE this function moves the original
360 * folder, if it is FALSE the it just copies it
363 void modest_mail_operation_xfer_folder (ModestMailOperation *self,
365 TnyFolderStore *parent,
366 gboolean delete_original);
368 /* Functions that performs msg operations */
371 * modest_mail_operation_xfer_msgs:
372 * @self: a #ModestMailOperation
373 * @header_list: a #TnyList of #TnyHeader to transfer
374 * @folder: the #TnyFolder where the messages will be transferred
375 * @delete_original: whether or not delete the source messages
376 * @user_callback: a #XferMsgsAsynUserCallback function to call after tinymail callback execution.
377 * @user_data: generic user data which will be passed to @user_callback function.
379 * Asynchronously transfers messages from their current folder to
380 * another one. The caller should add the #ModestMailOperation to a
381 * #ModestMailOperationQueue and then free it. The caller will be
382 * notified by the "progress_changed" when the operation is completed.
384 * If the @delete_original paramter is TRUE then this function moves
385 * the messages between folders, otherwise it copies them.
388 * <informalexample><programlisting>
389 * queue = modest_tny_platform_factory_get_modest_mail_operation_queue_instance (fact);
390 * mail_op = modest_mail_operation_new ();
391 * modest_mail_operation_queue_add (queue, mail_op);
392 * g_signal_connect (G_OBJECT (mail_op), "progress_changed", G_CALLBACK(on_progress_changed), queue);
394 * modest_mail_operation_xfer_msg (mail_op, headers, folder, TRUE);
396 * g_object_unref (G_OBJECT (mail_op));
397 * </programlisting></informalexample>
400 void modest_mail_operation_xfer_msgs (ModestMailOperation *self,
401 TnyList *header_list,
403 gboolean delete_original,
404 XferMsgsAsynUserCallback user_callback,
408 * modest_mail_operation_remove_msg:
409 * @self: a #ModestMailOperation
410 * @header: the #TnyHeader of the message to move
411 * @remove_to_trash: TRUE to move it to trash or FALSE to delete it
414 * Deletes a message. This operation is synchronous, so the
415 * #ModestMailOperation should not be added to any
416 * #ModestMailOperationQueue
418 void modest_mail_operation_remove_msg (ModestMailOperation *self,
420 gboolean remove_to_trash);
423 * modest_mail_operation_get_msg:
424 * @self: a #ModestMailOperation
425 * @header_list: the #TnyHeader of the message to get
426 * @user_callback: a #GetMsgAsynUserCallback function to call after tinymail callback execution.
427 * @user_data: generic user data which will be passed to @user_callback function.
429 * Gets a message from header using an user defined @callback function
430 * pased as argument. This operation is asynchronous, so the
431 * #ModestMailOperation should be added to #ModestMailOperationQueue
433 void modest_mail_operation_get_msg (ModestMailOperation *self,
435 GetMsgAsynUserCallback user_callback,
438 * modest_mail_operation_get_msgs_full:
439 * @self: a #ModestMailOperation
440 * @header_list: a #TnyList of #TnyHeader objects to get and process
441 * @user_callback: a #TnyGetMsgCallback function to call after tinymail operation execution.
442 * @user_data: user data passed to both, user_callback and update_status_callback.
444 * Gets messages from headers list and process hem using @callback function
445 * pased as argument. This operation is asynchronous, so the
446 * #ModestMailOperation should be added to #ModestMailOperationQueue
448 void modest_mail_operation_get_msgs_full (ModestMailOperation *self,
449 TnyList *headers_list,
450 GetMsgAsynUserCallback user_callback,
452 GDestroyNotify notify);
454 /* Functions to control mail operations */
456 * modest_mail_operation_get_task_done:
457 * @self: a #ModestMailOperation
459 * Gets the amount of work done for a given mail operation. This
460 * amount of work is an absolute value.
462 * Returns: the amount of work completed
464 guint modest_mail_operation_get_task_done (ModestMailOperation *self);
467 * modest_mail_operation_get_task_total:
468 * @self: a #ModestMailOperation
470 * Gets the total amount of work that must be done to complete a given
471 * mail operation. This amount of work is an absolute value.
473 * Returns: the total required amount of work
475 guint modest_mail_operation_get_task_total (ModestMailOperation *self);
479 * modest_mail_operation_is_finished:
480 * @self: a #ModestMailOperation
482 * Checks if the operation is finished. A #ModestMailOperation is
483 * finished if it's in any of the following states:
484 * MODEST_MAIL_OPERATION_STATUS_SUCCESS,
485 * MODEST_MAIL_OPERATION_STATUS_FAILED,
486 * MODEST_MAIL_OPERATION_STATUS_CANCELED or
487 * MODEST_MAIL_OPERATION_STATUS_FINISHED_WITH_ERRORS
489 * Returns: TRUE if the operation is finished, FALSE otherwise
491 gboolean modest_mail_operation_is_finished (ModestMailOperation *self);
494 * modest_mail_operation_is_finished:
495 * @self: a #ModestMailOperation
497 * Gets the current status of the given mail operation
499 * Returns: the current status or MODEST_MAIL_OPERATION_STATUS_INVALID in case of error
501 ModestMailOperationStatus modest_mail_operation_get_status (ModestMailOperation *self);
504 * modest_mail_operation_get_error:
505 * @self: a #ModestMailOperation
507 * Gets the error associated to the mail operation if exists
509 * Returns: the #GError associated to the #ModestMailOperation if it
510 * exists or NULL otherwise
512 const GError* modest_mail_operation_get_error (ModestMailOperation *self);
515 * modest_mail_operation_cancel:
516 * @self: a #ModestMailOperation
518 * Cancels an active mail operation
520 * Returns: TRUE if the operation was succesfully canceled, FALSE otherwise
522 gboolean modest_mail_operation_cancel (ModestMailOperation *self);
525 * modest_mail_operation_refresh_folder
526 * @self: a #ModestMailOperation
527 * @folder: the #TnyFolder to refresh
529 * Refreshes the contents of a folder
531 void modest_mail_operation_refresh_folder (ModestMailOperation *self,
536 #endif /* __MODEST_MAIL_OPERATION_H__ */