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 GSList*         modest_account_mgr_account_names    (ModestAccountMgr *self);
 174
 175
 176 /**
 177  * modest_account_mgr_server_account_names:
 178  * @self: a ModestAccountMgr instance
 179  * @account_name: get only server accounts for @account_name, or NULL for any
 180  * @type: get only server accounts from protocol type @type, or MODEST_PROTO_TYPE_ANY
 181  * @proto: get only server account with protocol @proto, or NULL for any
 182  * @only_enabled: get only enabled server accounts if TRUE
 183  *
 184  * list all the server account names
 185  *
 186  * Returns: a newly allocated list of server account names, or NULL in case of
 187  * error or if there are no server accounts. The caller must free the returned GSList
 188  */
 189 GSList*  modest_account_mgr_search_server_accounts  (ModestAccountMgr *self,
 190                                                      const gchar*       account_name,
 191                                                      ModestProtocolType type,
 192                                                      ModestProtocol     proto);
 193
 194 /**
 195  * modest_account_mgr_account_exists:
 196  * @self: a ModestAccountMgr instance
 197  * @name: the account name to check
 198  * @server_account: if TRUE, this is a server account
 199  *
 200  * check whether account @name exists
 201  *
 202  * Returns: TRUE if the account with name @name exists, FALSE otherwise (or in case of error)
 203  */
 204 gboolean        modest_account_mgr_account_exists         (ModestAccountMgr *self,
 205                                                            const gchar *name,
 206                                                            gboolean server_account);
 207
 208
 209 /**
 210  * modest_account_mgr_get_string:
 211  * @self: self a ModestAccountMgr instance
 212  * @name: the name of the account
 213  * @key: the key of the value to retrieve
 214  * @server_account: if TRUE, this is a server account
 215  *
 216  * get a config string from an account
 217  *
 218  * Returns: a newly allocated string with the value for the key,
 219  * or NULL in case of error.
 220  */
 221 gchar*          modest_account_mgr_get_string     (ModestAccountMgr *self,
 222                                                    const gchar *name,
 223                                                    const gchar *key,
 224                                                    gboolean server_account);
 225
 226
 227 /**
 228  * modest_account_mgr_get_password:
 229  * @self: self a ModestAccountMgr instance
 230  * @name: the name of the account
 231  * @key: the key of the value to retrieve
 232  * @server_account: if TRUE, this is a server account
 233  *
 234  * get a password from an account
 235  *
 236  * Returns: a newly allocated string with the value for the key,
 237  * or NULL in case of error.
 238  */
 239 gchar*          modest_account_mgr_get_password     (ModestAccountMgr *self,
 240                                                      const gchar *name,
 241                                                      const gchar *key,
 242                                                      gboolean server_account);
 243
 244 /**
 245  * modest_account_mgr_get_int:
 246  * @self: a ModestAccountMgr instance
 247  * @name: the name of the account
 248  * @key: the key of the value to retrieve
 249  * @server_account: if TRUE, this is a server account
 250  *
 251  * get a config int from an account
 252  *
 253  * Returns: an integer with the value for the key, or -1 in case of
 254  * error (but of course -1 does not necessarily imply an error)
 255  */
 256 gint            modest_account_mgr_get_int        (ModestAccountMgr *self,
 257                                                    const gchar *name,
 258                                                    const gchar *key,
 259                                                    gboolean server_account);
 260
 261 /**
 262  * modest_account_mgr_get_bool:
 263  * @self: a ModestAccountMgr instance
 264  * @name: the name of the account
 265  * @key: the key of the value to retrieve
 266  * @server_account: if TRUE, this is a server account
 267  *
 268  * get a config boolean from an account
 269  *
 270  * Returns: an boolean with the value for the key, or FALSE in case of
 271  * error (but of course FALSE does not necessarily imply an error)
 272  */
 273 gboolean        modest_account_mgr_get_bool       (ModestAccountMgr *self,
 274                                                    const gchar *name,
 275                                                    const gchar *key,
 276                                                    gboolean server_account);
 277
 278 /**
 279  * modest_account_mgr_get_list:
 280  * @self: a ModestAccountMgr instance
 281  * @name: the name of the account
 282  * @key: the key of the value to get
 283  * @list_type: the type of the members of the list
 284  * @server_account: if TRUE, this is a server account
 285  *
 286  * get a config list of values of type @list_type of an account
 287  *
 288  * Returns: a newly allocated list of elements
 289  */
 290 GSList*         modest_account_mgr_get_list       (ModestAccountMgr *self,
 291                                                    const gchar *name,
 292                                                    const gchar *key,
 293                                                    ModestConfValueType list_type,
 294                                                    gboolean server_account);
 295
 296 /**
 297  * modest_account_mgr_set_string:
 298  * @self: a ModestAccountMgr instance
 299  * @name: the name of the account
 300  * @key: the key of the value to set
 301  * @val: the value to set
 302  * @server_account: if TRUE, this is a server account
 303  *
 304  * set a config string for an account.
 305  *
 306  * Returns: TRUE if setting the value succeeded, or FALSE in case of error.
 307  */
 308 gboolean        modest_account_mgr_set_string     (ModestAccountMgr *self,
 309                                                    const gchar *name,
 310                                                    const gchar *key, const gchar* val,
 311                                                    gboolean server_account);
 312
 313
 314 /**
 315  * modest_account_mgr_set_password:
 316  * @self: a ModestAccountMgr instance
 317  * @name: the name of the account
 318  * @key: the key of the value to set
 319  * @val: the value to set
 320  * @server_account: if TRUE, this is a server account
 321  *
 322  * set a password for an account.
 323  *
 324  * Returns: TRUE if setting the value succeeded, or FALSE in case of error.
 325 * @err gives details in case of error
 326  */
 327 gboolean        modest_account_mgr_set_password     (ModestAccountMgr *self,
 328                                                      const gchar *name,
 329                                                      const gchar *key, const gchar* val,
 330                                                      gboolean server_account);
 331
 332 /**
 333  * modest_account_mgr_set_int:
 334  * @self: a ModestAccountMgr instance
 335  * @name: the name of the account
 336  * @key: the key of the value to set
 337  * @val: the value to set
 338  * @server_account: if TRUE, this is a server account
 339  *
 340  * set a config int for an account
 341  *
 342  * Returns: TRUE if setting the value succeeded, or FALSE in case of error.
 343  */
 344 gboolean        modest_account_mgr_set_int        (ModestAccountMgr *self,
 345                                                    const gchar *name,
 346                                                    const gchar *key, gint val,
 347                                                    gboolean server_account);
 348
 349 /**
 350  * modest_account_mgr_set_bool:
 351  * @self: a ModestAccountMgr instance
 352  * @name: the name of the account
 353  * @key: the key of the value to set
 354  * @val: the value to set
 355  * @server_account: if TRUE, this is a server account
 356  *
 357  * set a config bool for an account
 358  *
 359  * Returns: TRUE if setting the value succeeded, or FALSE in case of error.
 360  */
 361 gboolean        modest_account_mgr_set_bool       (ModestAccountMgr *self,
 362                                                    const gchar *name,
 363                                                    const gchar *key, gboolean val,
 364                                                    gboolean server_account);
 365
 366 /**
 367  * modest_account_mgr_set_list:
 368  * @self: a ModestAccountMgr instance
 369  * @name: the name of the account
 370  * @key: the key of the value to set
 371  * @val: the list with the values to set
 372  * @list_type: the type of the members of the list
 373  * @server_account: if TRUE, this is a server account
 374  *
 375  * * set a config list of values of type @list_type of an account
 376  *
 377  * returns TRUE if this succeeded, FALSE otherwise
 378  */
 379 gboolean                modest_account_mgr_set_list       (ModestAccountMgr *self,
 380                                                            const gchar *name,
 381                                                            const gchar *key,
 382                                                            GSList *val,
 383                                                            ModestConfValueType list_type,
 384                                                            gboolean server_account);
 385
 386 /**
 387  * modest_account_mgr_unset:
 388  * @self: a ModestAccountMgr instance
 389  * @name: the name of the account
 390  * @key: the key of the value to unset
 391  * @server_account: if TRUE, this is a server account
 392  * @err: a GError ptr, or NULL to ignore.
 393  *
 394  * unsets the config value of an account and all their children keys
 395  *
 396  * Returns: TRUE if unsetting the value succeeded, or FALSE in case of error.
 397  * @err gives details in case of error
 398  */
 399 gboolean        modest_account_mgr_unset           (ModestAccountMgr *self,
 400                                                     const gchar *name,
 401                                                     const gchar *key,
 402                                                     gboolean server_account);
 403
 404 G_END_DECLS
 405
 406 #endif /* __MODEST_ACCOUNT_MGR_H__ */