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
  36 G_BEGIN_DECLS
  37
  38 typedef struct {
  39         gchar *account_name;
  40         gchar *hostname;
  41         gchar *username;
  42         ModestProtocol proto;
  43         gchar *password;
  44         GSList *options;
  45 } ModestServerAccountData;
  46
  47 typedef struct {
  48         gchar *account_name;
  49         gchar *display_name;
  50         gchar *fullname;
  51         gchar *email;
  52         gboolean enabled;
  53         ModestServerAccountData *transport_account;
  54         ModestServerAccountData *store_account;
  55 } ModestAccountData;
  56
  57 /**
  58  * modest_account_mgr_get_account_data:
  59  * @self: a ModestAccountMgr instance
  60  * @name: the name of the account
  61  *
  62  * get information about an account
  63  *
  64  * Returns: a ModestAccountData structure with information about the account.
  65  * the data should not be changed, and be freed with modest_account_mgr_free_account_data
  66  * The function does a sanity check, an if it's not returning NULL,
  67  * it is a valid account
  68  */
  69 ModestAccountData *modest_account_mgr_get_account_data     (ModestAccountMgr *self,
  70                                                             const gchar* name);
  71
  72 /**
  73  * modest_account_mgr_get_default_account:
  74  * @self: a ModestAccountMgr instance
  75  *
  76  * get the default account name, or NULL if none is found
  77  *
  78  * Returns: the default account name (as newly allocated string, which
  79  * must be g_free'd), or NULL
  80  */
  81 gchar* modest_account_mgr_get_default_account  (ModestAccountMgr *self);
  82
  83 /**
  84  * modest_account_mgr_get_default_account:
  85  * @self: a ModestAccountMgr instance
  86  * @account: the name of an existing account
  87  *
  88  * set the default account name (which must be valid account)
  89  *
  90  * Returns: TRUE if succeeded, FALSE otherwise
  91  */
  92 gboolean modest_account_mgr_set_default_account  (ModestAccountMgr *self,
  93                                                   const gchar* account);
  94
  95 /**
  96  * modest_account_mgr_free_account_data:
  97  * @self: a ModestAccountMgr instance
  98  * @data: a ModestAccountData instance
  99  *
 100  * free the account data structure
 101  */
 102 void       modest_account_mgr_free_account_data     (ModestAccountMgr *self,
 103                                                      ModestAccountData *data);
 104
 105
 106
 107 /**
 108  * modest_account_mgr_account_set_enabled
 109  * @self: a ModestAccountMgr instance
 110  * @name: the account name
 111  * @enabled: if TRUE, the account will be enabled, if FALSE, it will be disabled
 112  *
 113  * enable/disabled an account
 114  *
 115  * Returns: TRUE if it worked, FALSE otherwise
 116  */
 117 gboolean modest_account_mgr_account_set_enabled (ModestAccountMgr *self, const gchar* name,
 118                                                  gboolean enabled);
 119
 120
 121 /**
 122  * modest_account_mgr_account_get_enabled:
 123  * @self: a ModestAccountMgr instance
 124  * @name: the account name to check
 125  *
 126  * check whether a certain account is enabled
 127  *
 128  * Returns: TRUE if it is enabled, FALSE otherwise
 129  */
 130 gboolean modest_account_mgr_account_get_enabled (ModestAccountMgr *self, const gchar* name);
 131
 132
 133
 134
 135
 136
 137
 138 G_END_DECLS
 139
 140 #endif /* __MODEST_ACCOUNT_MGR_H__ */