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>
46 * modest_tny_account_new_from_account:
47 * @account_mgr: a valid account mgr instance
48 * @account_name: the account name for which to create a corresponding tny account
49 * @type: the type of account to create (TNY_ACCOUNT_TYPE_STORE or TNY_ACCOUNT_TYPE_TRANSPORT)
50 * @session: a tny camel session
51 * @get_pass_func: the get-password function
52 * @forget_pass_func: the forget-password function
54 * get a tnyaccount corresponding to the server_accounts (store or transport) for this account.
55 * NOTE: this function does not set the camel session or the get/forget password functions
57 * Returns: a new TnyAccount or NULL in case of error.
60 modest_tny_account_new_from_account (ModestAccountMgr *account_mgr, const gchar *account_name,
62 TnySessionCamel *session,
63 TnyGetPassFunc get_pass_func,
64 TnyForgetPassFunc forget_pass_func);
68 * modest_tny_account_new_for_local_folders:
69 * @account_mgr: a valid account mgr instance
70 * @session: a tny camel session
72 * get the local folders (pseudo) account; you should only need one such account.
74 * Returns: a new local folders TnyAccount or NULL in case of error.
76 TnyAccount* modest_tny_account_new_for_local_folders (ModestAccountMgr *account_mgr,
77 TnySessionCamel *session);
80 * modest_tny_account_new_for_per_account_local_outbox_folder:
81 * @account_mgr: a valid account mgr instance
82 * @account: a valid account instance
83 * @session: a tny camel session
85 * get the per-account local outbox folder (pseudo) account.
87 * Returns: a new per-account local outbox folder TnyAccount or NULL in case of error.
89 TnyAccount* modest_tny_account_new_for_per_account_local_outbox_folder (
90 ModestAccountMgr *account_mgr, TnyAccount *account,
91 TnySessionCamel *session);
94 * modest_tny_account_get_special_folder:
96 * @special_type: the special folder to get
98 * get the special (Inbox,Outbox,Sent,Draft etc.) folder for this account
99 * Note: currently, the implementation will always return a local folder for this.
100 * This can be changed later to return really account-specific special folders,
101 * such as (for example) server-side Sent/Junk mail for IMAP accounts
103 * Returns: the tny folder corresponding to this special folder, or NULL in case
104 * of error, or if the special folder does not exist for this account
106 TnyFolder* modest_tny_account_get_special_folder (TnyAccount *self,
107 TnyFolderType special_type);
111 * modest_tny_folder_store_get_folder_count:
112 * @self: a #TnyFolderStore
114 * gets the number of folders of the account
116 * Returns: the number of folder, or -1 in case of error
118 gint modest_tny_folder_store_get_folder_count (TnyFolderStore *self);
121 * modest_tny_folder_store_get_message_count:
124 * gets the number of messages in the account
126 * Returns: the number of messages, or -1 in case of error
128 gint modest_tny_folder_store_get_message_count (TnyFolderStore *self);
131 * modest_tny_folder_store_get_local_size:
134 * gets the total size occupied by the account in the local storage
137 * Returns: the total size in bytes, or -1 in case of error
139 gint modest_tny_folder_store_get_local_size (TnyFolderStore *self);
141 /** modest_tny_account_get_parent_modest_account_name_for_server_account:
142 * Get the name of the parent modest account of which the server account is a part.
144 const gchar* modest_tny_account_get_parent_modest_account_name_for_server_account (TnyAccount *self);
146 /** modest_tny_account_set_parent_modest_account_name_for_server_account:
147 * Set the name of the parent modest account of which the server account is a part,
148 * so it can be retrieved later with
149 * modest_tny_account_get_parent_modest_account_name_for_server_account().
151 void modest_tny_account_set_parent_modest_account_name_for_server_account (TnyAccount *self, const gchar* parent_modest_acount_name);
155 #endif /* __MODEST_TNY_ACCOUNT_H__*/