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
  53 struct _ModestAccountMgr {
  54          GObject parent;
  55 };
  56
  57 struct _ModestAccountMgrClass {
  58         GObjectClass parent_class;
  59
  60         void (* account_removed)   (ModestAccountMgr *obj, const gchar* account,
  61                                     gboolean server_account, gpointer user_data);
  62         void (* account_changed)   (ModestAccountMgr *obj, const gchar* account,
  63                                     const gchar* key, gboolean server_account,
  64                                     gpointer user_data);
  65 };
  66
  67 /**
  68  * modest_account_mgr_get_type:
  69  *
  70  * get the GType for ModestAccountMgr
  71  *
  72  * Returns: the GType
  73  */
  74 GType           modest_account_mgr_get_type       (void) G_GNUC_CONST;
  75
  76
  77 /**
  78  * modest_account_mgr_new:
  79  * @modest_conf: a ModestConf instance
  80  *
  81  * Returns: a new ModestAccountMgr, or NULL in case of error
  82  */
  83 ModestAccountMgr*        modest_account_mgr_new            (ModestConf *modest_conf);
  84
  85
  86
  87 /**
  88  * modest_account_mgr_add_account:
  89  * @self: a ModestAccountMgr instance
  90  * @name: name (id) of the account, which is a valid UTF8 string that does not contain '/'
  91  * @store_name: the store account (ie. POP/IMAP)
  92  * @transport_name: the transport account (ie. sendmail/SMTP)
  93  * @err: a GError ptr, or NULL to ignore.
  94  *
  95  * create a new account. the account with @name should not already exist
  96  *
  97  * Returns: TRUE if the creation succeeded, FALSE otherwise,
  98  * @err gives details in case of error
  99  */
 100 gboolean        modest_account_mgr_add_account    (ModestAccountMgr *self,
 101                                                    const gchar* name,
 102                                                    const gchar* store_name,
 103                                                    const gchar* transport_name);
 104
 105 /**
 106  * modest_account_mgr_add_server_account:
 107  * @self: a ModestAccountMgr instance
 108  * @name: name (id) of the account, which is a valid UTF8 string that does not contain '/'
 109  * @hostname: the hostname
 110  * @username: the username
 111  * @password: the password
 112  * @proto:    the protocol (imap, smtp, ...) used for this account
 113  * @security: the security options, (SSL, TLS ...) used to access the server
 114  * @auth: the authentication method (password, none ...) used to access the server
 115  *
 116  * add a server account to the configuration.
 117  * the server account with @name should not already exist
 118  *
 119  * Returns: TRUE if succeeded, FALSE otherwise,
 120  */
 121 gboolean modest_account_mgr_add_server_account    (ModestAccountMgr *self,
 122                                                    const gchar *name,
 123                                                    const gchar *hostname,
 124                                                    const gchar *username,
 125                                                    const gchar *password,
 126                                                    ModestProtocol proto,
 127                                                    ModestProtocol security,
 128                                                    ModestProtocol auth);
 129
 130
 131 /**
 132  * modest_account_mgr_add_server_account_uri:
 133  * @self: a ModestAccountMgr instance
 134  * @name: name (id) of the account, which is a valid UTF8 string that does not contain '/'
 135  * @proto:    the protocol (imap, smtp, ...) used for this account
 136  * @uri: the URI
 137  *
 138  * add a server account to the configuration, based on the account-URI
 139  *
 140  * Returns: TRUE if succeeded, FALSE otherwise,
 141  */
 142 gboolean modest_account_mgr_add_server_account_uri    (ModestAccountMgr *self,
 143                                                        const gchar *name,
 144                                                        ModestProtocol proto,
 145                                                        const gchar* uri);
 146
 147 /**
 148  * modest_account_mgr_remove_account:
 149  * @self: a ModestAccountMgr instance
 150  * @name: the name of the account to remove
 151  * @server_account: TRUE if the account to remove is a server account
 152  * @err: a #GError ptr, or NULL to ignore.
 153  *
 154  * remove an existing account. the account with @name should already exist
 155  *
 156  * Returns: TRUE if the creation succeeded, FALSE otherwise,
 157  * @err gives details in case of error
 158  */
 159 gboolean        modest_account_mgr_remove_account         (ModestAccountMgr *self,
 160                                                            const gchar* name,
 161                                                            gboolean server_account);
 162
 163
 164 /**
 165  * modest_account_mgr_account_names:
 166  * @self: a ModestAccountMgr instance
 167  *
 168  * list all account names
 169  *
 170  * Returns: a newly allocated list of account names, or NULL in case of error or
 171  * if there are no accounts. The caller must free the returned GSList.
 172  *
 173  * TODO: I believe that the caller must free the strings in the GSList items too,
 174  * because this is implemented via gconf_client_all_dirs() which also requires a deep free,
 175  * though that's not documented. murrayc.
 176  */
 177 GSList*         modest_account_mgr_account_names    (ModestAccountMgr *self);
 178
 179
 180 /**
 181  * modest_account_mgr_server_account_names:
 182  * @self: a ModestAccountMgr instance
 183  * @account_name: get only server accounts for @account_name, or NULL for any
 184  * @type: get only server accounts from protocol type @type, or MODEST_PROTO_TYPE_ANY
 185  * @proto: get only server account with protocol @proto, or NULL for any
 186  * @only_enabled: get only enabled server accounts if TRUE
 187  *
 188  * list all the server account names
 189  *
 190  * Returns: a newly allocated list of server account names, or NULL in case of
 191  * error or if there are no server accounts. The caller must free the returned GSList
 192  */
 193 GSList*  modest_account_mgr_search_server_accounts  (ModestAccountMgr *self,
 194                                                      const gchar*       account_name,
 195                                                      ModestProtocolType type,
 196                                                      ModestProtocol     proto);
 197
 198 /**
 199  * modest_account_mgr_account_exists:
 200  * @self: a ModestAccountMgr instance
 201  * @name: the account name to check
 202  * @server_account: if TRUE, this is a server account
 203  *
 204  * check whether account @name exists
 205  *
 206  * Returns: TRUE if the account with name @name exists, FALSE otherwise (or in case of error)
 207  */
 208 gboolean        modest_account_mgr_account_exists         (ModestAccountMgr *self,
 209                                                            const gchar *name,
 210                                                            gboolean server_account);
 211
 212
 213 /**
 214  * modest_account_mgr_get_string:
 215  * @self: self a ModestAccountMgr instance
 216  * @name: the name of the account
 217  * @key: the key of the value to retrieve
 218  * @server_account: if TRUE, this is a server account
 219  *
 220  * get a config string from an account
 221  *
 222  * Returns: a newly allocated string with the value for the key,
 223  * or NULL in case of error.
 224  */
 225 gchar*          modest_account_mgr_get_string     (ModestAccountMgr *self,
 226                                                    const gchar *name,
 227                                                    const gchar *key,
 228                                                    gboolean server_account);
 229
 230
 231 /**
 232  * modest_account_mgr_get_password:
 233  * @self: self a ModestAccountMgr instance
 234  * @name: the name of the account
 235  * @key: the key of the value to retrieve
 236  * @server_account: if TRUE, this is a server account
 237  *
 238  * get a password from an account
 239  *
 240  * Returns: a newly allocated string with the value for the key,
 241  * or NULL in case of error.
 242  */
 243 gchar*          modest_account_mgr_get_password     (ModestAccountMgr *self,
 244                                                      const gchar *name,
 245                                                      const gchar *key,
 246                                                      gboolean server_account);
 247
 248 /**
 249  * modest_account_mgr_get_int:
 250  * @self: a ModestAccountMgr instance
 251  * @name: the name of the account
 252  * @key: the key of the value to retrieve
 253  * @server_account: if TRUE, this is a server account
 254  *
 255  * get a config int from an account
 256  *
 257  * Returns: an integer with the value for the key, or -1 in case of
 258  * error (but of course -1 does not necessarily imply an error)
 259  */
 260 gint            modest_account_mgr_get_int        (ModestAccountMgr *self,
 261                                                    const gchar *name,
 262                                                    const gchar *key,
 263                                                    gboolean server_account);
 264
 265 /**
 266  * modest_account_mgr_get_bool:
 267  * @self: a ModestAccountMgr instance
 268  * @name: the name of the account
 269  * @key: the key of the value to retrieve
 270  * @server_account: if TRUE, this is a server account
 271  *
 272  * get a config boolean from an account
 273  *
 274  * Returns: an boolean with the value for the key, or FALSE in case of
 275  * error (but of course FALSE does not necessarily imply an error)
 276  */
 277 gboolean        modest_account_mgr_get_bool       (ModestAccountMgr *self,
 278                                                    const gchar *name,
 279                                                    const gchar *key,
 280                                                    gboolean server_account);
 281
 282 /**
 283  * modest_account_mgr_get_list:
 284  * @self: a ModestAccountMgr instance
 285  * @name: the name of the account
 286  * @key: the key of the value to get
 287  * @list_type: the type of the members of the list
 288  * @server_account: if TRUE, this is a server account
 289  *
 290  * get a config list of values of type @list_type of an account
 291  *
 292  * Returns: a newly allocated list of elements
 293  */
 294 GSList*         modest_account_mgr_get_list       (ModestAccountMgr *self,
 295                                                    const gchar *name,
 296                                                    const gchar *key,
 297                                                    ModestConfValueType list_type,
 298                                                    gboolean server_account);
 299
 300 /**
 301  * modest_account_mgr_set_string:
 302  * @self: a ModestAccountMgr instance
 303  * @name: the name of the account
 304  * @key: the key of the value to set
 305  * @val: the value to set
 306  * @server_account: if TRUE, this is a server account
 307  *
 308  * set a config string for an account.
 309  *
 310  * Returns: TRUE if setting the value succeeded, or FALSE in case of error.
 311  */
 312 gboolean        modest_account_mgr_set_string     (ModestAccountMgr *self,
 313                                                    const gchar *name,
 314                                                    const gchar *key, const gchar* val,
 315                                                    gboolean server_account);
 316
 317
 318 /**
 319  * modest_account_mgr_set_password:
 320  * @self: a ModestAccountMgr instance
 321  * @name: the name of the account
 322  * @key: the key of the value to set
 323  * @val: the value to set
 324  * @server_account: if TRUE, this is a server account
 325  *
 326  * set a password for an account.
 327  *
 328  * Returns: TRUE if setting the value succeeded, or FALSE in case of error.
 329 * @err gives details in case of error
 330  */
 331 gboolean        modest_account_mgr_set_password     (ModestAccountMgr *self,
 332                                                      const gchar *name,
 333                                                      const gchar *key, const gchar* val,
 334                                                      gboolean server_account);
 335
 336 /**
 337  * modest_account_mgr_set_int:
 338  * @self: a ModestAccountMgr instance
 339  * @name: the name of the account
 340  * @key: the key of the value to set
 341  * @val: the value to set
 342  * @server_account: if TRUE, this is a server account
 343  *
 344  * set a config int for an account
 345  *
 346  * Returns: TRUE if setting the value succeeded, or FALSE in case of error.
 347  */
 348 gboolean        modest_account_mgr_set_int        (ModestAccountMgr *self,
 349                                                    const gchar *name,
 350                                                    const gchar *key, gint val,
 351                                                    gboolean server_account);
 352
 353 /**
 354  * modest_account_mgr_set_bool:
 355  * @self: a ModestAccountMgr instance
 356  * @name: the name of the account
 357  * @key: the key of the value to set
 358  * @val: the value to set
 359  * @server_account: if TRUE, this is a server account
 360  *
 361  * set a config bool for an account
 362  *
 363  * Returns: TRUE if setting the value succeeded, or FALSE in case of error.
 364  */
 365 gboolean        modest_account_mgr_set_bool       (ModestAccountMgr *self,
 366                                                    const gchar *name,
 367                                                    const gchar *key, gboolean val,
 368                                                    gboolean server_account);
 369
 370 /**
 371  * modest_account_mgr_set_list:
 372  * @self: a ModestAccountMgr instance
 373  * @name: the name of the account
 374  * @key: the key of the value to set
 375  * @val: the list with the values to set
 376  * @list_type: the type of the members of the list
 377  * @server_account: if TRUE, this is a server account
 378  *
 379  * * set a config list of values of type @list_type of an account
 380  *
 381  * returns TRUE if this succeeded, FALSE otherwise
 382  */
 383 gboolean                modest_account_mgr_set_list       (ModestAccountMgr *self,
 384                                                            const gchar *name,
 385                                                            const gchar *key,
 386                                                            GSList *val,
 387                                                            ModestConfValueType list_type,
 388                                                            gboolean server_account);
 389
 390 /**
 391  * modest_account_mgr_unset:
 392  * @self: a ModestAccountMgr instance
 393  * @name: the name of the account
 394  * @key: the key of the value to unset
 395  * @server_account: if TRUE, this is a server account
 396  * @err: a GError ptr, or NULL to ignore.
 397  *
 398  * unsets the config value of an account and all their children keys
 399  *
 400  * Returns: TRUE if unsetting the value succeeded, or FALSE in case of error.
 401  * @err gives details in case of error
 402  */
 403 gboolean        modest_account_mgr_unset           (ModestAccountMgr *self,
 404                                                     const gchar *name,
 405                                                     const gchar *key,
 406                                                     gboolean server_account);
 407
 408 G_END_DECLS
 409
 410 #endif /* __MODEST_ACCOUNT_MGR_H__ */