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