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         gint             port; /* Or 0, if the default should be used. */
  52         ModestProtocol   secure_auth;
  53         ModestProtocol   security;
  54         GSList           *options;
  55 } ModestServerAccountData;
  56
  57 typedef struct {
  58         gchar            *account_name;
  59         gchar            *display_name;
  60         gchar            *fullname;
  61         gchar            *email;
  62         gboolean         is_enabled;
  63         gboolean         is_default;
  64         ModestServerAccountData *transport_account;
  65         ModestServerAccountData *store_account;
  66 } ModestAccountData;
  67
  68
  69
  70 /**
  71  * modest_account_mgr_get_account_data:
  72  * @self: a ModestAccountMgr instance
  73  * @name: the name of the account
  74  *
  75  * get information about an account
  76  *
  77  * Returns: a ModestAccountData structure with information about the account.
  78  * the data should not be changed, and be freed with modest_account_mgr_free_account_data
  79  * The function does a sanity check, an if it's not returning NULL,
  80  * it is a valid account
  81  */
  82 ModestAccountData *modest_account_mgr_get_account_data     (ModestAccountMgr *self,
  83                                                             const gchar* name);
  84
  85 /**
  86  * modest_account_mgr_get_default_account:
  87  * @self: a ModestAccountMgr instance
  88  *
  89  * get the default account name, or NULL if none is found
  90  *
  91  * Returns: the default account name (as newly allocated string, which
  92  * must be g_free'd), or NULL
  93  */
  94 gchar* modest_account_mgr_get_default_account  (ModestAccountMgr *self);
  95
  96 /**
  97  * modest_account_mgr_set_default_account:
  98  * @self: a ModestAccountMgr instance
  99  * @account: the name of an existing account
 100  *
 101  * set the default account name (which must be valid account)
 102  *
 103  * Returns: TRUE if succeeded, FALSE otherwise
 104  */
 105 gboolean modest_account_mgr_set_default_account  (ModestAccountMgr *self,
 106                                                   const gchar* account);
 107
 108 /**
 109  * modest_account_mgr_unset_default_account:
 110  * @self: a ModestAccountMgr instance
 111  * @account: the name of an account
 112  *
 113  * Unset the default account name, so that no account is the default.
 114  *
 115  * Returns: TRUE if succeeded, FALSE otherwise
 116  */
 117 gboolean modest_account_mgr_unset_default_account  (ModestAccountMgr *self);
 118
 119 /**
 120  * modest_account_mgr_set_first_account_as_default:
 121  * @self: a ModestAccountMgr instance
 122  *
 123  * Guarantees that at least one account, if there are any accounts, is the default,
 124  * so that modest_account_mgr_get_default_account() will return non-NULL if there
 125  * are any accounts.
 126  *
 127  * Returns: TRUE if succeeded, FALSE otherwise
 128  */
 129 gboolean
 130 modest_account_mgr_set_first_account_as_default  (ModestAccountMgr *self);
 131
 132 /**
 133  * modest_account_mgr_free_account_data:
 134  * @self: a ModestAccountMgr instance
 135  * @data: a ModestAccountData instance
 136  *
 137  * free the account data structure
 138  */
 139 void       modest_account_mgr_free_account_data     (ModestAccountMgr *self,
 140                                                      ModestAccountData *data);
 141
 142 /**
 143  * modest_account_mgr_set_enabled
 144  * @self: a ModestAccountMgr instance
 145  * @name: the account name
 146  * @enabled: if TRUE, the account will be enabled, if FALSE, it will be disabled
 147  *
 148  * enable/disabled an account
 149  *
 150  * Returns: TRUE if it worked, FALSE otherwise
 151  */
 152 gboolean modest_account_mgr_set_enabled (ModestAccountMgr *self, const gchar* name,
 153                                          gboolean enabled);
 154
 155 /**
 156  * modest_account_mgr_get_enabled:
 157  * @self: a ModestAccountMgr instance
 158  * @name: the account name to check
 159  *
 160  * check whether a certain account is enabled
 161  *
 162  * Returns: TRUE if it is enabled, FALSE otherwise
 163  */
 164 gboolean modest_account_mgr_get_enabled (ModestAccountMgr *self, const gchar* name);
 165
 166 /**
 167  * modest_account_mgr_set_signature
 168  * @self: a ModestAccountMgr instance
 169  * @name: the account name to check
 170  * @signature: the signature text
 171  * @use_signature: Whether the signature should be used.
 172  *
 173  * Sets the signature text for the account.
 174  *
 175  * Returns: TRUE if it worked, FALSE otherwise
 176  */
 177 gboolean modest_account_mgr_set_signature (ModestAccountMgr *self, const gchar* name,
 178         const gchar* signature, gboolean use_signature);
 179
 180 /**
 181  * modest_account_mgr_get_signature:
 182  * @self: a ModestAccountMgr instance
 183  * @name: the account name
 184  * @use_signature: Pointer to a gboolean taht will be set to TRUE if the signature should be used.
 185  *
 186  * Gets the signature text for this account.
 187  *
 188  * Returns: The signature text, which should be freed with g_free().
 189  */
 190 gchar* modest_account_mgr_get_signature (ModestAccountMgr *self, const gchar* name,
 191         gboolean* use_signature);
 192
 193 /**
 194  * modest_account_mgr_set_connection_specific_smtp
 195  * @self: a ModestAccountMgr instance
 196  * @name: the account name
 197  * @connection_name: A libconic IAP connection name
 198  * @server_account_name: a server account name to use for this connection.
 199  *
 200  * Specify a server account to use with the specific connection for this account.
 201  *
 202  * Returns: TRUE if it worked, FALSE otherwise
 203  */
 204 gboolean modest_account_mgr_set_connection_specific_smtp (ModestAccountMgr *self, const gchar* name,
 205                                          const gchar* connection_name, const gchar* server_account_name);
 206
 207 /**
 208  * modest_account_mgr_remove_connection_specific_smtp
 209  * @self: a ModestAccountMgr instance
 210  * @name: the account name
 211  * @connection_name: A libconic IAP connection name
 212  *
 213  * Disassacoiate a server account to use with the specific connection for this account.
 214  *
 215  * Returns: TRUE if it worked, FALSE otherwise
 216  */
 217 gboolean modest_account_mgr_remove_connection_specific_smtp (ModestAccountMgr *self, const gchar* name,
 218                                          const gchar* connection_name);
 219
 220 /**
 221  * modest_account_mgr_get_connection_specific_smtp
 222  * @self: a ModestAccountMgr instance
 223  * @name: the account name
 224  * @connection_name: A libconic IAP connection name
 225  *
 226  * Retrieve a server account to use with this specific connection for this account.
 227  *
 228  * Returns: a server account name to use for this connection, or NULL if none is specified.
 229  */
 230 gchar* modest_account_mgr_get_connection_specific_smtp (ModestAccountMgr *self, const gchar* name,
 231                                          const gchar* connection_name);
 232
 233 /**
 234  * modest_server_account_get_secure_auth:
 235  * @self: a ModestAccountMgr instance
 236  * @account_name: The name of a server account.
 237  *
 238  * Gets the secure authentication method for this server account.
 239  *
 240  * Returns: The secure authentication enum value.
 241  */
 242 ModestProtocol
 243 modest_server_account_get_secure_auth (ModestAccountMgr *self, const gchar* account_name);
 244
 245 /**
 246  * modest_server_account_data_get_secure_auth:
 247  * @self: a ModestAccountMgr instance
 248  * @account_name: The name of a server account.
 249  * @secure_auth: The secure authentication enum value.
 250  *
 251  * Gets the secure authentication method for this server account.
 252  */
 253 void
 254 modest_server_account_set_secure_auth (ModestAccountMgr *self, const gchar* account_name,
 255         ModestProtocol secure_auth);
 256
 257 /**
 258  * modest_server_account_data_get_security:
 259  * @self: a ModestAccountMgr instance
 260  * @account_name: The name of a server account.
 261  *
 262  * Gets the security method for this server account.
 263  *
 264  * Returns: The security enum value.
 265  */
 266 ModestProtocol
 267 modest_server_account_get_security (ModestAccountMgr *self, const gchar* account_name);
 268
 269 /**
 270  * modest_server_account_set_security:
 271  * @self: a ModestAccountMgr instance
 272  * @secure_auth: The security enum value.
 273  *
 274  * Gets the security method for this server account.
 275  */
 276 void
 277 modest_server_account_set_security (ModestAccountMgr *self, const gchar* account_name,
 278         ModestProtocol security);
 279
 280 ModestServerAccountData*
 281 modest_account_mgr_get_server_account_data (ModestAccountMgr *self, const gchar* name);
 282
 283 void
 284 modest_account_mgr_free_server_account_data (ModestAccountMgr *self,
 285                                              ModestServerAccountData* data);
 286
 287 #if 0
 288 /**
 289  * modest_account_mgr_get_account_option:
 290  * @self: a ModestAccountMgr instance
 291  * @account_name: the account name to check
 292  * @account_name: the option name to check
 293  *
 294  * Returns: The account option value. This must be freed with g_free().
 295  */
 296 gchar* modest_account_mgr_get_server_account_option (ModestAccountMgr *self,
 297         const gchar* account_name, const gchar* option_name);
 298
 299 /**
 300  * modest_server_account_data_get_option_value:
 301  * @options_list: a ModestServerAccountData::options list.
 302  * @option_name: the option name to check
 303  *
 304  * Returns: The account option value. This must be freed with g_free().
 305  */
 306 gchar* modest_server_account_data_get_option_string (GSList* options_list, const gchar* option_name);
 307
 308 /**
 309  * modest_server_account_data_get_option_bool:
 310  * @options_list: a ModestServerAccountData::options list.
 311  * @option_name: the option name to check
 312  *
 313  * Returns: Whether the account option is present.
 314  */
 315 gboolean modest_server_account_data_get_option_bool (GSList* options_list, const gchar* option_name);
 316 #endif
 317
 318 /**
 319  * modest_account_mgr_get_from_string
 320  * @self: a #ModestAccountMgr instance
 321  * @name: the account name
 322  *
 323  * get the From: string for some account; ie. "Foo Bar" <foo.bar@cuux.yy>"
 324  *
 325  * Returns: the newly allocated from-string, or NULL in case of error
 326  */
 327 gchar * modest_account_mgr_get_from_string (ModestAccountMgr *self, const gchar* name);
 328
 329
 330 /**
 331  * modest_account_mgr_get_unused_account_name
 332  * @self: a #ModestAccountMgr instance
 333  * @name: The initial account name
 334  *
 335  * get an unused account name, based on a starting string.
 336  *
 337  * Returns: the newly allocated name.
 338  */
 339 gchar*
 340 modest_account_mgr_get_unused_account_name (ModestAccountMgr *self, const gchar* starting_name,
 341         gboolean server_account);
 342
 343 /**
 344  * modest_account_mgr_get_unused_account_display name
 345  * @self: a #ModestAccountMgr instance
 346  * @name: The initial account display name
 347  *
 348  * get an unused account display name, based on a starting string.
 349  *
 350  * Returns: the newly allocated name.
 351  */
 352 gchar*
 353 modest_account_mgr_get_unused_account_display_name (ModestAccountMgr *self, const gchar* starting_name);
 354
 355 G_END_DECLS
 356
 357 #endif /* __MODEST_ACCOUNT_MGR_H__ */