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 #ifndef __MODEST_ACCOUNT_MGR_HELPERS_H__
32 #define __MODEST_ACCOUNT_MGR_HELPERS_H__
34 #include <modest-account-mgr.h>
35 #include <modest-tny-account-store.h>
37 #include <tny-account.h>
38 #include <tny-store-account.h>
39 #include <tny-transport-account.h>
44 TnyAccount *tny_account;
51 } ModestServerAccountData;
59 ModestServerAccountData *transport_account;
60 ModestServerAccountData *store_account;
66 * modest_account_mgr_get_account_data:
67 * @self: a ModestAccountMgr instance
68 * @name: the name of the account
70 * get information about an account
72 * Returns: a ModestAccountData structure with information about the account.
73 * the data should not be changed, and be freed with modest_account_mgr_free_account_data
74 * The function does a sanity check, an if it's not returning NULL,
75 * it is a valid account
77 ModestAccountData *modest_account_mgr_get_account_data (ModestAccountMgr *self,
81 * modest_account_mgr_get_default_account:
82 * @self: a ModestAccountMgr instance
84 * get the default account name, or NULL if none is found
86 * Returns: the default account name (as newly allocated string, which
87 * must be g_free'd), or NULL
89 gchar* modest_account_mgr_get_default_account (ModestAccountMgr *self);
92 * modest_account_mgr_get_default_account:
93 * @self: a ModestAccountMgr instance
94 * @account: the name of an existing account
96 * set the default account name (which must be valid account)
98 * Returns: TRUE if succeeded, FALSE otherwise
100 gboolean modest_account_mgr_set_default_account (ModestAccountMgr *self,
101 const gchar* account);
104 * modest_account_mgr_free_account_data:
105 * @self: a ModestAccountMgr instance
106 * @data: a ModestAccountData instance
108 * free the account data structure
110 void modest_account_mgr_free_account_data (ModestAccountMgr *self,
111 ModestAccountData *data);
116 * modest_account_mgr_set_enabled
117 * @self: a ModestAccountMgr instance
118 * @name: the account name
119 * @enabled: if TRUE, the account will be enabled, if FALSE, it will be disabled
121 * enable/disabled an account
123 * Returns: TRUE if it worked, FALSE otherwise
125 gboolean modest_account_mgr_set_enabled (ModestAccountMgr *self, const gchar* name,
129 * modest_account_mgr_get_enabled:
130 * @self: a ModestAccountMgr instance
131 * @name: the account name to check
133 * check whether a certain account is enabled
135 * Returns: TRUE if it is enabled, FALSE otherwise
137 gboolean modest_account_mgr_get_enabled (ModestAccountMgr *self, const gchar* name);
142 * modest_account_mgr_get_tny_account:
143 * @self: a #ModestAccountMgr instance
144 * @name: the account name
145 * @type: the #TnyAccountType to check; either TNY_ACCOUNT_TYPE_TRANSPORT or TNY_ACCOUNT_TYPE_STORE
147 * get the TnyAccount corresponding to the store/transport (server) accounts for some account.
148 * ie., every account has two server accounts, and for every server account there is a corresponding
151 * Returns: the requested TnyAccount, or NULL in case of error
153 TnyAccount* modest_account_mgr_get_tny_account (ModestAccountMgr *self, const gchar* name,
154 TnyAccountType type);
157 * modest_account_mgr_get_from_string
158 * @self: a #ModestAccountMgr instance
159 * @name: the account name
161 * get the From: string for some account; ie. "Foo Bar" <foo.bar@cuux.yy>"
163 * Returns: the newly allocated from-string, or NULL in case of error
165 gchar * modest_account_mgr_get_from_string (ModestAccountMgr *self, const gchar* name);
170 #endif /* __MODEST_ACCOUNT_MGR_H__ */