1 /* Copyright (c) 2006, 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-tny-account-store.h */
33 #ifndef __MODEST_TNY_ACCOUNT_STORE_H__
34 #define __MODEST_TNY_ACCOUNT_STORE_H__
36 #include <glib-object.h>
37 #include <modest-defs.h>
38 #include <tny-account-store.h>
39 #include <tny-session-camel.h>
40 #include <tny-shared.h>
41 #include <tny-folder.h>
42 #include <modest-account-mgr.h>
43 #include <modest-tny-local-folders-account.h>
44 #include <gtk/gtkwidget.h>
46 /* other include files */
50 /* convenience macros */
51 #define MODEST_TYPE_TNY_ACCOUNT_STORE (modest_tny_account_store_get_type())
52 #define MODEST_TNY_ACCOUNT_STORE(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_TNY_ACCOUNT_STORE,ModestTnyAccountStore))
53 #define MODEST_TNY_ACCOUNT_STORE_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_TNY_ACCOUNT_STORE,ModestTnyAccountStoreClass))
54 #define MODEST_IS_TNY_ACCOUNT_STORE(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_TNY_ACCOUNT_STORE))
55 #define MODEST_IS_TNY_ACCOUNT_STORE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_TNY_ACCOUNT_STORE))
56 #define MODEST_TNY_ACCOUNT_STORE_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_TNY_ACCOUNT_STORE,ModestTnyAccountStoreClass))
58 typedef struct _ModestTnyAccountStore ModestTnyAccountStore;
59 typedef struct _ModestTnyAccountStoreClass ModestTnyAccountStoreClass;
60 typedef TnyGetPassFunc ModestTnyGetPassFunc;
62 struct _ModestTnyAccountStore {
66 struct _ModestTnyAccountStoreClass {
67 GObjectClass parent_class;
69 void (*account_update) (ModestTnyAccountStore *self,
70 const gchar *account_name,
72 void (*password_requested) (ModestTnyAccountStore *self,
73 const gchar *server_account_name,
81 void (*account_changed) (TnyAccountStore *self, TnyAccount *account);
82 void (*account_inserted) (TnyAccountStore *self, TnyAccount *account);
83 void (*account_removed) (TnyAccountStore *self, TnyAccount *account);
87 MODEST_TNY_ACCOUNT_STORE_QUERY_ID,
88 MODEST_TNY_ACCOUNT_STORE_QUERY_URL,
89 } ModestTnyAccountStoreQueryType;
93 * modest_tny_account_store_get_type:
95 * Returns: GType of the account store
97 GType modest_tny_account_store_get_type (void) G_GNUC_CONST;
100 * modest_tny_account_store_new:
101 * @account_mgr: account manager to use for new account store
103 * creates new (tinymail) account store for account manager modest_acc_mgr
105 * Returns: newly created account store or NULL in case of error
107 ModestTnyAccountStore* modest_tny_account_store_new (ModestAccountMgr *account_mgr,
112 * modest_tny_account_store_get_account_by
113 * @self: a ModestTnyAccountStore instance
116 * get the account with the given str or NULL if it's not found
118 * Returns: the tnyaccount or NULL,
119 * g_object_unref when it's no longer needed
121 TnyAccount* modest_tny_account_store_get_tny_account_by (ModestTnyAccountStore *self,
122 ModestTnyAccountStoreQueryType type,
126 * modest_tny_account_store_get_server_account
127 * @self: a ModestTnyAccountStore instance
128 * @account_name: a modest account name
129 * @type: the tny account type (#TNY_ACCOUNT_TYPE_STORE or #TNY_ACCOUNT_TYPE_STORE)
131 * Get the tny account corresponding to one of the server_accounts for account with @account_name
133 * Returns: the tnyaccount for the server account or NULL in case it's not found or error,
134 * g_object_unref when it's no longer needed. TODO: Check that callers are unreffing.
136 TnyAccount* modest_tny_account_store_get_server_account (ModestTnyAccountStore *self,
137 const gchar *account_name,
138 TnyAccountType type);
141 * modest_tny_account_store_get_transport_account_for_open_connection
142 * @self: a ModestTnyAccountStore instance
143 * @account_name: an account name
145 * Get the tny account corresponding to the transport server account for the account with @account_name,
146 * returning the connection-specific SMTP-server transport server account if one is specified,
147 * otherwise just returning the regular transport server account.
149 * Returns: the tnyaccount for the server account or NULL in case it's not found or error,
150 * g_object_unref when it's no longer needed
152 TnyAccount* modest_tny_account_store_get_transport_account_for_open_connection (ModestTnyAccountStore *self,
153 const gchar *account_name);
155 TnyAccount* modest_tny_account_store_get_smtp_specific_transport_account_for_open_connection (ModestTnyAccountStore *self,
156 const gchar *account_name);
159 * tny_account_store_get_session
160 * @self: a TnyAccountStore instance
162 * get the tny-camel-session for this account store. Note that this function
163 * does NOT have the modest_ prefix, as tinymail requires the symbol to be like this...
165 * Returns: a tny-camel-session
167 TnySessionCamel* modest_tny_account_store_get_session (TnyAccountStore *self);
169 /** modest_tny_account_store_get_local_folders_account:
170 * @self: a TnyAccountStore instance
172 * Get the user-visible local folders account. It returns a new
173 * reference so the caller must unref it when no longer needed
175 TnyAccount * modest_tny_account_store_get_local_folders_account (ModestTnyAccountStore *self);
178 * modest_tny_account_store_get_mmc_folders_account:
179 * @self: a TnyAccountStore instance
181 * Get the mmc folders account.
183 * Returns: a #TnyAccount, or %NULL if no mmc account is available
184 * now. It returns a new reference so the caller must unref it when no
187 TnyAccount * modest_tny_account_store_get_mmc_folders_account (ModestTnyAccountStore *self);
189 /** modest_tny_account_store_forget_already_asked:
190 * @self: a TnyAccountStore instance
191 * @account: the account to forget the already asked status for
193 * Forget the already asked status of an account
195 void modest_tny_account_store_forget_already_asked (ModestTnyAccountStore *self, TnyAccount *account);
198 * modest_tny_account_store_find_msg_in_outboxes:
199 * @self: a #ModestTnyAccountStore
200 * @uri: the uri of the message
201 * @ac_out: output attribute, %NULL, or the #TnyAccount of the message
203 * finds a message in the set of outboxes, using the uri.
205 * Returns: %NULL or a #TnyMsg
207 TnyMsg *modest_tny_account_store_find_msg_in_outboxes (ModestTnyAccountStore *self,
209 TnyAccount **ac_out);
213 * modest_tny_account_store_get_transport_account_from_outbox_header:
214 * @self: a #ModestTnyAccountStore
215 * @header: a #TnyHeader
217 * Gets the transport account from a header that is in the outbox
219 * Returns: %NULL or a %TnyTransportAccount. Returns a new reference
220 * so the caller must unref it when no longer needed
222 TnyTransportAccount * modest_tny_account_store_get_transport_account_from_outbox_header(ModestTnyAccountStore *self,
226 * modest_tny_account_store_new_connection_specific_transport_account:
227 * @self: a #ModestTnyAccountStore
228 * @name: the name of the connection specific smtp transport account
230 * Creates a connection specific transport account and put it in the merged outbox
232 * Returns: the new #TnyTransportAccount
234 TnyTransportAccount * modest_tny_account_store_new_connection_specific_transport_account (ModestTnyAccountStore *self,
238 * modest_tny_account_store_show_account_settings_dialog:
239 * @self: a #ModestTnyAccountStore
240 * @account_name: a string
242 * obtains (if already created) or creates (and shows) the settings dialog for
245 * Returns: a #ModesAccountSettingsDialog
247 GtkWidget *modest_tny_account_store_show_account_settings_dialog (ModestTnyAccountStore *self,
248 const gchar *account_name);
251 * modest_tny_account_store_is_send_mail_blocked:
252 * @self: a #ModestTnyAccountStore
254 * Tells if we've blocked the send queue flush attempts temporally. This is
255 * usually done when we're editing an account, to prevent sending mails as
256 * it can cause problems
258 * Returns: %TRUE if sending mail is blocked
260 gboolean modest_tny_account_store_is_send_mail_blocked (ModestTnyAccountStore *self);
263 * modest_tny_account_store_set_send_mail_blocked:
264 * @self: a #ModestTnyAccountStore
265 * @blocked: a #gboolean
267 * Sets as blocked/non blocked the send queue flush attempts temporally. This is
268 * usually done when we're editing an account, to prevent sending mails as
269 * it can cause problems
271 void modest_tny_account_store_set_send_mail_blocked (ModestTnyAccountStore *self, gboolean blocked);
276 #endif /* __MODEST_TNY_ACCOUNT_STORE_H__ */