git.maemo.org Git - modest/blob - src/modest-account-mgr.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_H__
  32 #define __MODEST_ACCOUNT_MGR_H__
  33
  34 #include <glib-object.h>
  35 #include <modest-conf.h>
  36 #include <modest-defs.h>
  37 #include <modest-protocol-info.h>
  38
  39 G_BEGIN_DECLS
  40
  41 /* convenience macros */
  42 #define MODEST_TYPE_ACCOUNT_MGR             (modest_account_mgr_get_type())
  43 #define MODEST_ACCOUNT_MGR(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_ACCOUNT_MGR,ModestAccountMgr))
  44 #define MODEST_ACCOUNT_MGR_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_ACCOUNT_MGR,ModestAccountMgrClass))
  45 #define MODEST_IS_ACCOUNT_MGR(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_ACCOUNT_MGR))
  46 #define MODEST_IS_ACCOUNT_MGR_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_ACCOUNT_MGR))
  47 #define MODEST_ACCOUNT_MGR_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_ACCOUNT_MGR,ModestAccountMgrClass))
  48
  49 typedef struct _ModestAccountMgr      ModestAccountMgr;
  50 typedef struct _ModestAccountMgrClass ModestAccountMgrClass;
  51
  52 struct _ModestAccountMgr {
  53          GObject parent;
  54 };
  55
  56 struct _ModestAccountMgrClass {
  57         GObjectClass parent_class;
  58
  59         void (* account_inserted)  (ModestAccountMgr *obj,
  60                                     const gchar* account,
  61                                     gpointer user_data);
  62
  63         void (* account_removed)   (ModestAccountMgr *obj,
  64                                     const gchar* account,
  65                                     gpointer user_data);
  66
  67         void (* account_changed)   (ModestAccountMgr *obj,
  68                                     const gchar* account,
  69                                     gpointer user_data);
  70
  71         void (* account_busy_changed)   (ModestAccountMgr *obj,
  72                                          const gchar* account,
  73                                          gboolean busy,
  74                                          gpointer user_data);
  75
  76         void (* default_account_changed)(ModestAccountMgr *obj,
  77                                          gpointer user_data);
  78
  79         void (* display_name_changed)   (ModestAccountMgr *obj,
  80                                          const gchar *account,
  81                                          gpointer user_data);
  82 };
  83
  84 /**
  85  * modest_account_mgr_get_type:
  86  *
  87  * get the GType for ModestAccountMgr
  88  *
  89  * Returns: the GType
  90  */
  91 GType           modest_account_mgr_get_type       (void) G_GNUC_CONST;
  92
  93
  94 /**
  95  * modest_account_mgr_new:
  96  * @modest_conf: a ModestConf instance
  97  *
  98  * Returns: a new ModestAccountMgr, or NULL in case of error
  99  */
 100 ModestAccountMgr*        modest_account_mgr_new            (ModestConf *modest_conf);
 101
 102
 103
 104 /**
 105  * modest_account_mgr_add_account:
 106  * @self: a ModestAccountMgr instance
 107  * @name: name (id) of the account, which is a valid UTF8 string that does not contain '/'
 108  * @store_name: the store account (ie. POP/IMAP)
 109  * @transport_name: the transport account (ie. sendmail/SMTP)
 110  * @enabled: Whether the account should be enabled initially.
 111  *
 112  * Create a new account. The account with @name should not already exist. The @name will
 113  * be used as the initial display name of the new account.
 114  *
 115  * Returns: TRUE if the creation succeeded, FALSE otherwise,
 116  */
 117 gboolean        modest_account_mgr_add_account    (ModestAccountMgr *self,
 118                                                    const gchar *name,
 119                                                    const gchar *display_name,
 120                                                    const gchar *user_fullname,
 121                                                    const gchar *user_email,
 122                                                    const gchar *retrieve_type,
 123                                                    const gchar* store_name,
 124                                                    const gchar* transport_name,
 125                                                    gboolean enabled);
 126
 127 /**
 128  * modest_account_mgr_add_server_account:
 129  * @self: a ModestAccountMgr instance
 130  * @name: name (id) of the account, which is a valid UTF8 string that does not contain '/'
 131  * @hostname: the hostname
 132  * @portnumber: the portnumber, or 0 for default
 133  * @username: the username
 134  * @password: the password
 135  * @proto:    the protocol (imap, smtp, ...) used for this account
 136  * @security: the security options, (SSL, TLS ...) used to access the server
 137  * @auth: the authentication method (password, none ...) used to access the server
 138  *
 139  * add a server account to the configuration.
 140  * the server account with @name should not already exist
 141  *
 142  * Returns: TRUE if succeeded, FALSE otherwise,
 143  */
 144 gboolean modest_account_mgr_add_server_account    (ModestAccountMgr *self,
 145                                                    const gchar *name,
 146                                                    const gchar *hostname,
 147                                                    const guint portnumber,
 148                                                    const gchar *username,
 149                                                    const gchar *password,
 150                                                    ModestTransportStoreProtocol proto,
 151                                                    ModestConnectionProtocol security,
 152                                                    ModestAuthProtocol auth);
 153
 154
 155 /**
 156  * modest_account_mgr_add_server_account_uri:
 157  * @self: a ModestAccountMgr instance
 158  * @name: name (id) of the account, which is a valid UTF8 string that does not contain '/'
 159  * @proto:    the protocol (imap, smtp, ...) used for this account
 160  * @uri: the URI
 161  *
 162  * add a server account to the configuration, based on the account-URI
 163  *
 164  * Returns: TRUE if succeeded, FALSE otherwise,
 165  */
 166 gboolean modest_account_mgr_add_server_account_uri    (ModestAccountMgr *self,
 167                                                        const gchar *name,
 168                                                        ModestTransportStoreProtocol proto,
 169                                                        const gchar* uri);
 170
 171 /**
 172  * modest_account_mgr_remove_account:
 173  * @self: a ModestAccountMgr instance
 174  * @name: the name of the account to remove
 175  * @err: a #GError ptr, or NULL to ignore.
 176  *
 177  * remove an existing account. the account with @name should already exist; note
 178  * that when deleting an account, also the corresponding server accounts will
 179  * be deleted
 180  *
 181  * Returns: TRUE if the creation succeeded, FALSE otherwise,
 182  * @err gives details in case of error
 183  */
 184 gboolean        modest_account_mgr_remove_account         (ModestAccountMgr *self,
 185                                                            const gchar* name);
 186
 187 /**
 188  * modest_account_mgr_account_names:
 189  * @self: a ModestAccountMgr instance
 190  * @only_enabled: Whether only enabled accounts should be returned.
 191  *
 192  * list all account names
 193  *
 194  * Returns: a newly allocated list of account names, or NULL in case of error or
 195  * if there are no accounts. The caller must free the returned GSList.
 196  *
 197  */
 198 GSList*         modest_account_mgr_account_names    (ModestAccountMgr *self,
 199                                                      gboolean only_enabled);
 200
 201 /**
 202  * modest_account_mgr_free_account_names:
 203  * @account_name: a gslist of account names
 204  *
 205  * list all account names
 206  *
 207  * free the list of account names
 208  */
 209 void            modest_account_mgr_free_account_names    (GSList *account_names);
 210
 211
 212 /**
 213  * modest_account_mgr_account_exists:
 214  * @self: a ModestAccountMgr instance
 215  * @name: the account name to check
 216  * @server_account: if TRUE, this is a server account
 217  *
 218  * check whether account @name exists. Note that this does not check the display name.
 219  *
 220  * Returns: TRUE if the account with name @name exists, FALSE otherwise (or in case of error)
 221  */
 222 gboolean        modest_account_mgr_account_exists         (ModestAccountMgr *self,
 223                                                            const gchar *name,
 224                                                            gboolean server_account);
 225
 226 /**
 227  * modest_account_mgr_account_exists:
 228  * @self: a ModestAccountMgr instance
 229  * @name: the account name to check
 230  *
 231  * check whether a non-server account with the @display_name exists.
 232  *
 233  * Returns: TRUE if the account with name @name exists, FALSE otherwise (or in case of error)
 234  */
 235 gboolean        modest_account_mgr_account_with_display_name_exists (ModestAccountMgr *self,
 236                                                                      const gchar *display_name);
 237
 238 /**
 239  * modest_account_mgr_unset:
 240  * @self: a ModestAccountMgr instance
 241  * @name: the name of the account
 242  * @key: the key of the value to unset
 243  * @server_account: if TRUE, this is a server account
 244  * @err: a GError ptr, or NULL to ignore.
 245  *
 246  * unsets the config value of an account and all their children keys
 247  *
 248  * Returns: TRUE if unsetting the value succeeded, or FALSE in case of error.
 249  * @err gives details in case of error
 250  */
 251 gboolean        modest_account_mgr_unset           (ModestAccountMgr *self,
 252                                                     const gchar *name,
 253                                                     const gchar *key,
 254                                                     gboolean server_account);
 255
 256 /**
 257  * modest_account_mgr_has_accounts:
 258  * @self: a ModestAccountMgr instance
 259  * @enabled: TRUE to search for enabled accounts only
 260  *
 261  * Checks if any accounts exist
 262  *
 263  * Returns: TRUE if accounts exist, FALSE otherwise
 264  */
 265
 266 gboolean modest_account_mgr_has_accounts (ModestAccountMgr* self, gboolean enabled);
 267
 268 /**
 269  * modest_account_mgr_set_account_busy
 270  * @self: a ModestAccountMgr instance
 271  * @account_name: name of the account
 272  * @busy: whether to set busy or not busy
 273  *
 274  * Changes the busy flag of an account
 275  *
 276  */
 277
 278 void modest_account_mgr_set_account_busy(ModestAccountMgr* self, const gchar* account_name,
 279                                                                                                                                                 gboolean busy);
 280
 281 /**
 282  * modest_account_mgr_account_is_busy
 283  * @self: a ModestAccountMgr instance
 284  * @account_name: name of the account
 285  *
 286  * Returns: If the account is currently busy or not
 287  *
 288  */
 289 gboolean modest_account_mgr_account_is_busy (ModestAccountMgr* self,
 290                                              const gchar* account_name);
 291
 292
 293 void modest_account_mgr_notify_account_update (ModestAccountMgr* self,
 294                                                const gchar *server_account_name);
 295
 296 /**
 297  * modest_account_mgr_set_default_account:
 298  * @self: a ModestAccountMgr instance
 299  * @account: the name of an existing account
 300  *
 301  * set the default account name (which must be valid account)
 302  *
 303  * Returns: TRUE if succeeded, FALSE otherwise
 304  */
 305 gboolean modest_account_mgr_set_default_account  (ModestAccountMgr *self,
 306                                                   const gchar* account);
 307
 308 /**
 309  * modest_account_mgr_get_default_account:
 310  * @self: a ModestAccountMgr instance
 311  *
 312  * get the default account name, or NULL if none is found
 313  *
 314  * Returns: the default account name (as newly allocated string, which
 315  * must be g_free'd), or NULL
 316  */
 317 gchar* modest_account_mgr_get_default_account  (ModestAccountMgr *self);
 318
 319 /**
 320  * modest_account_mgr_get_display_name:
 321  * @self: a ModestAccountMgr instance
 322  * @name: the account name to check
 323  *
 324  * Return the human-readable account title for this account, or NULL.
 325  */
 326 gchar* modest_account_mgr_get_display_name (ModestAccountMgr *self,
 327                                             const gchar* name);
 328
 329 void  modest_account_mgr_set_display_name (ModestAccountMgr *self,
 330                                            const gchar *account_name,
 331                                            const gchar *display_name);
 332
 333
 334 G_END_DECLS
 335
 336 #endif /* __MODEST_ACCOUNT_MGR_H__ */