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 */
void (*progress_changed) (ModestMailOperation *self, gpointer user_data);
};
+/**
+ * GetMsgAsynUserCallback:
+ *
+ * @obj: a #GObject generic object which has created current mail operation.
+ * @msg: a #TnyMsg message retrieved by async operation.
+ * @user_data: generic data passed to user defined function.
+ *
+ * This function will be called after get_msg_cb private function, which is
+ * used as tinymail operation callback. The private function fills private
+ * fields of mail operation and calls user defined callback if it exists.
+ */
+typedef void (*GetMsgAsynUserCallback) (const GObject *obj, const TnyMsg *msg, gpointer user_data);
+
+
/* member functions */
GType modest_mail_operation_get_type (void) G_GNUC_CONST;
-/* typical parameter-less _new function */
-ModestMailOperation* modest_mail_operation_new_with_id (ModestMailOperationId id);
-ModestMailOperation* modest_mail_operation_new (void);
+/**
+ * modest_mail_operation_new:
+ * @id: a #ModestMailOperationId identification of operation type.
+ * @source: a #GObject which creates this new operation.
+ *
+ * Creates a new instance of class #ModestMailOperation, using parameters
+ * to initialize its private structure. @source parameter may be NULL.
+ **/
+ModestMailOperation* modest_mail_operation_new (ModestMailOperationId id,
+ GObject *source);
/**
* modest_mail_operation_get_id
*
* 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);
+/**
+ * modest_mail_operation_is_mine
+ * @self: a #ModestMailOperation
+ * @source: a #GObject to check if it have created @self operation.
+ *
+ * Check if @source object its owner of @self mail operation.
+ *
+ * returns: TRUE if source its owner, FALSE otherwise.
+ **/
+gboolean
+modest_mail_operation_is_mine (ModestMailOperation *self,
+ GObject *me);
+
/* fill in other public functions, eg.: */
/**
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
TnyHeader *header,
gboolean remove_to_trash);
+/**
+ * modest_mail_operation_get_msg:
+ * @self: a #ModestMailOperation
+ * @header_list: the #TnyHeader of the message to get
+ * @user_callback: a #GetMsgAsynUserCallback function to call after tinymail callback execution.
+ * @user_data: generic user data which will be passed to @user_callback function.
+ *
+ * Gets a message from header using an user defined @callback function
+ * pased as argument. This operation is asynchronous, so the
+ * #ModestMailOperation should be added to #ModestMailOperationQueue
+ **/
+void modest_mail_operation_get_msg (ModestMailOperation *self,
+ TnyHeader *header,
+ GetMsgAsynUserCallback user_callback,
+ gpointer user_data);
+/**
+ * modest_mail_operation_process_msg:
+ * @self: a #ModestMailOperation
+ * @header_list: a #TnyList of #TnyHeader objects to get and process
+ * @user_callback: a #TnyGetMsgCallback function to call after tinymail operation execution.
+ * @user_data: user data passed to both, user_callback and update_status_callback.
+ *
+ * Gets messages from headers list and process hem using @callback function
+ * pased as argument. This operation is asynchronous, so the
+ * #ModestMailOperation should be added to #ModestMailOperationQueue
+ **/
+void modest_mail_operation_process_msg (ModestMailOperation *self,
+ TnyList *headers_list,
+ GetMsgAsynUserCallback user_callback,
+ gpointer user_data);
+
/* Functions to control mail operations */
/**
* modest_mail_operation_get_task_done:
projects / modest / blobdiff