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