#include "widgets/modest-account-settings-dialog.h"
#include "modest-protocol.h"
+#include "widgets/modest-wizard-dialog.h"
#include "modest-pair.h"
#include <tny-account.h>
#include <tny-list.h>
typedef struct _ModestAccountProtocol ModestAccountProtocol;
typedef struct _ModestAccountProtocolClass ModestAccountProtocolClass;
+typedef enum {
+ MODEST_ACCOUNT_PROTOCOL_ICON_MAILBOX = 0,
+ MODEST_ACCOUNT_PROTOCOL_ICON_PROTOCOL,
+ MODEST_ACCOUNT_PROTOCOL_ICON_ACCOUNT,
+ MODEST_ACCOUNT_PROTOCOL_ICON_FOLDER,
+} ModestAccountProtocolIconType;
+
+typedef void (*ModestAccountProtocolCheckSupportFunc) (ModestAccountProtocol *self,
+ gboolean supported, gpointer userdata);
+typedef void (*ModestAccountProtocolSaveRemoteDraftCallback) (ModestAccountProtocol *self,
+ GError *error,
+ const gchar *account_id,
+ TnyMsg *new_remote_msg,
+ TnyMsg *new_msg,
+ TnyMsg *old_msg,
+ gpointer userdata);
+
struct _ModestAccountProtocol {
ModestProtocol parent;
TnyAccount * (*create_account) (ModestAccountProtocol *self);
ModestAccountSettingsDialog* (*create_account_settings_dialog) (ModestAccountProtocol* self);
ModestPairList* (*get_easysetupwizard_tabs) (ModestAccountProtocol* self);
+ ModestWizardDialogResponseOverrideFunc (*get_wizard_response_override) (ModestAccountProtocol *self);
void (*save_settings) (ModestAccountProtocol *self, ModestAccountSettingsDialog *dialog, ModestAccountSettings *settings);
void (*save_wizard_settings) (ModestAccountProtocol *self, GList *wizard_pages, ModestAccountSettings *settings);
+ gboolean (*is_supported) (ModestAccountProtocol *self);
+ void (*check_support) (ModestAccountProtocol *self, ModestAccountProtocolCheckSupportFunc func, gpointer userdata);
+ gchar * (*get_from) (ModestAccountProtocol *self, const gchar *account_id, const gchar *mailbox);
+ ModestPairList * (*get_from_list) (ModestAccountProtocol *self, const gchar *account_id);
+ gchar * (*get_signature) (ModestAccountProtocol *self, const gchar *account_id, const gchar *mailbox, gboolean *has_signature);
+ const GdkPixbuf * (*get_icon) (ModestAccountProtocol *self, ModestAccountProtocolIconType icon_type,
+ GObject *object, guint icon_size);
+ gchar * (*get_service_name) (ModestAccountProtocol *self, const gchar *account_id, const gchar *mailbox);
+ const GdkPixbuf * (*get_service_icon) (ModestAccountProtocol *self, const gchar *account_id, const gchar *mailbox, guint icon_size);
+ void (*save_remote_draft) (ModestAccountProtocol *self,
+ const gchar *account_id, TnyMsg *new_msg, TnyMsg *old_msg,
+ ModestAccountProtocolSaveRemoteDraftCallback callback,
+ gpointer userdata);
+ void (*cancel_check_support) (ModestAccountProtocol *self);
+ void (*wizard_finished) (ModestAccountProtocol *self);
+ gboolean (*decode_part_to_stream) (ModestAccountProtocol *protocol,
+ TnyMimePart *part,
+ const gchar *stream_uri,
+ TnyStream *stream,
+ gssize *written,
+ GError **error);
+ gboolean (*decode_part_to_stream_async) (ModestAccountProtocol *protocol,
+ TnyMimePart *part,
+ const gchar *stream_uri,
+ TnyStream *stream,
+ TnyMimePartCallback callback,
+ TnyStatusCallback status_callback,
+ gpointer user_data);
+
+ /* Padding for future expansions */
+ void (*_reserved8) (void);
+ void (*_reserved9) (void);
+ void (*_reserved10) (void);
+ void (*_reserved11) (void);
+ void (*_reserved12) (void);
+ void (*_reserved13) (void);
+ void (*_reserved14) (void);
+ void (*_reserved15) (void);
+ void (*_reserved16) (void);
};
/**
GList *wizard_pages,
ModestAccountSettings *settings);
+/**
+ * modest_account_protocol_get_wizard_response_override:
+ * @self: a #ModestAccountProtocol
+ *
+ * obtains the method that should be used to override wizard response behavior when the
+ * wizard is setting up this account type.
+ *
+ * Returns: a #ModestWizardDialogResponseOverrideFunc
+ */
+ModestWizardDialogResponseOverrideFunc modest_account_protocol_get_wizard_response_override (ModestAccountProtocol *self);
+
+
+/**
+ * modest_account_protocol_check_support:
+ * @self: a #ModestAccountProtocol
+ * @func: a #ModestAccountProtocolCheckSupportFunc
+ * @userdata: a gpointer
+ *
+ * This method checks asynchronously if the account protocol @self is
+ * supported. Once checked, @func will be called with the result in the
+ * mainloop.
+ *
+ * modest_account_protocol_is_supported() should return the cached response
+ * from this method.
+ */
+void modest_account_protocol_check_support (ModestAccountProtocol *self,
+ ModestAccountProtocolCheckSupportFunc func,
+ gpointer userdata);
+
+/**
+ * modest_account_protocol_cancel_check_support:
+ * @self: a #ModestAccountProtocol
+ *
+ * This method requests that the check support requests running should be
+ * immediately cancelled. Once this happens, is_supported should return %FALSE
+ * until a new succesful check_support request is finished.
+ */
+void modest_account_protocol_cancel_check_support (ModestAccountProtocol *self);
+
+/**
+ * modest_account_protocol_wizard_finished:
+ * @self: a #ModestAccountProtocol
+ *
+ * Method that let protocol know if the wizard has finished, for the case it's
+ * needed to do some stuff after check_support.
+ */
+void modest_account_protocol_wizard_finished (ModestAccountProtocol *self);
+
+/**
+ * modest_account_protocol_is_supported:
+ * @self: a #ModestAccountProtocol
+ *
+ * Determines if the account protocol is supported on this device.
+ *
+ * Returns: %TRUE if the protocol is supported, %FALSE otherwise
+ */
+gboolean modest_account_protocol_is_supported (ModestAccountProtocol *self);
+
+/**
+ * modest_account_protocol_get_from:
+ * @self: a #ModestAccountProtocol
+ * @account_id: a transport account name
+ * @mailbox: a mailbox
+ *
+ * Obtain the From: string for the account and mailbox. Should be used only
+ * with transports with multi mailbox support.
+ *
+ * Returns: a newly allocated string
+ */
+gchar *modest_account_protocol_get_from (ModestAccountProtocol *self,
+ const gchar *account_id,
+ const gchar *mailbox);
+
+/**
+ * modest_account_protocol_get_from_list:
+ * @self: a #ModestAccountProtocol
+ * @account_id: a transport account name
+ *
+ * Obtain a list of pairs (mailbox - From: string) for filling the From picker.
+ *
+ * Returns: a ModestPairList
+ */
+ModestPairList *modest_account_protocol_get_from_list (ModestAccountProtocol *self,
+ const gchar *account_id);
+
+/**
+ * modest_account_protocol_get_signature:
+ * @self: a #ModestAccountProtocol
+ * @account_id: a transport account name
+ * @mailbox: a mailbox
+ *
+ * Obtain the signature string for the account and mailbox. Should be used only
+ * with transports with multi mailbox support.
+ *
+ * Returns: a newly allocated string
+ */
+gchar *modest_account_protocol_get_signature (ModestAccountProtocol *self,
+ const gchar *account_id,
+ const gchar *mailbox,
+ gboolean *has_signature);
+
+/**
+ * modest_account_protocol_get_icon:
+ * @self: a #ModestAccountProtocl
+ * @icon_type: a #ModestAccountProtocolIconType
+ * @object: a #GObject
+ * @icon_size: the icon size to get
+ *
+ * Returns a @self owned #GdkPixbuf with the icon for @icon_type and @object. @object type
+ * should match @icon_type.
+ *
+ * Returns: a #GdkPixbuf (don't free or manipulate this, just copy)
+ */
+const GdkPixbuf * modest_account_protocol_get_icon (ModestAccountProtocol *self, ModestAccountProtocolIconType icon_type,
+ GObject *object, guint icon_size);
+
+/**
+ * modest_account_protocol_get_service_name:
+ * @self: a #ModestAccountProtocol
+ * @account_id: a transport account name
+ * @mailbox: a mailbox
+ *
+ * Obtain the service name string for the account and mailbox.
+ *
+ * Returns: a newly allocated string
+ */
+gchar *modest_account_protocol_get_service_name (ModestAccountProtocol *self,
+ const gchar *account_id,
+ const gchar *mailbox);
+
+/**
+ * modest_account_protocol_get_service_icon:
+ * @self: a #ModestAccountProtocol
+ * @account_id: a transport account name
+ * @mailbox: a mailbox
+ *
+ * Obtain the service icon for the account and mailbox.
+ *
+ * Returns: a protocol owned #GdkPixbuf
+ */
+const GdkPixbuf *modest_account_protocol_get_service_icon (ModestAccountProtocol *self,
+ const gchar *account_id,
+ const gchar *mailbox,
+ guint icon_size);
+
+/**
+ * modest_account_protocol_save_remote_draft:
+ * @self: a #ModestAccountProtocol
+ * @account_id: a transport account_name
+ * @new_msg: the newly created message in local storage.
+ * @old_msg: the old message
+ * @callback: the code that should be executed on finishing the remote message saving
+ * @userdata: a #gpointer
+ *
+ * Saves the just-saved to local draft, into a remote storage.
+ */
+void modest_account_protocol_save_remote_draft (ModestAccountProtocol *self,
+ const gchar *account_id,
+ TnyMsg *new_msg,
+ TnyMsg *old_msg,
+ ModestAccountProtocolSaveRemoteDraftCallback callback,
+ gpointer userdata);
+
+/**
+ * modest_account_protocol_decode_part_to_stream:
+ * @self: a #ModestAccountProtocol
+ * @part: a #TnyMimePart
+ * @stream_uri: a string
+ * @stream: a #TnyStream
+ * @written: a #gssize pointer, with the number of bytes written
+ * @error: a #GError
+ *
+ * This virtual method delegates on the account protocol to decode @part
+ * into @stream. It just allows the provider to decode it as it needs
+ * (i.e. when the original message has a fake attachment, and provider
+ * can return the real attachment).
+ *
+ * The @stream_uri parameter tells the uri of the resource @stream is
+ * wrapping (if known).
+ *
+ * Returns: %TRUE if @protocol does the decode operation, %FALSE if modest
+ * should do it.
+ */
+gboolean
+modest_account_protocol_decode_part_to_stream (ModestAccountProtocol *protocol,
+ TnyMimePart *part,
+ const gchar *stream_uri,
+ TnyStream *stream,
+ gssize *written,
+ GError **error);
+
+/**
+ * modest_account_protocol_decode_part_to_stream_async:
+ * @self: a #ModestAccountProtocol
+ * @part: a #TnyMimePart
+ * @stream_uri: a string
+ * @stream: a #TnyStream
+ *
+ * This virtual method delegates on the account protocol to decode @part
+ * into @stream, but asynchronously.
+ *
+ * The @stream_uri parameter tells the uri of the resource @stream is
+ * wrapping (if known).
+ *
+ * Returns: %TRUE if @protocol does the decode operation (then we shouldn't expect
+ * callback to happen from this call, %FALSE if modest should do it.
+ */
+gboolean modest_account_protocol_decode_part_to_stream_async (ModestAccountProtocol *self,
+ TnyMimePart *part,
+ const gchar *stream_uri,
+ TnyStream *stream,
+ TnyMimePartCallback callback,
+ TnyStatusCallback status_callback,
+ gpointer user_data);
+
+
G_END_DECLS
#endif /* __MODEST_ACCOUNT_PROTOCOL_H__ */