X-Git-Url: http://git.maemo.org/git/?a=blobdiff_plain;f=src%2Fmodest-mail-operation.h;h=d2739b9a85165d42fe1f6c0234effc459a3645c4;hb=84c2681caafc791433135f704227111272e45203;hp=c3ec8d2afcbfee4038bcc9b4e3a272cecae86beb;hpb=c2c60d8c88aa180b656a1b932ea695185f7f3f6e;p=modest
diff --git a/src/modest-mail-operation.h b/src/modest-mail-operation.h
index c3ec8d2..d2739b9 100644
--- a/src/modest-mail-operation.h
+++ b/src/modest-mail-operation.h
@@ -60,6 +60,20 @@ typedef enum _ModestMailOperationStatus {
MODEST_MAIL_OPERATION_STATUS_CANCELED
} ModestMailOperationStatus;
+/**
+ * ModestMailOperationId:
+ *
+ * The id for identifying the type of mail operation
+ */
+typedef enum _ModestMailOperationId {
+ MODEST_MAIL_OPERATION_ID_SEND,
+ MODEST_MAIL_OPERATION_ID_RECEIVE,
+ MODEST_MAIL_OPERATION_ID_OPEN,
+ MODEST_MAIL_OPERATION_ID_DELETE,
+ MODEST_MAIL_OPERATION_ID_INFO,
+ MODEST_MAIL_OPERATION_ID_UNKNOWN,
+} ModestMailOperationId;
+
struct _ModestMailOperation {
GObject parent;
/* insert public members, if any */
@@ -76,7 +90,17 @@ struct _ModestMailOperationClass {
GType modest_mail_operation_get_type (void) G_GNUC_CONST;
/* typical parameter-less _new function */
-ModestMailOperation* modest_mail_operation_new (void);
+ModestMailOperation* modest_mail_operation_new (ModestMailOperationId id);
+
+/**
+ * modest_mail_operation_get_id
+ * @self: a #ModestMailOperation
+ *
+ * Gets the private id field of mail operation. This id identifies
+ * the class/type of mail operation.
+ **/
+ModestMailOperationId
+modest_mail_operation_get_id (ModestMailOperation *self);
/* fill in other public functions, eg.: */
@@ -104,7 +128,9 @@ void modest_mail_operation_send_mail (ModestMailOperation *self,
* @cc: a comma-separated list of email addresses where to send a carbon copy
* @bcc: a comma-separated list of email addresses where to send a blind carbon copy
* @subject: the subject of the new mail
- * @body: the body of the new mail
+ * @plain_body: the plain text body of the new mail.
+ * @html_body: the html version of the body of the new mail. If NULL, the mail will
+ * be sent with the plain body only.
* @attachments_list: a #GList of attachments, each attachment must be a #TnyMimePart
*
* Sends a new mail message using the provided
@@ -119,10 +145,43 @@ void modest_mail_operation_send_new_mail (ModestMailOperation *self,
const gchar *cc,
const gchar *bcc,
const gchar *subject,
- const gchar *body,
- const GList *attachments_list);
+ const gchar *plain_body,
+ const gchar *html_body,
+ const GList *attachments_list,
+ TnyHeaderFlags priority_flags);
+
/**
+ * modest_mail_operation_save_to_drafts:
+ * @self: a #ModestMailOperation
+ * @transport_account: a non-NULL #TnyTransportAccount
+ * @from: the email address of the mail sender
+ * @to: a non-NULL email address of the mail receiver
+ * @cc: a comma-separated list of email addresses where to send a carbon copy
+ * @bcc: a comma-separated list of email addresses where to send a blind carbon copy
+ * @subject: the subject of the new mail
+ * @plain_body: the plain text body of the new mail.
+ * @html_body: the html version of the body of the new mail. If NULL, the mail will
+ * be sent with the plain body only.
+ * @attachments_list: a #GList of attachments, each attachment must be a #TnyMimePart
+ *
+ * Save a mail message to drafts using the provided
+ * #TnyTransportAccount. This operation is synchronous, so the
+ * #ModestMailOperation should not be added to any
+ * #ModestMailOperationQueue
+ **/
+void modest_mail_operation_save_to_drafts (ModestMailOperation *self,
+ TnyTransportAccount *transport_account,
+ const gchar *from,
+ const gchar *to,
+ const gchar *cc,
+ const gchar *bcc,
+ const gchar *subject,
+ const gchar *plain_body,
+ const gchar *html_body,
+ const GList *attachments_list,
+ TnyHeaderFlags priority_flags);
+/**
* modest_mail_operation_update_account:
* @self: a #ModestMailOperation
* @store_account: a #TnyStoreAccount
@@ -132,15 +191,17 @@ void modest_mail_operation_send_new_mail (ModestMailOperation *self,
* #ModestMailOperationQueue and then free it. The caller will be
* notified by the "progress_changed" signal each time the progress of
* the operation changes.
+ *
+ * Note that the store account passed as parametter will be freed by
+ * the mail operation so you must pass a new reference
+ *
* Example
*
* queue = modest_tny_platform_factory_get_modest_mail_operation_queue_instance (fact)
* mail_op = modest_mail_operation_new ();
- * g_signal_connect (G_OBJECT (mail_op), "progress_changed", G_CALLBACK(on_progress_changed), queue);
- * if (modest_mail_operation_update_account (mail_op, account))
- * {
- * modest_mail_operation_queue_add (queue, mail_op);
- * }
+ * g_signal_connect (G_OBJECT (mail_op), "progress_changed", G_CALLBACK(on_progress_changed), NULL);
+ * modest_mail_operation_queue_add (queue, mail_op);
+ * modest_mail_operation_update_account (mail_op, account)
* g_object_unref (G_OBJECT (mail_op));
*
*
@@ -225,36 +286,35 @@ TnyFolder* modest_mail_operation_xfer_folder (ModestMailOperation *self,
/* Functions that performs msg operations */
/**
- * modest_mail_operation_xfer_msg:
+ * modest_mail_operation_xfer_msgs:
* @self: a #ModestMailOperation
- * @header: the #TnyHeader of the message to move
- * @folder: the #TnyFolder where the message will be moved
- * @delete_original: whether or not delete the source message
+ * @header_list: a #TnyList of #TnyHeader to transfer
+ * @folder: the #TnyFolder where the messages will be transferred
+ * @delete_original: whether or not delete the source messages
*
- * Asynchronously transfers a message from its current folder to
+ * Asynchronously transfers messages from their current folder to
* another one. The caller should add the #ModestMailOperation to a
* #ModestMailOperationQueue and then free it. The caller will be
* notified by the "progress_changed" when the operation is completed.
*
* If the @delete_original paramter is TRUE then this function moves
- * the message between folders, otherwise it copies it.
+ * the messages between folders, otherwise it copies them.
*
* Example
*
* queue = modest_tny_platform_factory_get_modest_mail_operation_queue_instance (fact);
* mail_op = modest_mail_operation_new ();
- * if (modest_mail_operation_xfer_msg (mail_op, header, folder, TRUE))
- * {
- * g_signal_connect (G_OBJECT (mail_op), "progress_changed", G_CALLBACK(on_progress_changed), queue);
- * modest_mail_operation_queue_add (queue, mail_op);
- * }
+ * modest_mail_operation_queue_add (queue, mail_op);
+ * g_signal_connect (G_OBJECT (mail_op), "progress_changed", G_CALLBACK(on_progress_changed), queue);
+ *
+ * modest_mail_operation_xfer_msg (mail_op, headers, folder, TRUE);
+ *
* g_object_unref (G_OBJECT (mail_op));
*
*
- * Returns: TRUE if the mail operation could be started, or FALSE otherwise
**/
-gboolean modest_mail_operation_xfer_msg (ModestMailOperation *self,
- TnyHeader *header,
+void modest_mail_operation_xfer_msgs (ModestMailOperation *self,
+ TnyList *header_list,
TnyFolder *folder,
gboolean delete_original);
@@ -310,7 +370,7 @@ guint modest_mail_operation_get_task_total (ModestMailOperation *self);
*
* Returns: TRUE if the operation is finished, FALSE otherwise
**/
-gboolean modest_mail_operation_is_finished (ModestMailOperation *self);
+gboolean modest_mail_operation_is_finished (ModestMailOperation *self);
/**
* modest_mail_operation_is_finished:
@@ -341,7 +401,29 @@ const GError* modest_mail_operation_get_error (ModestMailOperation
*
* Returns: TRUE if the operation was succesfully canceled, FALSE otherwise
**/
-gboolean modest_mail_operation_cancel (ModestMailOperation *self);
+gboolean modest_mail_operation_cancel (ModestMailOperation *self);
+
+/**
+ * modest_mail_operation_refresh_folder
+ * @self: a #ModestMailOperation
+ * @folder: the #TnyFolder to refresh
+ *
+ * Refreshes the contents of a folder
+ */
+void modest_mail_operation_refresh_folder (ModestMailOperation *self,
+ TnyFolder *folder);
+
+/**
+ *
+ * This function is a workarround. It emits the progress-changed
+ * signal. It's used by the mail operation queue to notify the
+ * observers attached to that signal that the operation finished. We
+ * need to use that for the moment because tinymail does not give us
+ * the progress of a given operation very well. So we must delete it
+ * when tinymail has that functionality and remove the call to it in
+ * the queue as well.
+ */
+void _modest_mail_operation_notify_end (ModestMailOperation *self);
G_END_DECLS