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;
77 struct _ModestMailOperation {
79 /* insert public members, if any */
82 struct _ModestMailOperationClass {
83 GObjectClass parent_class;
86 void (*progress_changed) (ModestMailOperation *self, gpointer user_data);
89 /* member functions */
90 GType modest_mail_operation_get_type (void) G_GNUC_CONST;
92 /* typical parameter-less _new function */
93 ModestMailOperation* modest_mail_operation_new (ModestMailOperationId id);
96 * modest_mail_operation_get_id
97 * @self: a #ModestMailOperation
99 * Gets the private id field of mail operation. This id identifies
100 * the class/type of mail operation.
102 ModestMailOperationId
103 modest_mail_operation_get_id (ModestMailOperation *self);
105 /* fill in other public functions, eg.: */
108 * modest_mail_operation_send_mail:
109 * @self: a #ModestMailOperation
110 * @transport_account: a non-NULL #TnyTransportAccount
111 * @msg: a non-NULL #TnyMsg
113 * Sends and already existing message using the provided
114 * #TnyTransportAccount. This operation is synchronous, so the
115 * #ModestMailOperation should not be added to any
116 * #ModestMailOperationQueue
118 void modest_mail_operation_send_mail (ModestMailOperation *self,
119 TnyTransportAccount *transport_account,
123 * modest_mail_operation_send_new_mail:
124 * @self: a #ModestMailOperation
125 * @transport_account: a non-NULL #TnyTransportAccount
126 * @from: the email address of the mail sender
127 * @to: a non-NULL email address of the mail receiver
128 * @cc: a comma-separated list of email addresses where to send a carbon copy
129 * @bcc: a comma-separated list of email addresses where to send a blind carbon copy
130 * @subject: the subject of the new mail
131 * @plain_body: the plain text body of the new mail.
132 * @html_body: the html version of the body of the new mail. If NULL, the mail will
133 * be sent with the plain body only.
134 * @attachments_list: a #GList of attachments, each attachment must be a #TnyMimePart
136 * Sends a new mail message using the provided
137 * #TnyTransportAccount. This operation is synchronous, so the
138 * #ModestMailOperation should not be added to any
139 * #ModestMailOperationQueue
141 void modest_mail_operation_send_new_mail (ModestMailOperation *self,
142 TnyTransportAccount *transport_account,
147 const gchar *subject,
148 const gchar *plain_body,
149 const gchar *html_body,
150 const GList *attachments_list,
151 TnyHeaderFlags priority_flags);
154 * modest_mail_operation_update_account:
155 * @self: a #ModestMailOperation
156 * @store_account: a #TnyStoreAccount
158 * Asynchronously refreshes the root folders of the given store
159 * account. The caller should add the #ModestMailOperation to a
160 * #ModestMailOperationQueue and then free it. The caller will be
161 * notified by the "progress_changed" signal each time the progress of
162 * the operation changes.
164 * Note that the store account passed as parametter will be freed by
165 * the mail operation so you must pass a new reference
168 * <informalexample><programlisting>
169 * queue = modest_tny_platform_factory_get_modest_mail_operation_queue_instance (fact)
170 * mail_op = modest_mail_operation_new ();
171 * g_signal_connect (G_OBJECT (mail_op), "progress_changed", G_CALLBACK(on_progress_changed), NULL);
172 * modest_mail_operation_queue_add (queue, mail_op);
173 * modest_mail_operation_update_account (mail_op, account)
174 * g_object_unref (G_OBJECT (mail_op));
175 * </programlisting></informalexample>
177 * Returns: TRUE if the mail operation could be started, or FALSE otherwise
179 gboolean modest_mail_operation_update_account (ModestMailOperation *self,
180 TnyStoreAccount *store_account);
182 /* Functions that perform store operations */
185 * modest_mail_operation_create_folder:
186 * @self: a #ModestMailOperation
187 * @parent: the #TnyFolderStore which is the parent of the new folder
188 * @name: the non-NULL new name for the new folder
190 * Creates a new folder as a children of a existing one. If the store
191 * account supports subscriptions this method also sets the new folder
192 * as subscribed. This operation is synchronous, so the
193 * #ModestMailOperation should not be added to any
194 * #ModestMailOperationQueue
196 * Returns: a newly created #TnyFolder or NULL in case of error.
198 TnyFolder* modest_mail_operation_create_folder (ModestMailOperation *self,
199 TnyFolderStore *parent,
203 * modest_mail_operation_remove_folder:
204 * @self: a #ModestMailOperation
205 * @folder: a #TnyFolder
206 * @remove_to_trash: TRUE to move it to trash or FALSE to delete
209 * Removes a folder. This operation is synchronous, so the
210 * #ModestMailOperation should not be added to any
211 * #ModestMailOperationQueue
213 void modest_mail_operation_remove_folder (ModestMailOperation *self,
215 gboolean remove_to_trash);
218 * modest_mail_operation_rename_folder:
219 * @self: a #ModestMailOperation
220 * @folder: a #TnyFolder
221 * @name: a non-NULL name without "/"
223 * Renames a given folder with the provided new name. This operation
224 * is synchronous, so the #ModestMailOperation should not be added to
225 * any #ModestMailOperationQueue
227 void modest_mail_operation_rename_folder (ModestMailOperation *self,
232 * modest_mail_operation_xfer_folder:
233 * @self: a #ModestMailOperation
234 * @folder: a #TnyFolder
235 * @parent: the new parent of the folder as #TnyFolderStore
236 * @delete_original: wheter or not delete the original folder
238 * Sets the given @folder as child of a provided #TnyFolderStore. This
239 * operation also transfers all the messages contained in the folder
240 * and all of his children folders with their messages as well. This
241 * operation is synchronous, so the #ModestMailOperation should not be
242 * added to any #ModestMailOperationQueue.
244 * If @delete_original is TRUE this function moves the original
245 * folder, if it is FALSE the it just copies it
247 * Returns: the newly transfered folder
249 TnyFolder* modest_mail_operation_xfer_folder (ModestMailOperation *self,
251 TnyFolderStore *parent,
252 gboolean delete_original);
255 /* Functions that performs msg operations */
258 * modest_mail_operation_xfer_msgs:
259 * @self: a #ModestMailOperation
260 * @header_list: a #TnyList of #TnyHeader to transfer
261 * @folder: the #TnyFolder where the messages will be transferred
262 * @delete_original: whether or not delete the source messages
264 * Asynchronously transfers messages from their current folder to
265 * another one. The caller should add the #ModestMailOperation to a
266 * #ModestMailOperationQueue and then free it. The caller will be
267 * notified by the "progress_changed" when the operation is completed.
269 * If the @delete_original paramter is TRUE then this function moves
270 * the messages between folders, otherwise it copies them.
273 * <informalexample><programlisting>
274 * queue = modest_tny_platform_factory_get_modest_mail_operation_queue_instance (fact);
275 * mail_op = modest_mail_operation_new ();
276 * modest_mail_operation_queue_add (queue, mail_op);
277 * g_signal_connect (G_OBJECT (mail_op), "progress_changed", G_CALLBACK(on_progress_changed), queue);
279 * modest_mail_operation_xfer_msg (mail_op, headers, folder, TRUE);
281 * g_object_unref (G_OBJECT (mail_op));
282 * </programlisting></informalexample>
285 void modest_mail_operation_xfer_msgs (ModestMailOperation *self,
286 TnyList *header_list,
288 gboolean delete_original);
291 * modest_mail_operation_remove_msg:
292 * @self: a #ModestMailOperation
293 * @header: the #TnyHeader of the message to move
294 * @remove_to_trash: TRUE to move it to trash or FALSE to delete it
297 * Deletes a message. This operation is synchronous, so the
298 * #ModestMailOperation should not be added to any
299 * #ModestMailOperationQueue
301 void modest_mail_operation_remove_msg (ModestMailOperation *self,
303 gboolean remove_to_trash);
305 /* Functions to control mail operations */
307 * modest_mail_operation_get_task_done:
308 * @self: a #ModestMailOperation
310 * Gets the amount of work done for a given mail operation. This
311 * amount of work is an absolute value.
313 * Returns: the amount of work completed
315 guint modest_mail_operation_get_task_done (ModestMailOperation *self);
318 * modest_mail_operation_get_task_total:
319 * @self: a #ModestMailOperation
321 * Gets the total amount of work that must be done to complete a given
322 * mail operation. This amount of work is an absolute value.
324 * Returns: the total required amount of work
326 guint modest_mail_operation_get_task_total (ModestMailOperation *self);
330 * modest_mail_operation_is_finished:
331 * @self: a #ModestMailOperation
333 * Checks if the operation is finished. A #ModestMailOperation is
334 * finished if it's in any of the following states:
335 * MODEST_MAIL_OPERATION_STATUS_SUCCESS,
336 * MODEST_MAIL_OPERATION_STATUS_FAILED,
337 * MODEST_MAIL_OPERATION_STATUS_CANCELED or
338 * MODEST_MAIL_OPERATION_STATUS_FINISHED_WITH_ERRORS
340 * Returns: TRUE if the operation is finished, FALSE otherwise
342 gboolean modest_mail_operation_is_finished (ModestMailOperation *self);
345 * modest_mail_operation_is_finished:
346 * @self: a #ModestMailOperation
348 * Gets the current status of the given mail operation
350 * Returns: the current status or MODEST_MAIL_OPERATION_STATUS_INVALID in case of error
352 ModestMailOperationStatus modest_mail_operation_get_status (ModestMailOperation *self);
355 * modest_mail_operation_get_error:
356 * @self: a #ModestMailOperation
358 * Gets the error associated to the mail operation if exists
360 * Returns: the #GError associated to the #ModestMailOperation if it
361 * exists or NULL otherwise
363 const GError* modest_mail_operation_get_error (ModestMailOperation *self);
366 * modest_mail_operation_cancel:
367 * @self: a #ModestMailOperation
369 * Cancels an active mail operation
371 * Returns: TRUE if the operation was succesfully canceled, FALSE otherwise
373 gboolean modest_mail_operation_cancel (ModestMailOperation *self);
376 * modest_mail_operation_refresh_folder
377 * @self: a #ModestMailOperation
378 * @folder: the #TnyFolder to refresh
380 * Refreshes the contents of a folder
382 void modest_mail_operation_refresh_folder (ModestMailOperation *self,
387 * This function is a workarround. It emits the progress-changed
388 * signal. It's used by the mail operation queue to notify the
389 * observers attached to that signal that the operation finished. We
390 * need to use that for the moment because tinymail does not give us
391 * the progress of a given operation very well. So we must delete it
392 * when tinymail has that functionality and remove the call to it in
395 void _modest_mail_operation_notify_end (ModestMailOperation *self);
399 #endif /* __MODEST_MAIL_OPERATION_H__ */