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>
45 } ModestServerAccountData;
53 ModestServerAccountData *transport_account;
54 ModestServerAccountData *store_account;
60 * modest_account_mgr_get_account_data:
61 * @self: a ModestAccountMgr instance
62 * @name: the name of the account
64 * get information about an account
66 * Returns: a ModestAccountData structure with information about the account.
67 * the data should not be changed, and be freed with modest_account_mgr_free_account_data
68 * The function does a sanity check, an if it's not returning NULL,
69 * it is a valid account
71 ModestAccountData *modest_account_mgr_get_account_data (ModestAccountMgr *self,
75 * modest_account_mgr_get_default_account:
76 * @self: a ModestAccountMgr instance
78 * get the default account name, or NULL if none is found
80 * Returns: the default account name (as newly allocated string, which
81 * must be g_free'd), or NULL
83 gchar* modest_account_mgr_get_default_account (ModestAccountMgr *self);
86 * modest_account_mgr_get_default_account:
87 * @self: a ModestAccountMgr instance
88 * @account: the name of an existing account
90 * set the default account name (which must be valid account)
92 * Returns: TRUE if succeeded, FALSE otherwise
94 gboolean modest_account_mgr_set_default_account (ModestAccountMgr *self,
95 const gchar* account);
98 * modest_account_mgr_free_account_data:
99 * @self: a ModestAccountMgr instance
100 * @data: a ModestAccountData instance
102 * free the account data structure
104 void modest_account_mgr_free_account_data (ModestAccountMgr *self,
105 ModestAccountData *data);
110 * modest_account_mgr_account_set_enabled
111 * @self: a ModestAccountMgr instance
112 * @name: the account name
113 * @enabled: if TRUE, the account will be enabled, if FALSE, it will be disabled
115 * enable/disabled an account
117 * Returns: TRUE if it worked, FALSE otherwise
119 gboolean modest_account_mgr_account_set_enabled (ModestAccountMgr *self, const gchar* name,
123 * modest_account_mgr_account_get_enabled:
124 * @self: a ModestAccountMgr instance
125 * @name: the account name to check
127 * check whether a certain account is enabled
129 * Returns: TRUE if it is enabled, FALSE otherwise
131 gboolean modest_account_mgr_account_get_enabled (ModestAccountMgr *self, const gchar* name);
141 #endif /* __MODEST_ACCOUNT_MGR_H__ */