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 * TnyAccount Decorator
34 #ifndef __MODEST_TNY_ACCOUNT_H__
35 #define __MODEST_TNY_ACCOUNT_H__
37 #include <tny-account.h>
38 #include <tny-folder.h>
39 #include <modest-account-mgr.h>
40 #include <modest-local-folder-info.h>
41 #include <tny-session-camel.h>
50 * modest_tny_account_new_from_account:
51 * @account_mgr: a valid account mgr instance
52 * @account_name: the modest account name for which to create a corresponding tny account of the given type.
53 * @type: the type of account to create (TNY_ACCOUNT_TYPE_STORE or TNY_ACCOUNT_TYPE_TRANSPORT)
54 * @session: a tny camel session
55 * @get_pass_func: the get-password function
56 * @forget_pass_func: the forget-password function
58 * get a tnyaccount corresponding to the server_accounts (store or transport) for this account.
60 * Returns: a new TnyAccount or NULL in case of error.
63 modest_tny_account_new_from_account (ModestAccountMgr *account_mgr, const gchar *account_name,
65 TnySessionCamel *session,
66 TnyGetPassFunc get_pass_func,
67 TnyForgetPassFunc forget_pass_func);
71 * modest_tny_account_update_from_account:
72 * @tny_account: a valid tny_account
74 * update a tnyaccount corresponding to the server_accounts (store or transport) for this account.
76 * Returns: a TRUE or FALSE in case of error.
79 modest_tny_account_update_from_account (TnyAccount *tny_account);
83 * modest_tny_account_new_for_local_folders:
84 * @account_mgr: a valid account mgr instance
85 * @session: a tny camel session
86 * @location_filepath: The location at which the local-folders directory exists, or NULL to specify $HOME.
88 * get the local folders (pseudo) account; you should only need one such account.
90 * Returns: a new local folders TnyAccount or NULL in case of error.
92 TnyAccount* modest_tny_account_new_for_local_folders (ModestAccountMgr *account_mgr,
93 TnySessionCamel *session,
94 const gchar* location_filepath);
97 * modest_tny_account_new_for_per_account_local_outbox_folder:
98 * @account_mgr: a valid account mgr instance
99 * @account_name: a modest account name.
100 * @session: a tny camel session
102 * get the per-account local outbox folder (pseudo) account.
104 * Returns: a new per-account local outbox folder TnyAccount or NULL in case of error.
106 TnyAccount* modest_tny_account_new_for_per_account_local_outbox_folder (
107 ModestAccountMgr *account_mgr, const gchar* account_name,
108 TnySessionCamel *session);
111 * modest_tny_account_new_from_server_account_name:
112 * @account_mgr: a valid account mgr instance
113 * @session: a valid TnySessionCamel instance.
114 * @server_account_name: the name of a server account in the configuration system.
116 * Returns: a new TnyAccount or NULL in case of error.
119 modest_tny_account_new_from_server_account_name (ModestAccountMgr *account_mgr,
120 TnySessionCamel *session,
121 const gchar* server_account_name,
122 TnyGetPassFunc get_pass_func,
123 TnyForgetPassFunc forget_pass_func);
127 * modest_tny_account_new_from_server_account_name:
128 * @tny_account: a valid tny account
129 * @account_mgr: a valid account mgr instance
130 * @server_account_name: the name of a server account in the configuration system.
132 * update the given tny account; note that you cannot change the protocol type
134 * Returns: a new TnyAccount or NULL in case of error.
136 gboolean modest_tny_account_update_from_server_account_name (TnyAccount *tny_account,
137 ModestAccountMgr *account_mgr,
138 const gchar *server_account_name);
142 * modest_tny_account_get_special_folder:
143 * @self: a TnyAccount
144 * @special_type: the special folder to get
146 * get the special (Inbox,Outbox,Sent,Draft etc.) folder for this server account's parent modest account.
147 * Note: currently, the implementation will always return a local folder for this.
148 * This can be changed later to return really account-specific special folders,
149 * such as (for example) server-side Sent/Junk mail for IMAP accounts
151 * Returns: the tny folder corresponding to this special folder, or NULL in case
152 * of error, or if the special folder does not exist for this account.
153 * This must be unrefed with g_object_unref().
155 TnyFolder* modest_tny_account_get_special_folder (TnyAccount *self,
156 TnyFolderType special_type);
160 * modest_tny_folder_store_get_folder_count:
161 * @self: a #TnyFolderStore
163 * gets the number of folders of the account
165 * Returns: the number of folder, or -1 in case of error
167 gint modest_tny_folder_store_get_folder_count (TnyFolderStore *self);
170 * modest_tny_folder_store_get_message_count:
173 * gets the number of messages in the account
175 * Returns: the number of messages, or -1 in case of error
177 gint modest_tny_folder_store_get_message_count (TnyFolderStore *self);
180 * modest_tny_folder_store_get_local_size:
183 * gets the total size occupied by the account in the local storage
186 * Returns: the total size in bytes, or -1 in case of error
188 gint modest_tny_folder_store_get_local_size (TnyFolderStore *self);
190 /** modest_tny_account_get_parent_modest_account_name_for_server_account:
191 * Get the name of the parent modest account of which the server account is a part.
193 const gchar* modest_tny_account_get_parent_modest_account_name_for_server_account (TnyAccount *self);
195 /** modest_tny_account_set_parent_modest_account_name_for_server_account:
196 * Set the name of the parent modest account of which the server account is a part,
197 * so it can be retrieved later with
198 * modest_tny_account_get_parent_modest_account_name_for_server_account().
200 void modest_tny_account_set_parent_modest_account_name_for_server_account (TnyAccount *account, const gchar* parent_modest_acount_name);
203 typedef void (*ModestTnyAccountGetMmcAccountNameCallback) (TnyStoreAccount* self, gpointer user_data);
205 /** modest_tny_account_get_mmc_account_name:
206 * Asnchronously get the name of a memory card account and set it in the TnyAccount,
207 * calling the callback (if not NULL) to notify that the name is changed.
208 * if the name was changed. The callback will not be called if the name was not changed.
210 void modest_tny_account_get_mmc_account_name (TnyStoreAccount* self,
211 ModestTnyAccountGetMmcAccountNameCallback callback,
215 /** modest_tny_account_is_virtual_local_folders:
216 * @self A TnyAccount.
218 * A convenience function to identify whether TnyAccount
219 * is the virtual local folders account, containing the folders from local_folders/
220 * and the outboxes from outboxes/<account-name>/.
222 gboolean modest_tny_account_is_virtual_local_folders (TnyAccount *self);
224 /** modest_tny_account_is_memory_card_account:
225 * @self A TnyAccount.
227 * A convenience function to identify whether TnyAccount
228 * is the memory card account.
230 gboolean modest_tny_account_is_memory_card_account (TnyAccount *self);
235 #endif /* __MODEST_TNY_ACCOUNT_H__*/