Do ignore empty recipients when checking names
[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 <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>
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         /* Signals */
80         void (*account_changed) (TnyAccountStore *self, TnyAccount *account);
81         void (*account_inserted) (TnyAccountStore *self, TnyAccount *account);
82         void (*account_removed) (TnyAccountStore *self, TnyAccount *account);
83 };
84
85 typedef enum {
86         MODEST_TNY_ACCOUNT_STORE_QUERY_ID,
87         MODEST_TNY_ACCOUNT_STORE_QUERY_URL,
88 } ModestTnyAccountStoreQueryType;
89
90
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
93
94 /**
95  * modest_tny_account_store_get_type:
96  *
97  * Returns: GType of the account store
98  */
99 GType  modest_tny_account_store_get_type   (void) G_GNUC_CONST;
100
101 /**
102  * modest_tny_account_store_new:
103  * @account_mgr: account manager to use for new account store
104  *
105  * creates new (tinymail) account store for account manager modest_acc_mgr
106  *
107  * Returns: newly created account store or NULL in case of error
108  */
109 ModestTnyAccountStore*    modest_tny_account_store_new (ModestAccountMgr *account_mgr,
110                                                         TnyDevice *device);
111
112
113 /**
114  * modest_tny_account_store_get_account_by 
115  * @self: a ModestTnyAccountStore instance
116  * @id: some ID
117  * 
118  * get the account with the given str or NULL if it's not found
119  * 
120  * Returns: the tnyaccount or NULL,
121  * g_object_unref when it's no longer needed
122  */
123 TnyAccount* modest_tny_account_store_get_tny_account_by  (ModestTnyAccountStore *self,
124                                                           ModestTnyAccountStoreQueryType type,
125                                                           const gchar *str);
126
127 /**
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)
132  * 
133  * Get the tny account corresponding to one of the server_accounts for account with @account_name
134  * 
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.
137  */
138 TnyAccount* modest_tny_account_store_get_server_account (ModestTnyAccountStore *self,
139                                                          const gchar *account_name,
140                                                          TnyAccountType type);
141
142 /**
143  * modest_tny_account_store_get_transport_account_for_open_connection
144  * @self: a ModestTnyAccountStore instance
145  * @account_name: an account name
146  * 
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.
150  * 
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
153  */                                              
154 TnyAccount* modest_tny_account_store_get_transport_account_for_open_connection (ModestTnyAccountStore *self,
155                                                                                 const gchar *account_name);
156
157 TnyAccount* modest_tny_account_store_get_smtp_specific_transport_account_for_open_connection (ModestTnyAccountStore *self,
158                                                                                               const gchar *account_name);
159
160 /**
161  * tny_account_store_get_session
162  * @self: a TnyAccountStore instance
163  * 
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...
166  *
167  * Returns: a tny-camel-session
168  */
169 TnySessionCamel*    modest_tny_account_store_get_session    (TnyAccountStore *self);
170
171 /** modest_tny_account_store_get_local_folders_account:
172  * @self: a TnyAccountStore instance
173  * 
174  * Get the user-visible local folders account. It returns a new
175  * reference so the caller must unref it when no longer needed
176  **/
177 TnyAccount * modest_tny_account_store_get_local_folders_account (ModestTnyAccountStore *self);
178
179 /**
180  * modest_tny_account_store_get_mmc_folders_account:
181  * @self: a TnyAccountStore instance
182  * 
183  * Get the mmc folders account.
184  *
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
187  * longer needed
188  */
189 TnyAccount * modest_tny_account_store_get_mmc_folders_account (ModestTnyAccountStore *self);
190
191 /** modest_tny_account_store_forget_already_asked:
192   * @self: a TnyAccountStore instance
193   * @account: the account to forget the already asked status for
194   *
195   * Forget the already asked status of an account
196   **/
197 void modest_tny_account_store_forget_already_asked (ModestTnyAccountStore *self, TnyAccount *account);
198
199 /**
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
204  *
205  * finds a message in the set of outboxes, using the uri.
206  *
207  * Returns: %NULL or a #TnyMsg
208  **/
209 TnyMsg *modest_tny_account_store_find_msg_in_outboxes (ModestTnyAccountStore *self, 
210                                                        const gchar *uri,
211                                                        TnyAccount **ac_out);
212
213
214 /**
215  * modest_tny_account_store_get_transport_account_from_outbox_header:
216  * @self: a #ModestTnyAccountStore
217  * @header: a #TnyHeader
218  *
219  * Gets the transport account from a header that is in the outbox
220  *
221  * Returns: %NULL or a %TnyTransportAccount. Returns a new reference
222  * so the caller must unref it when no longer needed
223  */
224 TnyTransportAccount * modest_tny_account_store_get_transport_account_from_outbox_header(ModestTnyAccountStore *self,
225                                                                                        TnyHeader *header);
226
227 /**
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
231  *
232  * Creates a connection specific transport account and put it in the merged outbox
233  *
234  * Returns: the new #TnyTransportAccount
235  */
236 TnyTransportAccount * modest_tny_account_store_new_connection_specific_transport_account (ModestTnyAccountStore *self,
237                                                                                           const gchar *name);
238
239 typedef void (*ModestTnyAccountStoreShutdownCallback) (ModestTnyAccountStore *account_store, gpointer userdata);
240
241 /**
242  * modest_tny_account_store_shutdown:
243  * @self: a #ModestTnyAccountStore
244  * @callback: a #ModestTnyAccountStoreShutdownCallback
245  * @userdata: a #gpointer
246  *
247  * Disconnects all registered accounts (forcing syncs for all of them).
248  */
249 void modest_tny_account_store_shutdown (ModestTnyAccountStore *self,
250                                         ModestTnyAccountStoreShutdownCallback callback,
251                                         gpointer userdata);
252
253 /**
254  * modest_tny_account_store_is_shutdown:
255  * @self: a #ModestTnyAccountStore
256  *
257  * Check if all accounts are disconnected
258  *
259  * Returns: %TRUE if all accounts are disconnected, %FALSE otherwise.
260  */
261 gboolean modest_tny_account_store_is_shutdown (ModestTnyAccountStore *self);
262
263 /**
264  * modest_tny_account_store_is_send_mail_blocked:
265  * @self: a #ModestTnyAccountStore
266  * 
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
270  *
271  * Returns: %TRUE if sending mail is blocked
272  */
273 gboolean modest_tny_account_store_is_send_mail_blocked (ModestTnyAccountStore *self);
274
275 /**
276  * modest_tny_account_store_set_send_mail_blocked:
277  * @self: a #ModestTnyAccountStore
278  * @blocked: a #gboolean
279  * 
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
283  */
284 void modest_tny_account_store_set_send_mail_blocked (ModestTnyAccountStore *self, gboolean blocked);
285
286 guint modest_tny_account_store_get_num_remote_accounts (ModestTnyAccountStore *self);
287
288 /**
289  * modest_tny_account_store_start_send_queues:
290  * @self: a #ModestTnyAccountStore
291  *
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
295  **/
296 void modest_tny_account_store_start_send_queues (ModestTnyAccountStore *self);
297
298 /**
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
301  * @err: a #GError
302  * @alternate: a string that contains the error that will be shown if
303  * the memory full conditions happen in the MMC external storage
304  *
305  * Shows an information banner if the passed #GError is a disk full error.
306  *
307  * Returns: TRUE if it's a disk full error, false otherwise
308  **/
309 gboolean modest_tny_account_store_check_disk_full_error (ModestTnyAccountStore *self,
310                                                          GtkWidget *parent_window,
311                                                          GError *err,
312                                                          TnyAccount *account,
313                                                          const gchar *alternate);
314
315 /**
316  * modest_utils_is_disk_full_error:
317  * @error: a #GError
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
320  *
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
324  * account
325  *
326  * Returns: TRUE if is a memory full error, FALSE otherwise.
327  **/
328 gboolean modest_tny_account_store_is_disk_full_error (ModestTnyAccountStore *self,
329                                                       GError *error,
330                                                       TnyAccount *account);
331
332
333 /**
334  * modest_tny_account_store_forget_password_in_memory
335  * @self: a TnyAccountStore instance
336  * @account: A server account.
337  *
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.
340  */
341 void    modest_tny_account_store_forget_password_in_memory (ModestTnyAccountStore *self,
342                                                             const gchar *server_account_name);
343
344 G_END_DECLS
345
346 #endif /* __MODEST_TNY_ACCOUNT_STORE_H__ */