#include <tny-transport-account.h>
#include <tny-folder-store.h>
+#include <modest-tny-send-queue.h>
+#include <modest-tny-account-store.h>
G_BEGIN_DECLS
typedef enum {
MODEST_MAIL_OPERATION_TYPE_SEND,
MODEST_MAIL_OPERATION_TYPE_RECEIVE,
+ MODEST_MAIL_OPERATION_TYPE_SEND_AND_RECEIVE,
MODEST_MAIL_OPERATION_TYPE_OPEN,
MODEST_MAIL_OPERATION_TYPE_DELETE,
MODEST_MAIL_OPERATION_TYPE_INFO,
+ MODEST_MAIL_OPERATION_TYPE_RUN_QUEUE,
+ MODEST_MAIL_OPERATION_TYPE_SYNC_FOLDER,
+ MODEST_MAIL_OPERATION_TYPE_SHUTDOWN,
+ MODEST_MAIL_OPERATION_TYPE_QUEUE_WAKEUP,
MODEST_MAIL_OPERATION_TYPE_UNKNOWN,
} ModestMailOperationTypeOperation;
/**
- * ErrorCheckingAsyncUserCallback:
+ * ErrorCheckingUserCallback:
*
* @mail_op: the current mail operation.
* @user_data: generic data passed to user defined function.
typedef void (*ErrorCheckingUserCallback) (ModestMailOperation *mail_op, gpointer user_data);
/**
+ * ErrorCheckingUserDataDestroyer:
+ *
+ * @user_data: generic data passed to user defined function.
+ *
+ * This function is used to destroy the user_data passed to the error
+ * checking user callback function
+ */
+typedef void (*ErrorCheckingUserDataDestroyer) (gpointer user_data);
+
+
+/**
* GetMsgAsyncUserCallback:
*
- * @obj: a #GObject generic object which has created current mail operation.
+ * @mail_op: the current #ModestMailOperation.
+ * @header: a #TnyHeader summary item.
* @msg: a #TnyMsg message retrieved by async operation.
* @user_data: generic data passed to user defined function.
*
*/
typedef void (*GetMsgAsyncUserCallback) (ModestMailOperation *mail_op,
TnyHeader *header,
+ gboolean canceled,
TnyMsg *msg,
+ GError *err,
gpointer user_data);
/**
- * XferMsgAsynUserCallback:
+ * GetMimePartSizeCallback:
+ *
+ * @mail_op: the current #ModestMailOperation.
+ * @size: size of the attachment
+ * @user_data: generic data passed to user defined function.
+ *
+ */
+typedef void (*GetMimePartSizeCallback) (ModestMailOperation *mail_op,
+ gssize size,
+ gpointer user_data);
+
+/**
+ * XferMsgsAsyncUserCallback:
*
* @obj: a #GObject generic object which has created current mail operation.
+ * @new_folder: the new instance of the #TnyFolder that has been transferred
* @user_data: generic data passed to user defined function.
*
* This function will be called after transfer_msgs_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 (*XferMsgsAsynUserCallback) (const GObject *obj, gpointer user_data);
+typedef void (*XferMsgsAsyncUserCallback) (ModestMailOperation *mail_op,
+ gpointer user_data);
+
+
+/**
+ * XferFolderAsyncUserCallback:
+ *
+ * @obj: a #GObject generic object which has created current mail operation.
+ * @new_folder: the new instance of the #TnyFolder that has been transferred
+ * @user_data: generic data passed to user defined function.
+ *
+ * This function will be called after transfer_msgs_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 (*XferFolderAsyncUserCallback) (ModestMailOperation *mail_op,
+ TnyFolder *new_folder,
+ gpointer user_data);
+
+
+/**
+ * RefreshAsyncUserCallback:
+ *
+ * @mail_op: the current #ModestMailOperation.
+ * @folder: a #TnyFolder which has been refreshed .
+ * @user_data: generic data passed to user defined function.
+ *
+ * This function will be called after refresh_folder_async_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 (*RefreshAsyncUserCallback) (ModestMailOperation *mail_op,
+ TnyFolder *folder,
+ gpointer user_data);
+/**
+ * UpdateAccountCallback:
+ *
+ * @self: a #ModestMailOperation
+ * @new_headers: the list of new headers received
+ * @user_data: generic data passed to user defined function.
+ *
+ * This is the callback of the update_account operation. It informs
+ * the caller about the amount of new messages that have been
+ * downloaded
+ */
+typedef void (*UpdateAccountCallback) (ModestMailOperation *self,
+ TnyList *new_headers,
+ gpointer user_data);
+
+/**
+ * SaveToDraftsCallback:
+ *
+ * @self: a #ModestMailOperation
+ * @saved_draft: the new draft message that has been saved
+ * @user_data: generic data passed to user defined function.
+ *
+ * This is the callback of the save_to_drafts operation. It returns
+ * the newly created msg stored in the Drafts folder
+ */
+typedef void (*SaveToDraftstCallback) (ModestMailOperation *self,
+ TnyMsg *saved_draft,
+ gpointer user_data);
+
+
+typedef gboolean (*RetrieveAllCallback) (GObject *source,
+ guint num_msgs,
+ guint limit);
+
+/**
+ * CreateFolderUserCallback:
+ *
+ * @mail_op: the current #ModestMailOperation.
+ * @folder: a #TnyFolder summary item.
+ * @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 (*CreateFolderUserCallback) (ModestMailOperation *mail_op,
+ TnyFolderStore *parent_folder,
+ TnyFolder *new_folder,
+ gpointer user_data);
/* This struct represents the internal state of a mail operation in a
given time */
typedef struct {
guint done;
guint total;
+ gdouble bytes_done;
+ gdouble bytes_total;
gboolean finished;
ModestMailOperationStatus status;
ModestMailOperationTypeOperation op_type;
/* Signals */
void (*progress_changed) (ModestMailOperation *self, ModestMailOperationState *state, gpointer user_data);
+ void (*operation_started) (ModestMailOperation *self, gpointer user_data);
+ void (*operation_finished) (ModestMailOperation *self, gpointer user_data);
};
/* member functions */
/**
* 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 (ModestMailOperationTypeOperation type,
- GObject *source);
+ModestMailOperation* modest_mail_operation_new (GObject *source);
/**
* modest_mail_operation_new_with_error_handling:
* @error_handler can not be NULL, but it will be returned an mail operation
* object without error handling capability.
**/
-ModestMailOperation* modest_mail_operation_new_with_error_handling (ModestMailOperationTypeOperation op_type,
- GObject *source,
+ModestMailOperation* modest_mail_operation_new_with_error_handling (GObject *source,
ErrorCheckingUserCallback error_handler,
- gpointer user_data);
+ gpointer user_data,
+ ErrorCheckingUserDataDestroyer error_handler_destroyer);
/**
* modest_mail_operation_execute_error_handler
* @self: a #ModestMailOperation
* modest_mail_operation_send_new_mail:
* @self: a #ModestMailOperation
* @transport_account: a non-NULL #TnyTransportAccount
+ * @draft_msg: a #TnyMsg of the origin draft message, if any
* @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
* @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
+ * @images_list: a #GList of image attachments, each attachment must be a #TnyMimePart
*
* Sends a new mail message using the provided
* #TnyTransportAccount. This operation is synchronous, so the
**/
void modest_mail_operation_send_new_mail (ModestMailOperation *self,
TnyTransportAccount *transport_account,
+ TnyMsg *draft_msg,
const gchar *from,
const gchar *to,
const gchar *cc,
const gchar *plain_body,
const gchar *html_body,
const GList *attachments_list,
+ const GList *images_list,
+ const gchar *references,
+ const gchar *in_reply_to,
TnyHeaderFlags priority_flags);
* modest_mail_operation_save_to_drafts:
* @self: a #ModestMailOperation
* @transport_account: a non-NULL #TnyTransportAccount
+ * @draft_msg: the previous draft message, in case it's an update
+ * to an existing draft.
* @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
* @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
- *
+ * @images_list: a #GList of image attachments, each attachment must be a #TnyMimePart
+ * @callback: the user callback, will be called when the operation finishes
+ * @user_data: data that will be passed to the user callback
+ *
* Save a mail message to drafts using the provided
- * #TnyTransportAccount. This operation is synchronous, so the
- * #ModestMailOperation should not be added to any
- * #ModestMailOperationQueue
+ * #TnyTransportAccount. This operation is asynchronous.
+ *
**/
-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);
+void modest_mail_operation_save_to_drafts (ModestMailOperation *self,
+ TnyTransportAccount *transport_account,
+ TnyMsg *draft_msg,
+ 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,
+ const GList *images_list,
+ TnyHeaderFlags priority_flags,
+ const gchar *references,
+ const gchar *in_reply_to,
+ SaveToDraftstCallback callback,
+ gpointer user_data);
/**
* modest_mail_operation_update_account:
* @self: a #ModestMailOperation
* @account_name: the id of a Modest account
+ * @poke_all: if TRUE it will also do a poke_status over all folders of the account
+ * @interactive: if TRUE the update account was scheduled by an interactive send receive
*
* Asynchronously refreshes the root folders of the given store
* account. The caller should add the #ModestMailOperation to a
* Note that the account_name *MUST* be a modest account name, not a
* tinymail store account name
*
- * Returns: TRUE if the mail operation could be started, or FALSE otherwise
**/
-gboolean modest_mail_operation_update_account (ModestMailOperation *self,
- const gchar *account_name);
+void modest_mail_operation_update_account (ModestMailOperation *self,
+ const gchar *account_name,
+ gboolean poke_all,
+ gboolean interactive,
+ RetrieveAllCallback retrieve_all_cb,
+ UpdateAccountCallback callback,
+ gpointer user_data);
/* Functions that perform store operations */
*
* Returns: a newly created #TnyFolder or NULL in case of error.
**/
-TnyFolder* modest_mail_operation_create_folder (ModestMailOperation *self,
- TnyFolderStore *parent,
- const gchar *name);
+void modest_mail_operation_create_folder (ModestMailOperation *self,
+ TnyFolderStore *parent,
+ const gchar *name,
+ CreateFolderUserCallback callback,
+ gpointer user_data);
/**
* modest_mail_operation_remove_folder:
**/
void modest_mail_operation_rename_folder (ModestMailOperation *self,
TnyFolder *folder,
- const gchar *name);
+ const gchar *name,
+ XferFolderAsyncUserCallback user_callback,
+ gpointer user_data);
/**
* modest_mail_operation_xfer_folder:
* @folder: a #TnyFolder
* @parent: the new parent of the folder as #TnyFolderStore
* @delete_original: wheter or not delete the original folder
+ * @user_callback: a #XferFolderAsyncUserCallback function to call after tinymail callback execution.
+ * @user_data: generic user data which will be passed to @user_callback function.
*
* Sets the given @folder as child of a provided #TnyFolderStore. This
* operation also transfers all the messages contained in the folder
void modest_mail_operation_xfer_folder (ModestMailOperation *self,
TnyFolder *folder,
TnyFolderStore *parent,
- gboolean delete_original);
+ gboolean delete_original,
+ XferFolderAsyncUserCallback user_callback,
+ gpointer user_data);
+
/* Functions that performs msg operations */
* @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
- * @user_callback: a #XferMsgsAsynUserCallback function to call after tinymail callback execution.
+ * @user_callback: a #XferFolderAsyncUserCallback function to call after tinymail callback execution.
* @user_data: generic user data which will be passed to @user_callback function.
*
* Asynchronously transfers messages from their current folder to
TnyList *header_list,
TnyFolder *folder,
gboolean delete_original,
- XferMsgsAsynUserCallback user_callback,
+ XferMsgsAsyncUserCallback user_callback,
gpointer user_data);
/**
- * modest_mail_operation_remove_msg:
+ * modest_mail_operation_remove_msgs:
* @self: a #ModestMailOperation
- * @header: the #TnyHeader of the message to move
+ * @headers: the #TnyList of the messages to delete
* @remove_to_trash: TRUE to move it to trash or FALSE to delete it
* permanently
*
- * Deletes a message. This operation is synchronous, so the
- * #ModestMailOperation should not be added to any
- * #ModestMailOperationQueue
+ * Deletes a list of messages.
**/
-void modest_mail_operation_remove_msg (ModestMailOperation *self,
- TnyHeader *header,
- gboolean remove_to_trash);
+void modest_mail_operation_remove_msgs (ModestMailOperation *self,
+ TnyList *headers,
+ gboolean remove_to_trash);
/**
* modest_mail_operation_get_msg:
* @self: a #ModestMailOperation
* @header_list: the #TnyHeader of the message to get
+ * @progress_feedback: a #gboolean. If %TRUE, we'll get progress bar feedback.
* @user_callback: a #GetMsgAsyncUserCallback function to call after tinymail callback execution.
* @user_data: generic user data which will be passed to @user_callback function.
*
* #ModestMailOperation should be added to #ModestMailOperationQueue
**/
void modest_mail_operation_get_msg (ModestMailOperation *self,
- TnyHeader *header,
+ TnyHeader *header,
+ gboolean progress_feedback,
GetMsgAsyncUserCallback user_callback,
gpointer user_data);
/**
+ * modest_mail_operation_find_msg:
+ * @self: a #ModestMailOperation
+ * @msg_uid: a string
+ * @progress_feedback: a #gboolean. If %TRUE, we'll get progress bar feedback.
+ * @user_callback: a #GetMsgAsyncUserCallback function to call after tinymail callback execution.
+ * @user_data: generic user data which will be passed to @user_callback function.
+ *
+ * Gets a message from a uid 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_find_msg (ModestMailOperation *self,
+ TnyFolder *folder,
+ const gchar *msg_uid,
+ gboolean progress_feedback,
+ GetMsgAsyncUserCallback user_callback,
+ gpointer user_data);
+
+/**
* modest_mail_operation_get_msgs_full:
* @self: a #ModestMailOperation
* @header_list: a #TnyList of #TnyHeader objects to get and process
gpointer user_data,
GDestroyNotify notify);
+/**
+ * modest_mail_operation_run_queue:
+ * @self: a #ModestMailOperation
+ * @queue: a #ModestTnySendQueue
+ *
+ * This mail operation is special. It should be running every time the send queue
+ * is running (after queue-start), and we should notify end of the operation
+ * after queue-end. Then, we should only set this queue on queue-start signal, and
+ * it will clean up the operation (notify end) on queue-end.
+ */
+void modest_mail_operation_run_queue (ModestMailOperation *self,
+ ModestTnySendQueue *queue);
+
+/**
+ * modest_mail_operation_queue_wakeup:
+ * @self: a #ModestMailOperation
+ * @queue: a #ModestTnySendQueue
+ *
+ * This mail operation is special. It should be running every time the send queue
+ * wakeup is running and we should notify end of the operation
+ * after wakeup has done msg-sent notification.
+ */
+void modest_mail_operation_queue_wakeup (ModestMailOperation *self,
+ ModestTnySendQueue *queue);
+
+/**
+ * modest_mail_operation_sync_folder:
+ * @self: a #ModestMailOperation
+ * @folder: a #TnyFolder
+ * @expunge: a #gboolean
+ *
+ * mail operation wrapper around tny_folder_sync () method, to keep modest
+ * running while we do that sync operation.
+ */
+void modest_mail_operation_sync_folder (ModestMailOperation *self,
+ TnyFolder *folder, gboolean expunge);
+
+/**
+ * modest_mail_operation_shutdown:
+ * @self: a #ModestMailOperation
+ * @account_store: a #ModestTnyAccountStore
+ *
+ * disconnects all accounts in the account store (doing the proper syncs).
+ */
+void modest_mail_operation_shutdown (ModestMailOperation *self,
+ ModestTnyAccountStore *account_store);
+
/* Functions to control mail operations */
/**
* modest_mail_operation_get_task_done:
* modest_mail_operation_refresh_folder
* @self: a #ModestMailOperation
* @folder: the #TnyFolder to refresh
+ * @user_callback: the #RefreshAsyncUserCallback function to be called
+ * after internal refresh async callback was being executed.
*
- * Refreshes the contents of a folder
+ * Refreshes the contents of a folder. After internal callback was executed,
+ * and all interna mail operation field were filled, if exists, it calls an
+ * user callback function to make UI operations which must be done after folder
+ * was refreshed.
*/
void modest_mail_operation_refresh_folder (ModestMailOperation *self,
- TnyFolder *folder);
+ TnyFolder *folder,
+ RefreshAsyncUserCallback user_callback,
+ gpointer user_data);
-guint modest_mail_operation_get_id (ModestMailOperation *self);
+/**
+ * modest_mail_operation_get_account:
+ * @self: a #ModestMailOperation
+ *
+ * Gets the account associated to a mail operation
+ *
+ * Returns: the #TnyAccount associated to the #ModestMailOperation
+ **/
+TnyAccount *modest_mail_operation_get_account (ModestMailOperation *self);
+
+
+/**
+ * modest_mail_operation_noop:
+ * @self: a #ModestMailOperation
+ *
+ * Does nothing except emitting operation-started and
+ * operation-finished
+ **/
+void modest_mail_operation_noop (ModestMailOperation *self);
+
+
+/**
+ * modest_mail_operation_to_string:
+ * @self: a #ModestMailOperation
+ *
+ * get a string representation of the mail operation (for debugging)
+ *
+ * Returns: a newly allocated string
+ **/
+gchar* modest_mail_operation_to_string (ModestMailOperation *self);
-guint modest_mail_operation_set_id (ModestMailOperation *self,
- guint id);
G_END_DECLS
projects / modest / blobdiff