6b01a28128908b007860aae3801defac821df4b0
[modest] / src / modest-tny-account-store.h
1 /* Copyright (c) 2006, Nokia Corporation
2  * All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *
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.
16  *
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.
28  */
29
30
31 /* modest-tny-account-store.h */
32
33 #ifndef __MODEST_TNY_ACCOUNT_STORE_H__
34 #define __MODEST_TNY_ACCOUNT_STORE_H__
35
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
45 /* other include files */
46
47 G_BEGIN_DECLS
48
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))
56
57 typedef struct _ModestTnyAccountStore      ModestTnyAccountStore;
58 typedef struct _ModestTnyAccountStoreClass ModestTnyAccountStoreClass;
59 typedef TnyGetPassFunc ModestTnyGetPassFunc;
60
61 struct _ModestTnyAccountStore {
62         GObject parent;
63 };
64
65 struct _ModestTnyAccountStoreClass {
66         GObjectClass parent_class;
67
68         void (*account_update)        (ModestTnyAccountStore *self,
69                                       const gchar *account_name,
70                                       gpointer user_data);
71         void (*password_requested)    (ModestTnyAccountStore *self,
72                                        const gchar *server_account_name,
73                                        gchar **username,
74                                        gchar **password,
75                                        gboolean *remember,
76                                        gboolean *cancel,
77                                        gpointer user_data);
78 };
79
80 typedef enum {
81         MODEST_TNY_ACCOUNT_STORE_QUERY_ID,
82         MODEST_TNY_ACCOUNT_STORE_QUERY_URL,
83 } ModestTnyAccountStoreQueryType;
84
85
86 /**
87  * modest_tny_account_store_get_type:
88  *
89  * Returns: GType of the account store
90  */
91 GType  modest_tny_account_store_get_type   (void) G_GNUC_CONST;
92
93 /**
94  * modest_tny_account_store_new:
95  * @account_mgr: account manager to use for new account store
96  *
97  * creates new (tinymail) account store for account manager modest_acc_mgr
98  *
99  * Returns: newly created account store or NULL in case of error
100  */
101 ModestTnyAccountStore*    modest_tny_account_store_new (ModestAccountMgr *account_mgr,
102                                                         TnyDevice *device);
103
104
105 /**
106  * modest_tny_account_store_get_account_by 
107  * @self: a ModestTnyAccountStore instance
108  * @id: some ID
109  * 
110  * get the account with the given str or NULL if it's not found
111  * 
112  * Returns: the tnyaccount or NULL,
113  * g_object_unref when it's no longer needed
114  */
115 TnyAccount* modest_tny_account_store_get_tny_account_by  (ModestTnyAccountStore *self,
116                                                           ModestTnyAccountStoreQueryType type,
117                                                           const gchar *str);
118
119 /**
120  * modest_tny_account_store_get_server_account
121  * @self: a ModestTnyAccountStore instance
122  * @account_name: a modest account name
123  * @type: the tny account type (store or transport)
124  * 
125  * Get the tny account corresponding to one of the server_accounts for account with @account_name
126  * 
127  * Returns: the tnyaccount for the server account or NULL in case it's not found or error,
128  * g_object_unref when it's no longer needed. TODO: Check that callers are unreffing.
129  */
130 TnyAccount* modest_tny_account_store_get_server_account (ModestTnyAccountStore *self,
131                                                          const gchar *account_name,
132                                                          TnyAccountType type);
133
134 /**
135  * modest_tny_account_store_get_transport_account_for_open_connection
136  * @self: a ModestTnyAccountStore instance
137  * @account_name: an account name
138  * 
139  * Get the tny account corresponding to the transport server account for the account with @account_name,
140  * returning the connection-specific SMTP-server transport server account if one is specified,
141  * otherwise just returning the regular transport server account.
142  * 
143  * Returns: the tnyaccount for the server account or NULL in case it's not found or error,
144  * g_object_unref when it's no longer needed
145  */                                              
146 TnyAccount* modest_tny_account_store_get_transport_account_for_open_connection (ModestTnyAccountStore *self,
147                                                                                 const gchar *account_name);
148
149 /**
150  * tny_account_store_get_session
151  * @self: a TnyAccountStore instance
152  * 
153  * get the tny-camel-session for this account store. Note that this function
154  * does NOT have the modest_ prefix, as tinymail requires the symbol to be like this...
155  *
156  * Returns: a tny-camel-session
157  */
158 TnySessionCamel*    modest_tny_account_store_get_session    (TnyAccountStore *self);
159
160 /** modest_tny_account_store_get_local_folders_account:
161  * @self: a TnyAccountStore instance
162  * 
163  * Get the user-visible local folders account.
164  **/
165 TnyAccount * modest_tny_account_store_get_local_folders_account (TnyAccountStore *self);
166
167 /** modest_tny_account_is_virtual_local_folders:
168  * @self A TnyAccount.
169  * 
170  * A convenience function to identify whether TnyAccount 
171  * is the virtual local folders account, containing the folders from local_folders/
172  * and the outboxes from outboxes/<account-name>/.
173  **/
174 gboolean modest_tny_account_is_virtual_local_folders (TnyAccount *self);
175
176 /** modest_tny_account_is_memory_card_account:
177  * @self A TnyAccount.
178  * 
179  * A convenience function to identify whether TnyAccount 
180  * is the memory card account.
181  **/
182 gboolean
183 modest_tny_account_is_memory_card_account (TnyAccount *self);
184
185 G_END_DECLS
186
187 #endif /* __MODEST_TNY_ACCOUNT_STORE_H__ */
188