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>
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>
45 /* other include files */
49 /* convenience macros */
50 #define MODEST_TYPE_TNY_ACCOUNT_STORE (modest_tny_account_store_get_type())
51 #define MODEST_TNY_ACCOUNT_STORE(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_TNY_ACCOUNT_STORE,ModestTnyAccountStore))
52 #define MODEST_TNY_ACCOUNT_STORE_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_TNY_ACCOUNT_STORE,ModestTnyAccountStoreClass))
53 #define MODEST_IS_TNY_ACCOUNT_STORE(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_TNY_ACCOUNT_STORE))
54 #define MODEST_IS_TNY_ACCOUNT_STORE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_TNY_ACCOUNT_STORE))
55 #define MODEST_TNY_ACCOUNT_STORE_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_TNY_ACCOUNT_STORE,ModestTnyAccountStoreClass))
57 typedef struct _ModestTnyAccountStore ModestTnyAccountStore;
58 typedef struct _ModestTnyAccountStoreClass ModestTnyAccountStoreClass;
59 typedef TnyGetPassFunc ModestTnyGetPassFunc;
61 struct _ModestTnyAccountStore {
65 struct _ModestTnyAccountStoreClass {
66 GObjectClass parent_class;
68 void (*account_update) (ModestTnyAccountStore *self,
69 const gchar *account_name,
71 void (*password_requested) (ModestTnyAccountStore *self,
72 const gchar *server_account_name,
80 void (*account_changed) (TnyAccountStore *self, TnyAccount *account);
81 void (*account_inserted) (TnyAccountStore *self, TnyAccount *account);
82 void (*account_removed) (TnyAccountStore *self, TnyAccount *account);
86 MODEST_TNY_ACCOUNT_STORE_QUERY_ID,
87 MODEST_TNY_ACCOUNT_STORE_QUERY_URL,
88 } ModestTnyAccountStoreQueryType;
91 /* We set 5Mb as the upper limit to consider disk full conditions */
92 #define MODEST_TNY_ACCOUNT_STORE_MIN_FREE_SPACE 5 * 1024 * 1024
95 * modest_tny_account_store_get_type:
97 * Returns: GType of the account store
99 GType modest_tny_account_store_get_type (void) G_GNUC_CONST;
102 * modest_tny_account_store_new:
103 * @account_mgr: account manager to use for new account store
105 * creates new (tinymail) account store for account manager modest_acc_mgr
107 * Returns: newly created account store or NULL in case of error
109 ModestTnyAccountStore* modest_tny_account_store_new (ModestAccountMgr *account_mgr,
114 * modest_tny_account_store_get_account_by
115 * @self: a ModestTnyAccountStore instance
118 * get the account with the given str or NULL if it's not found
120 * Returns: the tnyaccount or NULL,
121 * g_object_unref when it's no longer needed
123 TnyAccount* modest_tny_account_store_get_tny_account_by (ModestTnyAccountStore *self,
124 ModestTnyAccountStoreQueryType type,
128 * modest_tny_account_store_get_server_account
129 * @self: a ModestTnyAccountStore instance
130 * @account_name: a modest account name
131 * @type: the tny account type (#TNY_ACCOUNT_TYPE_STORE or #TNY_ACCOUNT_TYPE_TRANSPORT)
133 * Get the tny account corresponding to one of the server_accounts for account with @account_name
135 * Returns: the tnyaccount for the server account or NULL in case it's not found or error,
136 * g_object_unref when it's no longer needed. TODO: Check that callers are unreffing.
138 TnyAccount* modest_tny_account_store_get_server_account (ModestTnyAccountStore *self,
139 const gchar *account_name,
140 TnyAccountType type);
143 * modest_tny_account_store_get_transport_account_for_open_connection
144 * @self: a ModestTnyAccountStore instance
145 * @account_name: an account name
147 * Get the tny account corresponding to the transport server account for the account with @account_name,
148 * returning the connection-specific SMTP-server transport server account if one is specified,
149 * otherwise just returning the regular transport server account.
151 * Returns: the tnyaccount for the server account or NULL in case it's not found or error,
152 * g_object_unref when it's no longer needed
154 TnyAccount* modest_tny_account_store_get_transport_account_for_open_connection (ModestTnyAccountStore *self,
155 const gchar *account_name);
157 TnyAccount* modest_tny_account_store_get_smtp_specific_transport_account_for_open_connection (ModestTnyAccountStore *self,
158 const gchar *account_name);
161 * tny_account_store_get_session
162 * @self: a TnyAccountStore instance
164 * get the tny-camel-session for this account store. Note that this function
165 * does NOT have the modest_ prefix, as tinymail requires the symbol to be like this...
167 * Returns: a tny-camel-session
169 TnySessionCamel* modest_tny_account_store_get_session (TnyAccountStore *self);
171 /** modest_tny_account_store_get_local_folders_account:
172 * @self: a TnyAccountStore instance
174 * Get the user-visible local folders account. It returns a new
175 * reference so the caller must unref it when no longer needed
177 TnyAccount * modest_tny_account_store_get_local_folders_account (ModestTnyAccountStore *self);
180 * modest_tny_account_store_get_mmc_folders_account:
181 * @self: a TnyAccountStore instance
183 * Get the mmc folders account.
185 * Returns: a #TnyAccount, or %NULL if no mmc account is available
186 * now. It returns a new reference so the caller must unref it when no
189 TnyAccount * modest_tny_account_store_get_mmc_folders_account (ModestTnyAccountStore *self);
191 /** modest_tny_account_store_forget_already_asked:
192 * @self: a TnyAccountStore instance
193 * @account: the account to forget the already asked status for
195 * Forget the already asked status of an account
197 void modest_tny_account_store_forget_already_asked (ModestTnyAccountStore *self, TnyAccount *account);
200 * modest_tny_account_store_find_msg_in_outboxes:
201 * @self: a #ModestTnyAccountStore
202 * @uri: the uri of the message
203 * @ac_out: output attribute, %NULL, or the #TnyAccount of the message
205 * finds a message in the set of outboxes, using the uri.
207 * Returns: %NULL or a #TnyMsg
209 TnyMsg *modest_tny_account_store_find_msg_in_outboxes (ModestTnyAccountStore *self,
211 TnyAccount **ac_out);
215 * modest_tny_account_store_get_transport_account_from_outbox_header:
216 * @self: a #ModestTnyAccountStore
217 * @header: a #TnyHeader
219 * Gets the transport account from a header that is in the outbox
221 * Returns: %NULL or a %TnyTransportAccount. Returns a new reference
222 * so the caller must unref it when no longer needed
224 TnyTransportAccount * modest_tny_account_store_get_transport_account_from_outbox_header(ModestTnyAccountStore *self,
228 * modest_tny_account_store_new_connection_specific_transport_account:
229 * @self: a #ModestTnyAccountStore
230 * @name: the name of the connection specific smtp transport account
232 * Creates a connection specific transport account and put it in the merged outbox
234 * Returns: the new #TnyTransportAccount
236 TnyTransportAccount * modest_tny_account_store_new_connection_specific_transport_account (ModestTnyAccountStore *self,
239 typedef void (*ModestTnyAccountStoreShutdownCallback) (ModestTnyAccountStore *account_store, gpointer userdata);
242 * modest_tny_account_store_shutdown:
243 * @self: a #ModestTnyAccountStore
244 * @callback: a #ModestTnyAccountStoreShutdownCallback
245 * @userdata: a #gpointer
247 * Disconnects all registered accounts (forcing syncs for all of them).
249 void modest_tny_account_store_shutdown (ModestTnyAccountStore *self,
250 ModestTnyAccountStoreShutdownCallback callback,
254 * modest_tny_account_store_is_shutdown:
255 * @self: a #ModestTnyAccountStore
257 * Check if all accounts are disconnected
259 * Returns: %TRUE if all accounts are disconnected, %FALSE otherwise.
261 gboolean modest_tny_account_store_is_shutdown (ModestTnyAccountStore *self);
264 * modest_tny_account_store_is_send_mail_blocked:
265 * @self: a #ModestTnyAccountStore
267 * Tells if we've 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 * Returns: %TRUE if sending mail is blocked
273 gboolean modest_tny_account_store_is_send_mail_blocked (ModestTnyAccountStore *self);
276 * modest_tny_account_store_set_send_mail_blocked:
277 * @self: a #ModestTnyAccountStore
278 * @blocked: a #gboolean
280 * Sets as blocked/non blocked the send queue flush attempts temporally. This is
281 * usually done when we're editing an account, to prevent sending mails as
282 * it can cause problems
284 void modest_tny_account_store_set_send_mail_blocked (ModestTnyAccountStore *self, gboolean blocked);
286 guint modest_tny_account_store_get_num_remote_accounts (ModestTnyAccountStore *self);
289 * modest_tny_account_store_start_send_queues:
290 * @self: a #ModestTnyAccountStore
292 * Instantiates the send queues for the available transport
293 * accounts. Note that send queues will start to listen to
294 * connection-changed signals to try to send pending emails ASAP
296 void modest_tny_account_store_start_send_queues (ModestTnyAccountStore *self);
299 * modest_utils_check_disk_full_error:
300 * @parent_window: a #GtkWidget that will be used as the parent of information banners that will be shown
302 * @alternate: a string that contains the error that will be shown if
303 * the memory full conditions happen in the MMC external storage
305 * Shows an information banner if the passed #GError is a disk full error.
307 * Returns: TRUE if it's a disk full error, false otherwise
309 gboolean modest_tny_account_store_check_disk_full_error (ModestTnyAccountStore *self,
310 GtkWidget *parent_window,
313 const gchar *alternate);
316 * modest_utils_is_disk_full_error:
318 * @mail_op: the #ModestMailOperation that returned the error
319 * @is_mmc: returns if the disk full error happens in the external MMC or not
321 * This function returns if the given #GError is a disk full error or
322 * not, whithout showing anything to the user. The optional #is_mmc
323 * returns TRUE if the disk full conditions happen in the external MMC
326 * Returns: TRUE if is a memory full error, FALSE otherwise.
328 gboolean modest_tny_account_store_is_disk_full_error (ModestTnyAccountStore *self,
330 TnyAccount *account);
334 * modest_tny_account_store_forget_password_in_memory
335 * @self: a TnyAccountStore instance
336 * @account: A server account.
338 * Forget any password stored in memory for this account.
339 * For instance, this should be called when the user has changed the password in the account settings.
341 void modest_tny_account_store_forget_password_in_memory (ModestTnyAccountStore *self,
342 const gchar *server_account_name);
346 #endif /* __MODEST_TNY_ACCOUNT_STORE_H__ */