1 /* Copyright (c) 2008, Nokia Corporation
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
8 * * Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * * Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * * Neither the name of the Nokia Corporation nor the names of its
14 * contributors may be used to endorse or promote products derived from
15 * this software without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
18 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
19 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
20 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
21 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
24 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
25 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
26 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 /* modest-account-settings.h */
33 #ifndef __MODEST_ACCOUNT_PROTOCOL_H__
34 #define __MODEST_ACCOUNT_PROTOCOL_H__
36 #include "widgets/modest-account-settings-dialog.h"
37 #include "modest-protocol.h"
38 #include "widgets/modest-wizard-dialog.h"
39 #include "modest-pair.h"
40 #include <tny-account.h>
45 /* convenience macros */
46 #define MODEST_TYPE_ACCOUNT_PROTOCOL (modest_account_protocol_get_type())
47 #define MODEST_ACCOUNT_PROTOCOL(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_ACCOUNT_PROTOCOL,ModestAccountProtocol))
48 #define MODEST_ACCOUNT_PROTOCOL_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_ACCOUNT_PROTOCOL,ModestAccountProtocolClass))
49 #define MODEST_IS_ACCOUNT_PROTOCOL(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_ACCOUNT_PROTOCOL))
50 #define MODEST_IS_ACCOUNT_PROTOCOL_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_ACCOUNT_PROTOCOL))
51 #define MODEST_ACCOUNT_PROTOCOL_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_ACCOUNT_PROTOCOL,ModestAccountProtocolClass))
53 typedef struct _ModestAccountProtocol ModestAccountProtocol;
54 typedef struct _ModestAccountProtocolClass ModestAccountProtocolClass;
57 struct _ModestAccountProtocol {
58 ModestProtocol parent;
61 struct _ModestAccountProtocolClass {
62 ModestProtocolClass parent_class;
65 TnyAccount * (*create_account) (ModestAccountProtocol *self);
66 ModestAccountSettingsDialog* (*create_account_settings_dialog) (ModestAccountProtocol* self);
67 ModestPairList* (*get_easysetupwizard_tabs) (ModestAccountProtocol* self);
68 ModestWizardDialogResponseOverrideFunc (*get_wizard_response_override) (ModestAccountProtocol *self);
69 void (*save_settings) (ModestAccountProtocol *self, ModestAccountSettingsDialog *dialog, ModestAccountSettings *settings);
70 void (*save_wizard_settings) (ModestAccountProtocol *self, GList *wizard_pages, ModestAccountSettings *settings);
74 * modest_account_protocol_get_type:
76 * Returns: GType of the account protocol type
78 GType modest_account_protocol_get_type (void) G_GNUC_CONST;
81 * modest_account_protocol_new:
83 * creates a new instance of #ModestAccountProtocol
85 * Returns: a #ModestAccountProtocol
87 ModestProtocol* modest_account_protocol_new (const gchar *name, const gchar *display_name,
88 guint port, guint alternate_port,
89 GType account_g_type);
92 * modest_account_protocol_get_port:
93 * @self: a #ModestAccountProtocol
95 * get the protocol standard port
99 guint modest_account_protocol_get_port (ModestAccountProtocol *self);
102 * modest_account_protocol_set_port:
103 * @self: a #ModestAccountProtocol
106 * set @port as the protocol standard port
108 void modest_account_protocol_set_port (ModestAccountProtocol *self,
112 * modest_account_protocol_get_alternate_port:
113 * @self: a #ModestAccountProtocol
115 * get the protocol standard alternate_port
119 guint modest_account_protocol_get_alternate_port (ModestAccountProtocol *self);
122 * modest_account_protocol_set_alternate_port:
123 * @self: a #ModestAccountProtocol
124 * @alternate_port: a #guint
126 * set @alternate_port as the protocol alternate port
128 void modest_account_protocol_set_alternate_port (ModestAccountProtocol *self,
129 guint alternate_port);
132 * modest_account_protocol_set_account_options:
133 * @self: a #ModestAccountProtocol
134 * @account_options: a #TnyList of account options and their values
136 * set the account options that will be passed to TnyCamelAccount for this protocol.
137 * This replaces previous option lists for this protocol
139 void modest_account_protocol_set_account_options (ModestAccountProtocol *self,
140 TnyList *account_options);
143 * modest_account_protocol_get_account_options:
144 * @self: a #ModestAccountProtocol
146 * obtain the account options for this account protocol.
148 * Returns: a caller-owner copy of the account options list.
150 TnyList *modest_account_protocol_get_account_options (ModestAccountProtocol *self);
153 * modest_account_protocol_has_custom_secure_auth_mech:
154 * @self: a #ModestAccountProtocol
155 * @auth_protocol_type: a #ModestProtocolType for an auth protocol
157 * checks whether there's a custom secure auth mech camel string for @auth_protocol_type.
159 * Returns: %TRUE if registered, %FALSE otherwise
162 modest_account_protocol_has_custom_secure_auth_mech (ModestAccountProtocol *self, ModestProtocolType auth_protocol_type);
165 * modest_account_protocol_get_custom_secure_auth_mech:
166 * @self: a #ModestAccountProtocol
167 * @auth_protocol_type: a #ModestProtocolType for an auth protocol
169 * obtains the secure auth mech of @auth_protocol_type in protocol. Be careful as %NULL does not imply
170 * there's no custom auth mech registered (you can register %NULL). To check if it's registered, just
171 * use modest_account_protocol_has_custom_secure_auth_mech().
173 * Returns: the secure auth mech for this auth protocol type that will be passed to camel.
176 modest_account_protocol_get_custom_secure_auth_mech (ModestAccountProtocol *self, ModestProtocolType auth_protocol_type);
179 * modest_account_protocol_unset_custom_secure_auth_mech:
180 * @self: a #ModestAccountProtocol
181 * @auth_protocol_type: a #ModestProtocolType for an auth protocol
183 * Unsets the secure auth meth of @auth_protocol_type in protocol.
186 modest_account_protocol_unset_custom_secure_auth_mech (ModestAccountProtocol *self, ModestProtocolType auth_protocol_type);
189 * modest_account_protocol_set_custom_secure_auth_mech:
190 * @self: a #ModestAccountProtocol
191 * @auth_protocol_type: a #ModestProtocolType for an auth protocol
192 * @secure_auth_mech: a string or %NULL
194 * sets the secure auth mech of @auth_protocol_type in protocol. Be careful as %NULL does not imply
195 * there's no custom auth mech registered (you can register %NULL). If you set %NULL you're regitering %NULL as the custom secure auth
196 * mechanism instead of unsetting it.
199 modest_account_protocol_set_custom_secure_auth_mech (ModestAccountProtocol *self, ModestProtocolType auth_protocol_type, const gchar *secure_auth_mech);
202 * modest_account_protocol_get_account_g_type:
203 * @self: a #ModestAccountProtocol
205 * get the protocol type used for factoring new TnyAccount
209 GType modest_account_protocol_get_account_g_type (ModestAccountProtocol *self);
212 * modest_account_protocol_set_account_g_type:
213 * @self: a #ModestAccountProtocol
214 * @account_g_type: a #GType
216 * set @account_g_type as the type modest_account_protocol_create_account will
219 void modest_account_protocol_set_account_g_type (ModestAccountProtocol *self,
220 GType account_g_type);
223 * modest_account_protocol_create_account:
224 * @self: a #ModestAccountProtocol
226 * create a new account instance for this protocol
228 * Returns: a #TnyAccount
230 TnyAccount * modest_account_protocol_create_account (ModestAccountProtocol *self);
233 * modest_account_protocol_get_account_settings_dialog:
234 * @self: a #ModestAccountProtocol
235 * @account_name: the name of the account we're creating the dialog for
237 * retrieves the account settings dialog used to setup the account
238 * represented by this protocol
240 * Returns: a #ModestAccountSettingsDialog
242 ModestAccountSettingsDialog* modest_account_protocol_get_account_settings_dialog (ModestAccountProtocol *self,
243 const gchar *account_name);
245 ModestPairList* modest_account_protocol_get_easysetupwizard_tabs (ModestAccountProtocol *self);
248 * modest_account_protocol_save_settings:
249 * @self: this #ModestAccountProtocol
250 * @dialog: a #ModestAccountSettingsDialog
251 * @settings: the #ModestAccountSettings
253 * this function stores the values held by the account settings dialog
254 * in the account settings object that is passed as argument
256 * NOTE: this function provides a default implementation that calls
257 * the save_settings method of the acocunt settings dialog. So if your
258 * implementation do not do anything more just do not redefine it
260 void modest_account_protocol_save_settings (ModestAccountProtocol *self,
261 ModestAccountSettingsDialog *dialog,
262 ModestAccountSettings *settings);
265 * modest_account_protocol_save_wizard_settings:
266 * @self: this #ModestAccountProtocol
267 * @wizard_pages: a list of #ModestEasysetupWizardPage
268 * @settings: the #ModestAccountSettings
270 * this function stores the data input by the users in the wizard in
271 * the account settings object passed as argument
273 void modest_account_protocol_save_wizard_settings (ModestAccountProtocol *self,
275 ModestAccountSettings *settings);
278 * modest_account_protocol_get_wizard_response_override:
279 * @self: a #ModestAccountProtocol
281 * obtains the method that should be used to override wizard response behavior when the
282 * wizard is setting up this account type.
284 * Returns: a #ModestWizardDialogResponseOverrideFunc
286 ModestWizardDialogResponseOverrideFunc modest_account_protocol_get_wizard_response_override (ModestAccountProtocol *self);
291 #endif /* __MODEST_ACCOUNT_PROTOCOL_H__ */