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 <tny-account-store.h>
38 #include <tny-session-camel.h>
39 #include <tny-shared.h>
40 #include <tny-folder.h>
41 #include <modest-account-mgr.h>
42 #include <modest-tny-local-folders-account.h>
43 #include <gtk/gtkwidget.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;
92 * modest_tny_account_store_get_type:
94 * Returns: GType of the account store
96 GType modest_tny_account_store_get_type (void) G_GNUC_CONST;
99 * modest_tny_account_store_new:
100 * @account_mgr: account manager to use for new account store
102 * creates new (tinymail) account store for account manager modest_acc_mgr
104 * Returns: newly created account store or NULL in case of error
106 ModestTnyAccountStore* modest_tny_account_store_new (ModestAccountMgr *account_mgr,
111 * modest_tny_account_store_get_account_by
112 * @self: a ModestTnyAccountStore instance
115 * get the account with the given str or NULL if it's not found
117 * Returns: the tnyaccount or NULL,
118 * g_object_unref when it's no longer needed
120 TnyAccount* modest_tny_account_store_get_tny_account_by (ModestTnyAccountStore *self,
121 ModestTnyAccountStoreQueryType type,
125 * modest_tny_account_store_get_server_account
126 * @self: a ModestTnyAccountStore instance
127 * @account_name: a modest account name
128 * @type: the tny account type (#TNY_ACCOUNT_TYPE_STORE or #TNY_ACCOUNT_TYPE_STORE)
130 * Get the tny account corresponding to one of the server_accounts for account with @account_name
132 * Returns: the tnyaccount for the server account or NULL in case it's not found or error,
133 * g_object_unref when it's no longer needed. TODO: Check that callers are unreffing.
135 TnyAccount* modest_tny_account_store_get_server_account (ModestTnyAccountStore *self,
136 const gchar *account_name,
137 TnyAccountType type);
140 * modest_tny_account_store_get_transport_account_for_open_connection
141 * @self: a ModestTnyAccountStore instance
142 * @account_name: an account name
144 * Get the tny account corresponding to the transport server account for the account with @account_name,
145 * returning the connection-specific SMTP-server transport server account if one is specified,
146 * otherwise just returning the regular transport server account.
148 * Returns: the tnyaccount for the server account or NULL in case it's not found or error,
149 * g_object_unref when it's no longer needed
151 TnyAccount* modest_tny_account_store_get_transport_account_for_open_connection (ModestTnyAccountStore *self,
152 const gchar *account_name);
154 TnyAccount* modest_tny_account_store_get_smtp_specific_transport_account_for_open_connection (ModestTnyAccountStore *self,
155 const gchar *account_name);
158 * tny_account_store_get_session
159 * @self: a TnyAccountStore instance
161 * get the tny-camel-session for this account store. Note that this function
162 * does NOT have the modest_ prefix, as tinymail requires the symbol to be like this...
164 * Returns: a tny-camel-session
166 TnySessionCamel* modest_tny_account_store_get_session (TnyAccountStore *self);
168 /** modest_tny_account_store_get_local_folders_account:
169 * @self: a TnyAccountStore instance
171 * Get the user-visible local folders account. It returns a new
172 * reference so the caller must unref it when no longer needed
174 TnyAccount * modest_tny_account_store_get_local_folders_account (ModestTnyAccountStore *self);
177 * modest_tny_account_store_get_mmc_folders_account:
178 * @self: a TnyAccountStore instance
180 * Get the mmc folders account.
182 * Returns: a #TnyAccount, or %NULL if no mmc account is available
183 * now. It returns a new reference so the caller must unref it when no
186 TnyAccount * modest_tny_account_store_get_mmc_folders_account (ModestTnyAccountStore *self);
188 /** modest_tny_account_store_forget_already_asked:
189 * @self: a TnyAccountStore instance
190 * @account: the account to forget the already asked status for
192 * Forget the already asked status of an account
194 void modest_tny_account_store_forget_already_asked (ModestTnyAccountStore *self, TnyAccount *account);
197 * modest_tny_account_store_find_msg_in_outboxes:
198 * @self: a #ModestTnyAccountStore
199 * @uri: the uri of the message
200 * @ac_out: output attribute, %NULL, or the #TnyAccount of the message
202 * finds a message in the set of outboxes, using the uri.
204 * Returns: %NULL or a #TnyMsg
206 TnyMsg *modest_tny_account_store_find_msg_in_outboxes (ModestTnyAccountStore *self,
208 TnyAccount **ac_out);
212 * modest_tny_account_store_get_transport_account_from_outbox_header:
213 * @self: a #ModestTnyAccountStore
214 * @header: a #TnyHeader
216 * Gets the transport account from a header that is in the outbox
218 * Returns: %NULL or a %TnyTransportAccount. Returns a new reference
219 * so the caller must unref it when no longer needed
221 TnyTransportAccount * modest_tny_account_store_get_transport_account_from_outbox_header(ModestTnyAccountStore *self,
225 * modest_tny_account_store_new_connection_specific_transport_account:
226 * @self: a #ModestTnyAccountStore
227 * @name: the name of the connection specific smtp transport account
229 * Creates a connection specific transport account and put it in the merged outbox
231 * Returns: the new #TnyTransportAccount
233 TnyTransportAccount * modest_tny_account_store_new_connection_specific_transport_account (ModestTnyAccountStore *self,
236 typedef void (*ModestTnyAccountStoreShutdownCallback) (ModestTnyAccountStore *account_store, gpointer userdata);
239 * modest_tny_account_store_shutdown:
240 * @self: a #ModestTnyAccountStore
241 * @callback: a #ModestTnyAccountStoreShutdownCallback
242 * @userdata: a #gpointer
244 * Disconnects all registered accounts (forcing syncs for all of them).
246 void modest_tny_account_store_shutdown (ModestTnyAccountStore *self,
247 ModestTnyAccountStoreShutdownCallback callback,
252 * modest_tny_account_store_is_send_mail_blocked:
253 * @self: a #ModestTnyAccountStore
255 * Tells if we've blocked the send queue flush attempts temporally. This is
256 * usually done when we're editing an account, to prevent sending mails as
257 * it can cause problems
259 * Returns: %TRUE if sending mail is blocked
261 gboolean modest_tny_account_store_is_send_mail_blocked (ModestTnyAccountStore *self);
264 * modest_tny_account_store_set_send_mail_blocked:
265 * @self: a #ModestTnyAccountStore
266 * @blocked: a #gboolean
268 * Sets as blocked/non blocked the send queue flush attempts temporally. This is
269 * usually done when we're editing an account, to prevent sending mails as
270 * it can cause problems
272 void modest_tny_account_store_set_send_mail_blocked (ModestTnyAccountStore *self, gboolean blocked);
274 guint modest_tny_account_store_get_num_remote_accounts (ModestTnyAccountStore *self);
278 #endif /* __MODEST_TNY_ACCOUNT_STORE_H__ */