git.maemo.org Git - modest/blob - src/modest-tny-account.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  * TnyAccount Decorator
  32  */
  33
  34 #ifndef __MODEST_TNY_ACCOUNT_H__
  35 #define __MODEST_TNY_ACCOUNT_H__
  36
  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>
  42
  43 G_BEGIN_DECLS
  44
  45
  46
  47
  48
  49 /**
  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
  57  *
  58  * get a tnyaccount corresponding to the server_accounts (store or transport) for this account.
  59  *
  60  * Returns: a new TnyAccount or NULL in case of error.
  61  */
  62 TnyAccount*
  63 modest_tny_account_new_from_account (ModestAccountMgr *account_mgr, const gchar *account_name,
  64                                      TnyAccountType type,
  65                                      TnySessionCamel *session,
  66                                      TnyGetPassFunc get_pass_func,
  67                                      TnyForgetPassFunc forget_pass_func);
  68
  69
  70 /**
  71  * modest_tny_account_update_from_account:
  72  * @tny_account: a valid tny_account
  73  *
  74  * update a tnyaccount corresponding to the server_accounts (store or transport) for this account.
  75  *
  76  * Returns: a TRUE or FALSE in case of error.
  77  */
  78 gboolean
  79 modest_tny_account_update_from_account (TnyAccount *tny_account,
  80                                         TnyGetPassFunc get_pass_func,
  81                                         TnyForgetPassFunc forget_pass_func);
  82
  83
  84 /**
  85  * modest_tny_account_new_for_local_folders:
  86  * @account_mgr: a valid account mgr instance
  87  * @session: a tny camel session
  88  * @location_filepath: The location at which the local-folders directory exists, or NULL to specify $HOME.
  89  *
  90  * get the local folders (pseudo) account; you should only need one such account.
  91  *
  92  * Returns: a new local folders TnyAccount or NULL in case of error.
  93  */
  94 TnyAccount* modest_tny_account_new_for_local_folders (ModestAccountMgr *account_mgr,
  95                                                       TnySessionCamel *session,
  96                                                       const gchar* location_filepath);
  97
  98 /**
  99  * modest_tny_account_new_for_per_account_local_outbox_folder:
 100  * @account_mgr: a valid account mgr instance
 101  * @account_name: a modest account name.
 102  * @session: a tny camel session
 103  *
 104  * get the per-account local outbox folder (pseudo) account.
 105  *
 106  * Returns: a new per-account local outbox folder TnyAccount or NULL in case of error.
 107  */
 108 TnyAccount* modest_tny_account_new_for_per_account_local_outbox_folder (
 109         ModestAccountMgr *account_mgr, const gchar* account_name,
 110         TnySessionCamel *session);
 111
 112 /**
 113  * modest_tny_account_new_from_server_account_name:
 114  * @account_mgr: a valid account mgr instance
 115  * @session: a valid TnySessionCamel instance.
 116  * @server_account_name: the name of a server account in the configuration system.
 117  *
 118  * Returns: a new TnyAccount or NULL in case of error.
 119  */
 120 TnyAccount*
 121 modest_tny_account_new_from_server_account_name (ModestAccountMgr *account_mgr,
 122                                                  TnySessionCamel *session,
 123                                                  const gchar* server_account_name,
 124                                                  TnyGetPassFunc get_pass_func,
 125                                                  TnyForgetPassFunc forget_pass_func);
 126
 127 /**
 128  * modest_tny_account_get_special_folder:
 129  * @self: a TnyAccount
 130  * @special_type: the special folder to get
 131  *
 132  * get the special (Inbox,Outbox,Sent,Draft etc.) folder for this server account's parent modest account.
 133  * Note: currently, the implementation will always return a local folder for this.
 134  * This can be changed later to return really account-specific special folders,
 135  * such as (for example) server-side Sent/Junk mail for IMAP accounts
 136  *
 137  * Returns: the tny folder corresponding to this special folder, or NULL in case
 138  * of error, or if the special folder does not exist for this account.
 139  * This must be unrefed with g_object_unref().
 140  */
 141 TnyFolder*    modest_tny_account_get_special_folder   (TnyAccount *self,
 142                                                        TnyFolderType special_type);
 143
 144
 145 /**
 146  * modest_tny_folder_store_get_folder_count:
 147  * @self: a #TnyFolderStore
 148  *
 149  * gets the number of folders of the account
 150  *
 151  * Returns: the number of folder, or -1 in case of error
 152  **/
 153 gint          modest_tny_folder_store_get_folder_count  (TnyFolderStore *self);
 154
 155 /**
 156  * modest_tny_folder_store_get_message_count:
 157  * @self:
 158  *
 159  * gets the number of messages in the account
 160  *
 161  * Returns: the number of messages, or -1 in case of error
 162  **/
 163 gint          modest_tny_folder_store_get_message_count (TnyFolderStore *self);
 164
 165 /**
 166  * modest_tny_folder_store_get_local_size:
 167  * @self:
 168  *
 169  * gets the total size occupied by the account in the local storage
 170  * device
 171  *
 172  * Returns: the total size in bytes, or -1 in case of error
 173  **/
 174 gint          modest_tny_folder_store_get_local_size    (TnyFolderStore *self);
 175
 176 /**
 177  * modest_tny_folder_store_is_remote:
 178  * @folder_store: The folder store (folder or account) that needs to
 179  * decide if need a connection in subsequent operations.
 180  * @return value: Whether a connection is necessary for this folder_store.
 181  */
 182 gboolean modest_tny_folder_store_is_remote (TnyFolderStore *self);
 183
 184 /** modest_tny_account_get_parent_modest_account_name_for_server_account:
 185  * Get the name of the parent modest account of which the server account is a part.
 186  */
 187 const gchar* modest_tny_account_get_parent_modest_account_name_for_server_account (TnyAccount *self);
 188
 189 /** modest_tny_account_set_parent_modest_account_name_for_server_account:
 190  * Set the name of the parent modest account of which the server account is a part,
 191  * so it can be retrieved later with
 192  * modest_tny_account_get_parent_modest_account_name_for_server_account().
 193  */
 194 void modest_tny_account_set_parent_modest_account_name_for_server_account (TnyAccount *account, const gchar* parent_modest_acount_name);
 195
 196
 197 typedef void (*ModestTnyAccountGetMmcAccountNameCallback) (TnyStoreAccount* self, gpointer user_data);
 198
 199 /** modest_tny_account_get_mmc_account_name:
 200  * Asnchronously get the name of a memory card account and set it in the TnyAccount,
 201  * calling the callback (if not NULL) to notify that the name is changed.
 202  * if the name was changed. The callback will not be called if the name was not changed.
 203  */
 204 void modest_tny_account_get_mmc_account_name (TnyStoreAccount* self,
 205                                               ModestTnyAccountGetMmcAccountNameCallback callback,
 206                                               gpointer user_data);
 207
 208
 209 /** modest_tny_account_is_virtual_local_folders:
 210  * @self A TnyAccount.
 211  *
 212  * A convenience function to identify whether TnyAccount
 213  * is the virtual local folders account, containing the folders from local_folders/
 214  * and the outboxes from outboxes/<account-name>/.
 215  **/
 216 gboolean modest_tny_account_is_virtual_local_folders (TnyAccount *self);
 217
 218 /** modest_tny_account_is_memory_card_account:
 219  * @self A TnyAccount.
 220  *
 221  * A convenience function to identify whether TnyAccount
 222  * is the memory card account.
 223  **/
 224 gboolean modest_tny_account_is_memory_card_account (TnyAccount *self);
 225
 226
 227 G_END_DECLS
 228
 229 #endif /* __MODEST_TNY_ACCOUNT_H__*/