git.maemo.org Git - modest/blob - src/modest-account-mgr-helpers.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 #ifndef __MODEST_ACCOUNT_MGR_HELPERS_H__
  32 #define __MODEST_ACCOUNT_MGR_HELPERS_H__
  33
  34 #include <modest-account-mgr.h>
  35 #include <modest-tny-account-store.h>
  36
  37 #include <tny-account.h>
  38 #include <tny-store-account.h>
  39 #include <tny-transport-account.h>
  40
  41 G_BEGIN_DECLS
  42
  43 typedef struct {
  44         gchar            *account_name;
  45         gchar            *hostname;
  46         gchar            *username;
  47         gchar            *uri;
  48         ModestProtocol    proto; /*< The store or transport. Not ORed. */
  49         gchar            *password;
  50         time_t            last_updated;
  51         GSList           *options;
  52 } ModestServerAccountData;
  53
  54 typedef struct {
  55         gchar            *account_name;
  56         gchar            *display_name;
  57         gchar            *fullname;
  58         gchar            *email;
  59         gboolean         is_enabled;
  60         gboolean         is_default;
  61         ModestServerAccountData *transport_account;
  62         ModestServerAccountData *store_account;
  63 } ModestAccountData;
  64
  65
  66
  67 /**
  68  * modest_account_mgr_get_account_data:
  69  * @self: a ModestAccountMgr instance
  70  * @name: the name of the account
  71  *
  72  * get information about an account
  73  *
  74  * Returns: a ModestAccountData structure with information about the account.
  75  * the data should not be changed, and be freed with modest_account_mgr_free_account_data
  76  * The function does a sanity check, an if it's not returning NULL,
  77  * it is a valid account
  78  */
  79 ModestAccountData *modest_account_mgr_get_account_data     (ModestAccountMgr *self,
  80                                                             const gchar* name);
  81
  82 /**
  83  * modest_account_mgr_get_default_account:
  84  * @self: a ModestAccountMgr instance
  85  *
  86  * get the default account name, or NULL if none is found
  87  *
  88  * Returns: the default account name (as newly allocated string, which
  89  * must be g_free'd), or NULL
  90  */
  91 gchar* modest_account_mgr_get_default_account  (ModestAccountMgr *self);
  92
  93 /**
  94  * modest_account_mgr_get_default_account:
  95  * @self: a ModestAccountMgr instance
  96  * @account: the name of an existing account
  97  *
  98  * set the default account name (which must be valid account)
  99  *
 100  * Returns: TRUE if succeeded, FALSE otherwise
 101  */
 102 gboolean modest_account_mgr_set_default_account  (ModestAccountMgr *self,
 103                                                   const gchar* account);
 104
 105 /**
 106  * modest_account_mgr_free_account_data:
 107  * @self: a ModestAccountMgr instance
 108  * @data: a ModestAccountData instance
 109  *
 110  * free the account data structure
 111  */
 112 void       modest_account_mgr_free_account_data     (ModestAccountMgr *self,
 113                                                      ModestAccountData *data);
 114
 115 /**
 116  * modest_account_mgr_set_enabled
 117  * @self: a ModestAccountMgr instance
 118  * @name: the account name
 119  * @enabled: if TRUE, the account will be enabled, if FALSE, it will be disabled
 120  *
 121  * enable/disabled an account
 122  *
 123  * Returns: TRUE if it worked, FALSE otherwise
 124  */
 125 gboolean modest_account_mgr_set_enabled (ModestAccountMgr *self, const gchar* name,
 126                                          gboolean enabled);
 127
 128 /**
 129  * modest_account_mgr_get_enabled:
 130  * @self: a ModestAccountMgr instance
 131  * @name: the account name to check
 132  *
 133  * check whether a certain account is enabled
 134  *
 135  * Returns: TRUE if it is enabled, FALSE otherwise
 136  */
 137 gboolean modest_account_mgr_get_enabled (ModestAccountMgr *self, const gchar* name);
 138
 139 /**
 140  * modest_server_account_data_get_option_secure_auth:
 141  * @account_data: a ModestAccountData instance.
 142  *
 143  * Gets the secure authentication method for this server account.
 144  *
 145  * Returns: The secure authentication enum value.
 146  */
 147 ModestProtocol
 148 modest_server_account_data_get_option_secure_auth (ModestServerAccountData *account_data);
 149
 150 /**
 151  * modest_server_account_data_get_option_secure_auth:
 152  * @self: a ModestAccountMgr instance
 153  * @secure_auth: The secure authentication enum value.
 154  *
 155  * Gets the secure authentication method for this server account.
 156  */
 157 void
 158 modest_server_account_set_option_secure_auth (ModestAccountMgr *self, const gchar* account_name,
 159         ModestProtocol secure_auth);
 160
 161 /**
 162  * modest_server_account_data_get_option_security:
 163  * @account_data: a ModestAccountData instance.
 164  *
 165  * Gets the security method for this server account.
 166  *
 167  * Returns: The security enum value.
 168  */
 169 ModestProtocol
 170 modest_server_account_data_get_option_security (ModestServerAccountData *account_data);
 171
 172 /**
 173  * modest_server_account_set_option_security:
 174  * @self: a ModestAccountMgr instance
 175  * @secure_auth: The security enum value.
 176  *
 177  * Gets the security method for this server account.
 178  */
 179 void
 180 modest_server_account_set_option_security (ModestAccountMgr *self, const gchar* account_name,
 181         ModestProtocol security);
 182
 183 /**
 184  * modest_account_mgr_get_account_option:
 185  * @self: a ModestAccountMgr instance
 186  * @account_name: the account name to check
 187  * @account_name: the option name to check
 188  *
 189  * Returns: The account option value. This must be freed with g_free().
 190  */
 191 gchar* modest_account_mgr_get_server_account_option (ModestAccountMgr *self,
 192         const gchar* account_name, const gchar* option_name);
 193
 194 /**
 195  * modest_server_account_data_get_option_value:
 196  * @options_list: a ModestServerAccountData::options list.
 197  * @option_name: the option name to check
 198  *
 199  * Returns: The account option value. This must be freed with g_free().
 200  */
 201 gchar* modest_server_account_data_get_option_value (GSList* options_list, const gchar* option_name);
 202
 203 /**
 204  * modest_server_account_data_get_option_bool:
 205  * @options_list: a ModestServerAccountData::options list.
 206  * @option_name: the option name to check
 207  *
 208  * Returns: Whether the account option is present.
 209  */
 210 gboolean modest_server_account_data_get_option_bool (GSList* options_list, const gchar* option_name);
 211
 212
 213 /**
 214  * modest_account_mgr_get_from_string
 215  * @self: a #ModestAccountMgr instance
 216  * @name: the account name
 217  *
 218  * get the From: string for some account; ie. "Foo Bar" <foo.bar@cuux.yy>"
 219  *
 220  * Returns: the newly allocated from-string, or NULL in case of error
 221  */
 222 gchar * modest_account_mgr_get_from_string (ModestAccountMgr *self, const gchar* name);
 223
 224
 225 G_END_DECLS
 226
 227 #endif /* __MODEST_ACCOUNT_MGR_H__ */