X-Git-Url: http://git.maemo.org/git/?p=modest;a=blobdiff_plain;f=src%2Fmodest-mail-operation.h;h=5d2b9f99c1189fb04c6c7c8218a7c05288ac5116;hp=4650b3f64502c8849774b0cd75c14edecf75f459;hb=ab8473048344d936ba2b3a09a3feecd2de37f7c6;hpb=976c05744180efac28a9dc421acefcff18659d67 diff --git a/src/modest-mail-operation.h b/src/modest-mail-operation.h index 4650b3f..5d2b9f9 100644 --- a/src/modest-mail-operation.h +++ b/src/modest-mail-operation.h @@ -65,30 +65,28 @@ typedef enum _ModestMailOperationStatus { * * 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; +typedef enum { + MODEST_MAIL_OPERATION_TYPE_SEND, + MODEST_MAIL_OPERATION_TYPE_RECEIVE, + MODEST_MAIL_OPERATION_TYPE_OPEN, + MODEST_MAIL_OPERATION_TYPE_DELETE, + MODEST_MAIL_OPERATION_TYPE_INFO, + MODEST_MAIL_OPERATION_TYPE_UNKNOWN, +} ModestMailOperationTypeOperation; - -struct _ModestMailOperation { - GObject parent; - /* insert public members, if any */ -}; - -struct _ModestMailOperationClass { - GObjectClass parent_class; - - /* Signals */ - void (*progress_changed) (ModestMailOperation *self, gpointer user_data); -}; +/** + * ErrorCheckingAsyncUserCallback: + * + * @mail_op: the current mail operation. + * @user_data: generic data passed to user defined function. + * + * This function implements required actions to performs under error + * states. + */ +typedef void (*ErrorCheckingUserCallback) (ModestMailOperation *mail_op, gpointer user_data); /** - * GetMsgAsynUserCallback: + * GetMsgAsyncUserCallback: * * @obj: a #GObject generic object which has created current mail operation. * @msg: a #TnyMsg message retrieved by async operation. @@ -98,9 +96,47 @@ struct _ModestMailOperationClass { * 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); +typedef void (*GetMsgAsyncUserCallback) (ModestMailOperation *mail_op, + TnyHeader *header, + TnyMsg *msg, + gpointer user_data); + +/** + * XferMsgAsynUserCallback: + * + * @obj: a #GObject generic object which has created current mail operation. + * @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); +/* This struct represents the internal state of a mail operation in a + given time */ +typedef struct { + guint done; + guint total; + gboolean finished; + ModestMailOperationStatus status; + ModestMailOperationTypeOperation op_type; +} ModestMailOperationState; + + +struct _ModestMailOperation { + GObject parent; + /* insert public members, if any */ +}; + +struct _ModestMailOperationClass { + GObjectClass parent_class; + + /* Signals */ + void (*progress_changed) (ModestMailOperation *self, ModestMailOperationState *state, gpointer user_data); +}; + /* member functions */ GType modest_mail_operation_get_type (void) G_GNUC_CONST; @@ -112,18 +148,45 @@ GType modest_mail_operation_get_type (void) G_GNUC_CONST; * 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, +ModestMailOperation* modest_mail_operation_new (ModestMailOperationTypeOperation type, GObject *source); /** - * modest_mail_operation_get_id + * modest_mail_operation_new_with_error_handling: + * @id: a #ModestMailOperationId identification of operation type. + * @source: a #GObject which creates this new operation. + * @error_handler: a #ErrorCheckingUserCallback function to performs operations when + * an error occurs. + * + * Creates a new instance of class #ModestMailOperation, using parameters + * to initialize its private structure. @source parameter may be NULL. + * @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, + ErrorCheckingUserCallback error_handler, + gpointer user_data); +/** + * modest_mail_operation_execute_error_handler + * @self: a #ModestMailOperation + * + * Executes error handler if exists. The error handler is the one that + * MUST free the user data passed to the + * modest_mail_operation_new_with_error_handling constructor + **/ +void +modest_mail_operation_execute_error_handler (ModestMailOperation *self); + +/** + * modest_mail_operation_get_type_operation * @self: a #ModestMailOperation * - * Gets the private id field of mail operation. This id identifies - * the class/type of mail operation. + * Gets the private op_type field of mail operation. This op_type + * identifies the class/type of mail operation. **/ -ModestMailOperationId -modest_mail_operation_get_id (ModestMailOperation *self); +ModestMailOperationTypeOperation +modest_mail_operation_get_type_operation (ModestMailOperation *self); /** * modest_mail_operation_is_mine @@ -138,6 +201,17 @@ gboolean modest_mail_operation_is_mine (ModestMailOperation *self, GObject *me); +/** + * modest_mail_operation_get_source + * @self: a #ModestMailOperation + * + * returns a new reference to the object that created the mail + * operation passed to the constructor, or NULL if none. The caller + * must free the new reference + **/ +GObject * +modest_mail_operation_get_source (ModestMailOperation *self); + /* fill in other public functions, eg.: */ /** @@ -159,6 +233,7 @@ void modest_mail_operation_send_mail (ModestMailOperation *self, * 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 @@ -176,6 +251,7 @@ void modest_mail_operation_send_mail (ModestMailOperation *self, **/ void modest_mail_operation_send_new_mail (ModestMailOperation *self, TnyTransportAccount *transport_account, + TnyMsg *draft_msg, const gchar *from, const gchar *to, const gchar *cc, @@ -191,6 +267,8 @@ void modest_mail_operation_send_new_mail (ModestMailOperation *self, * 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 @@ -208,6 +286,7 @@ void modest_mail_operation_send_new_mail (ModestMailOperation *self, **/ void modest_mail_operation_save_to_drafts (ModestMailOperation *self, TnyTransportAccount *transport_account, + TnyMsg *draft_msg, const gchar *from, const gchar *to, const gchar *cc, @@ -220,7 +299,7 @@ void modest_mail_operation_save_to_drafts (ModestMailOperation *self, /** * modest_mail_operation_update_account: * @self: a #ModestMailOperation - * @store_account: a #TnyStoreAccount + * @account_name: the id of a Modest account * * Asynchronously refreshes the root folders of the given store * account. The caller should add the #ModestMailOperation to a @@ -228,23 +307,23 @@ void modest_mail_operation_save_to_drafts (ModestMailOperation *self, * 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), NULL); * modest_mail_operation_queue_add (queue, mail_op); - * modest_mail_operation_update_account (mail_op, account) + * modest_mail_operation_update_account (mail_op, account_name) * g_object_unref (G_OBJECT (mail_op)); * + * + * 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, - TnyStoreAccount *store_account); + const gchar *account_name); /* Functions that perform store operations */ @@ -311,14 +390,12 @@ void modest_mail_operation_rename_folder (ModestMailOperation *self, * If @delete_original is TRUE this function moves the original * folder, if it is FALSE the it just copies it * - * Returns: the newly transfered folder **/ -TnyFolder* modest_mail_operation_xfer_folder (ModestMailOperation *self, - TnyFolder *folder, +void modest_mail_operation_xfer_folder (ModestMailOperation *self, + TnyFolder *folder, TnyFolderStore *parent, gboolean delete_original); - /* Functions that performs msg operations */ /** @@ -327,6 +404,8 @@ TnyFolder* modest_mail_operation_xfer_folder (ModestMailOperation *self, * @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_data: generic user data which will be passed to @user_callback function. * * Asynchronously transfers messages from their current folder to * another one. The caller should add the #ModestMailOperation to a @@ -352,7 +431,9 @@ TnyFolder* modest_mail_operation_xfer_folder (ModestMailOperation *self, void modest_mail_operation_xfer_msgs (ModestMailOperation *self, TnyList *header_list, TnyFolder *folder, - gboolean delete_original); + gboolean delete_original, + XferMsgsAsynUserCallback user_callback, + gpointer user_data); /** * modest_mail_operation_remove_msg: @@ -373,7 +454,7 @@ void modest_mail_operation_remove_msg (ModestMailOperation *self, * 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_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 header using an user defined @callback function @@ -382,10 +463,10 @@ void modest_mail_operation_remove_msg (ModestMailOperation *self, **/ void modest_mail_operation_get_msg (ModestMailOperation *self, TnyHeader *header, - GetMsgAsynUserCallback user_callback, + GetMsgAsyncUserCallback user_callback, gpointer user_data); /** - * modest_mail_operation_process_msg: + * modest_mail_operation_get_msgs_full: * @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. @@ -395,10 +476,11 @@ void modest_mail_operation_get_msg (ModestMailOperation *self, * pased as argument. This operation is asynchronous, so the * #ModestMailOperation should be added to #ModestMailOperationQueue **/ -void modest_mail_operation_process_msg (ModestMailOperation *self, +void modest_mail_operation_get_msgs_full (ModestMailOperation *self, TnyList *headers_list, - GetMsgAsynUserCallback user_callback, - gpointer user_data); + GetMsgAsyncUserCallback user_callback, + gpointer user_data, + GDestroyNotify notify); /* Functions to control mail operations */ /** @@ -480,17 +562,10 @@ gboolean modest_mail_operation_cancel (ModestMailOperation *self); 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); +guint modest_mail_operation_get_id (ModestMailOperation *self); + +guint modest_mail_operation_set_id (ModestMailOperation *self, + guint id); G_END_DECLS