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>
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,
81 MODEST_TNY_ACCOUNT_STORE_QUERY_ID,
82 MODEST_TNY_ACCOUNT_STORE_QUERY_NAME,
83 MODEST_TNY_ACCOUNT_STORE_QUERY_URL,
84 } ModestTnyAccountStoreQueryType;
88 * modest_tny_account_store_get_type:
90 * Returns: GType of the account store
92 GType modest_tny_account_store_get_type (void) G_GNUC_CONST;
95 * modest_tny_account_store_new:
96 * @account_mgr: account manager to use for new account store
98 * creates new (tinymail) account store for account manager modest_acc_mgr
100 * Returns: newly created account store or NULL in case of error
102 ModestTnyAccountStore* modest_tny_account_store_new (ModestAccountMgr *account_mgr,
107 * modest_tny_account_store_get_account_by
108 * @self: a ModestTnyAccountStore instance
111 * get the account with the given str or NULL if it's not found
113 * Returns: the tnyaccount or NULL,
114 * g_object_unref when it's no longer needed
116 TnyAccount* modest_tny_account_store_get_tny_account_by (ModestTnyAccountStore *self,
117 ModestTnyAccountStoreQueryType type,
121 * modest_tny_account_store_get_server_account
122 * @self: a ModestTnyAccountStore instance
123 * @account_name: a modest account name
124 * @type: the tny account type (store or transport)
126 * Get the tny account corresponding to one of the server_accounts for account with @account_name
128 * Returns: the tnyaccount for the server account or NULL in case it's not found or error,
129 * g_object_unref when it's no longer needed
131 TnyAccount* modest_tny_account_store_get_server_account (ModestTnyAccountStore *self,
132 const gchar *account_name,
133 TnyAccountType type);
136 * modest_tny_account_store_get_transport_account_for_open_connection
137 * @self: a ModestTnyAccountStore instance
138 * @account_name: an account name
140 * Get the tny account corresponding to the transport server account for the account with @account_name,
141 * returning the connection-specific SMTP-server transport server account if one is specified,
142 * otherwise just returning the regular transport server account.
144 * Returns: the tnyaccount for the server account or NULL in case it's not found or error,
145 * g_object_unref when it's no longer needed
147 TnyAccount* modest_tny_account_store_get_transport_account_for_open_connection (ModestTnyAccountStore *self,
148 const gchar *account_name);
151 * tny_account_store_get_session
152 * @self: a TnyAccountStore instance
154 * get the tny-camel-session for this account store. Note that this function
155 * does NOT have the modest_ prefix, as tinymail requires the symbol to be like this...
157 * Returns: a tny-camel-session
159 TnySessionCamel* modest_tny_account_store_get_session (TnyAccountStore *self);
161 /** modest_tny_account_store_get_local_folders_account:
162 * @self: a TnyAccountStore instance
164 * Get the user-visible local folders account.
166 TnyAccount * modest_tny_account_store_get_local_folders_account (TnyAccountStore *self);
168 /** modest_tny_account_is_virtual_local_folders:
169 * @self A TnyAccount.
171 * A convenience function to identify whether TnyAccount
172 * is the virtual local folders account, containing the folders from local_folders/
173 * and the outboxes from outboxes/<account-name>/.
175 gboolean modest_tny_account_is_virtual_local_folders (TnyAccount *self);
179 #endif /* __MODEST_TNY_ACCOUNT_STORE_H__ */