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;
63 struct _ModestMailOperation {
65 /* insert public members, if any */
68 struct _ModestMailOperationClass {
69 GObjectClass parent_class;
72 void (*progress_changed) (ModestMailOperation *self, gpointer user_data);
75 /* member functions */
76 GType modest_mail_operation_get_type (void) G_GNUC_CONST;
78 /* typical parameter-less _new function */
79 ModestMailOperation* modest_mail_operation_new (void);
81 /* fill in other public functions, eg.: */
84 * modest_mail_operation_send_mail:
85 * @self: a #ModestMailOperation
86 * @transport_account: a non-NULL #TnyTransportAccount
87 * @msg: a non-NULL #TnyMsg
89 * Sends and already existing message using the provided
90 * #TnyTransportAccount. This operation is synchronous, so the
91 * #ModestMailOperation should not be added to any
92 * #ModestMailOperationQueue
94 void modest_mail_operation_send_mail (ModestMailOperation *self,
95 TnyTransportAccount *transport_account,
99 * modest_mail_operation_send_new_mail:
100 * @self: a #ModestMailOperation
101 * @transport_account: a non-NULL #TnyTransportAccount
102 * @from: the email address of the mail sender
103 * @to: a non-NULL email address of the mail receiver
104 * @cc: a comma-separated list of email addresses where to send a carbon copy
105 * @bcc: a comma-separated list of email addresses where to send a blind carbon copy
106 * @subject: the subject of the new mail
107 * @plain_body: the plain text body of the new mail.
108 * @html_body: the html version of the body of the new mail. If NULL, the mail will
109 * be sent with the plain body only.
110 * @attachments_list: a #GList of attachments, each attachment must be a #TnyMimePart
112 * Sends a new mail message using the provided
113 * #TnyTransportAccount. This operation is synchronous, so the
114 * #ModestMailOperation should not be added to any
115 * #ModestMailOperationQueue
117 void modest_mail_operation_send_new_mail (ModestMailOperation *self,
118 TnyTransportAccount *transport_account,
123 const gchar *subject,
124 const gchar *plain_body,
125 const gchar *html_body,
126 const GList *attachments_list,
127 TnyHeaderFlags priority_flags);
130 * modest_mail_operation_update_account:
131 * @self: a #ModestMailOperation
132 * @store_account: a #TnyStoreAccount
134 * Asynchronously refreshes the root folders of the given store
135 * account. The caller should add the #ModestMailOperation to a
136 * #ModestMailOperationQueue and then free it. The caller will be
137 * notified by the "progress_changed" signal each time the progress of
138 * the operation changes.
140 * Note that the store account passed as parametter will be freed by
141 * the mail operation so you must pass a new reference
144 * <informalexample><programlisting>
145 * queue = modest_tny_platform_factory_get_modest_mail_operation_queue_instance (fact)
146 * mail_op = modest_mail_operation_new ();
147 * g_signal_connect (G_OBJECT (mail_op), "progress_changed", G_CALLBACK(on_progress_changed), NULL);
148 * modest_mail_operation_queue_add (queue, mail_op);
149 * modest_mail_operation_update_account (mail_op, account)
150 * g_object_unref (G_OBJECT (mail_op));
151 * </programlisting></informalexample>
153 * Returns: TRUE if the mail operation could be started, or FALSE otherwise
155 gboolean modest_mail_operation_update_account (ModestMailOperation *self,
156 TnyStoreAccount *store_account);
158 /* Functions that perform store operations */
161 * modest_mail_operation_create_folder:
162 * @self: a #ModestMailOperation
163 * @parent: the #TnyFolderStore which is the parent of the new folder
164 * @name: the non-NULL new name for the new folder
166 * Creates a new folder as a children of a existing one. If the store
167 * account supports subscriptions this method also sets the new folder
168 * as subscribed. This operation is synchronous, so the
169 * #ModestMailOperation should not be added to any
170 * #ModestMailOperationQueue
172 * Returns: a newly created #TnyFolder or NULL in case of error.
174 TnyFolder* modest_mail_operation_create_folder (ModestMailOperation *self,
175 TnyFolderStore *parent,
179 * modest_mail_operation_remove_folder:
180 * @self: a #ModestMailOperation
181 * @folder: a #TnyFolder
182 * @remove_to_trash: TRUE to move it to trash or FALSE to delete
185 * Removes a folder. This operation is synchronous, so the
186 * #ModestMailOperation should not be added to any
187 * #ModestMailOperationQueue
189 void modest_mail_operation_remove_folder (ModestMailOperation *self,
191 gboolean remove_to_trash);
194 * modest_mail_operation_rename_folder:
195 * @self: a #ModestMailOperation
196 * @folder: a #TnyFolder
197 * @name: a non-NULL name without "/"
199 * Renames a given folder with the provided new name. This operation
200 * is synchronous, so the #ModestMailOperation should not be added to
201 * any #ModestMailOperationQueue
203 void modest_mail_operation_rename_folder (ModestMailOperation *self,
208 * modest_mail_operation_xfer_folder:
209 * @self: a #ModestMailOperation
210 * @folder: a #TnyFolder
211 * @parent: the new parent of the folder as #TnyFolderStore
212 * @delete_original: wheter or not delete the original folder
214 * Sets the given @folder as child of a provided #TnyFolderStore. This
215 * operation also transfers all the messages contained in the folder
216 * and all of his children folders with their messages as well. This
217 * operation is synchronous, so the #ModestMailOperation should not be
218 * added to any #ModestMailOperationQueue.
220 * If @delete_original is TRUE this function moves the original
221 * folder, if it is FALSE the it just copies it
223 * Returns: the newly transfered folder
225 TnyFolder* modest_mail_operation_xfer_folder (ModestMailOperation *self,
227 TnyFolderStore *parent,
228 gboolean delete_original);
231 /* Functions that performs msg operations */
234 * modest_mail_operation_xfer_msgs:
235 * @self: a #ModestMailOperation
236 * @header_list: a #TnyList of #TnyHeader to transfer
237 * @folder: the #TnyFolder where the messages will be transferred
238 * @delete_original: whether or not delete the source messages
240 * Asynchronously transfers messages from their current folder to
241 * another one. The caller should add the #ModestMailOperation to a
242 * #ModestMailOperationQueue and then free it. The caller will be
243 * notified by the "progress_changed" when the operation is completed.
245 * If the @delete_original paramter is TRUE then this function moves
246 * the messages between folders, otherwise it copies them.
249 * <informalexample><programlisting>
250 * queue = modest_tny_platform_factory_get_modest_mail_operation_queue_instance (fact);
251 * mail_op = modest_mail_operation_new ();
252 * modest_mail_operation_queue_add (queue, mail_op);
253 * g_signal_connect (G_OBJECT (mail_op), "progress_changed", G_CALLBACK(on_progress_changed), queue);
255 * modest_mail_operation_xfer_msg (mail_op, headers, folder, TRUE);
257 * g_object_unref (G_OBJECT (mail_op));
258 * </programlisting></informalexample>
261 void modest_mail_operation_xfer_msgs (ModestMailOperation *self,
262 TnyList *header_list,
264 gboolean delete_original);
267 * modest_mail_operation_remove_msg:
268 * @self: a #ModestMailOperation
269 * @header: the #TnyHeader of the message to move
270 * @remove_to_trash: TRUE to move it to trash or FALSE to delete it
273 * Deletes a message. This operation is synchronous, so the
274 * #ModestMailOperation should not be added to any
275 * #ModestMailOperationQueue
277 void modest_mail_operation_remove_msg (ModestMailOperation *self,
279 gboolean remove_to_trash);
281 /* Functions to control mail operations */
283 * modest_mail_operation_get_task_done:
284 * @self: a #ModestMailOperation
286 * Gets the amount of work done for a given mail operation. This
287 * amount of work is an absolute value.
289 * Returns: the amount of work completed
291 guint modest_mail_operation_get_task_done (ModestMailOperation *self);
294 * modest_mail_operation_get_task_total:
295 * @self: a #ModestMailOperation
297 * Gets the total amount of work that must be done to complete a given
298 * mail operation. This amount of work is an absolute value.
300 * Returns: the total required amount of work
302 guint modest_mail_operation_get_task_total (ModestMailOperation *self);
306 * modest_mail_operation_is_finished:
307 * @self: a #ModestMailOperation
309 * Checks if the operation is finished. A #ModestMailOperation is
310 * finished if it's in any of the following states:
311 * MODEST_MAIL_OPERATION_STATUS_SUCCESS,
312 * MODEST_MAIL_OPERATION_STATUS_FAILED,
313 * MODEST_MAIL_OPERATION_STATUS_CANCELED or
314 * MODEST_MAIL_OPERATION_STATUS_FINISHED_WITH_ERRORS
316 * Returns: TRUE if the operation is finished, FALSE otherwise
318 gboolean modest_mail_operation_is_finished (ModestMailOperation *self);
321 * modest_mail_operation_is_finished:
322 * @self: a #ModestMailOperation
324 * Gets the current status of the given mail operation
326 * Returns: the current status or MODEST_MAIL_OPERATION_STATUS_INVALID in case of error
328 ModestMailOperationStatus modest_mail_operation_get_status (ModestMailOperation *self);
331 * modest_mail_operation_get_error:
332 * @self: a #ModestMailOperation
334 * Gets the error associated to the mail operation if exists
336 * Returns: the #GError associated to the #ModestMailOperation if it
337 * exists or NULL otherwise
339 const GError* modest_mail_operation_get_error (ModestMailOperation *self);
342 * modest_mail_operation_cancel:
343 * @self: a #ModestMailOperation
345 * Cancels an active mail operation
347 * Returns: TRUE if the operation was succesfully canceled, FALSE otherwise
349 gboolean modest_mail_operation_cancel (ModestMailOperation *self);
352 * modest_mail_operation_refresh_folder
353 * @self: a #ModestMailOperation
354 * @folder: the #TnyFolder to refresh
356 * Refreshes the contents of a folder
358 void modest_mail_operation_refresh_folder (ModestMailOperation *self,
363 * This function is a workarround. It emits the progress-changed
364 * signal. It's used by the mail operation queue to notify the
365 * observers attached to that signal that the operation finished. We
366 * need to use that for the moment because tinymail does not give us
367 * the progress of a given operation very well. So we must delete it
368 * when tinymail has that functionality and remove the call to it in
371 void _modest_mail_operation_notify_end (ModestMailOperation *self);
375 #endif /* __MODEST_MAIL_OPERATION_H__ */