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