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_removed)   (ModestAccountMgr *obj, const gchar* account,
  60                                     gboolean server_account, gpointer user_data);
  61         void (* account_changed)   (ModestAccountMgr *obj, const gchar* account,
  62                                     const gchar* key, gboolean server_account,
  63                                     gpointer user_data);
  64 };
  65
  66 /**
  67  * modest_account_mgr_get_type:
  68  *
  69  * get the GType for ModestAccountMgr
  70  *
  71  * Returns: the GType
  72  */
  73 GType           modest_account_mgr_get_type       (void) G_GNUC_CONST;
  74
  75
  76 /**
  77  * modest_account_mgr_new:
  78  * @modest_conf: a ModestConf instance
  79  *
  80  * Returns: a new ModestAccountMgr, or NULL in case of error
  81  */
  82 ModestAccountMgr*        modest_account_mgr_new            (ModestConf *modest_conf);
  83
  84
  85
  86 /**
  87  * modest_account_mgr_add_account:
  88  * @self: a ModestAccountMgr instance
  89  * @name: name (id) of the account, which is a valid UTF8 string that does not contain '/'
  90  * @store_name: the store account (ie. POP/IMAP)
  91  * @transport_name: the transport account (ie. sendmail/SMTP)
  92  * @enabled: Whether the account should be enabled initially.
  93  *
  94  * Create a new account. The account with @name should not already exist. The @name will
  95  * be used as the initial display name of the new account.
  96  *
  97  * Returns: TRUE if the creation succeeded, FALSE otherwise,
  98  */
  99 gboolean        modest_account_mgr_add_account    (ModestAccountMgr *self,
 100                                                    const gchar* name,
 101                                                    const gchar* store_name,
 102                                                    const gchar* transport_name,
 103                                                    gboolean enabled);
 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                                                    ModestConnectionProtocol security,
 128                                                    ModestAuthProtocol 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; note
 155  * that when deleting an account, also the corresponding server accounts will
 156  * be deleted
 157  *
 158  * Returns: TRUE if the creation succeeded, FALSE otherwise,
 159  * @err gives details in case of error
 160  */
 161 gboolean        modest_account_mgr_remove_account         (ModestAccountMgr *self,
 162                                                            const gchar* name,
 163                                                            gboolean server_account);
 164
 165
 166 /**
 167  * modest_account_mgr_account_names:
 168  * @self: a ModestAccountMgr instance
 169  * @only_enabled: Whether only enabled accounts should be returned.
 170  *
 171  * list all account names
 172  *
 173  * Returns: a newly allocated list of account names, or NULL in case of error or
 174  * if there are no accounts. The caller must free the returned GSList.
 175  *
 176  * TODO: I believe that the caller must free the strings in the GSList items too,
 177  * because this is implemented via gconf_client_all_dirs() which also requires a deep free,
 178  * though that's not documented. murrayc.
 179  */
 180 GSList*         modest_account_mgr_account_names    (ModestAccountMgr *self,
 181                                                      gboolean only_enabled);
 182
 183
 184 /**
 185  * modest_account_mgr_search_server_account:
 186  * @self: a ModestAccountMgr instance
 187  * @account_name: get only server accounts for @account_name, or NULL for any
 188  * @type: get only server accounts from protocol type @type, or MODEST_PROTOCOL_TYPE_UNKNOWN
 189  * @proto: get only server account with protocol @proto, or MODEST_PROTOCOL_UNKNOWN for any
 190  *
 191  * List all the server account names, optionally narrowing the result down to one account.
 192  *
 193  * Returns: a newly allocated list of server account names, or NULL in case of
 194  * error or if there are no server accounts. The caller must free the returned GSList
 195  */
 196 GSList*  modest_account_mgr_search_server_accounts  (ModestAccountMgr *self,
 197                                                      const gchar*       account_name,
 198                                                      ModestProtocolType type,
 199                                                      ModestProtocol     proto);
 200
 201 /**
 202  * modest_account_mgr_account_exists:
 203  * @self: a ModestAccountMgr instance
 204  * @name: the account name to check
 205  * @server_account: if TRUE, this is a server account
 206  *
 207  * check whether account @name exists. Note that this does not check the display name.
 208  *
 209  * Returns: TRUE if the account with name @name exists, FALSE otherwise (or in case of error)
 210  */
 211 gboolean        modest_account_mgr_account_exists         (ModestAccountMgr *self,
 212                                                            const gchar *name,
 213                                                            gboolean server_account);
 214
 215 /**
 216  * modest_account_mgr_account_exists:
 217  * @self: a ModestAccountMgr instance
 218  * @name: the account name to check
 219  *
 220  * check whether a non-server account with the @display_name exists.
 221  *
 222  * Returns: TRUE if the account with name @name exists, FALSE otherwise (or in case of error)
 223  */
 224 gboolean        modest_account_mgr_account_with_display_name_exists       (ModestAccountMgr *self,
 225                                                            const gchar *display_name);
 226
 227
 228 /**
 229  * modest_account_mgr_get_string:
 230  * @self: self a ModestAccountMgr instance
 231  * @name: the name of the account
 232  * @key: the key of the value to retrieve
 233  * @server_account: if TRUE, this is a server account
 234  *
 235  * get a config string from an account
 236  *
 237  * Returns: a newly allocated string with the value for the key,
 238  * or NULL in case of error.
 239  */
 240 gchar*          modest_account_mgr_get_string     (ModestAccountMgr *self,
 241                                                    const gchar *name,
 242                                                    const gchar *key,
 243                                                    gboolean server_account);
 244
 245
 246 /**
 247  * modest_account_mgr_get_password:
 248  * @self: self a ModestAccountMgr instance
 249  * @name: the name of the account
 250  * @key: the key of the value to retrieve
 251  * @server_account: if TRUE, this is a server account
 252  *
 253  * get a password from an account
 254  *
 255  * Returns: a newly allocated string with the value for the key,
 256  * or NULL in case of error.
 257  */
 258 gchar*          modest_account_mgr_get_password     (ModestAccountMgr *self,
 259                                                      const gchar *name,
 260                                                      const gchar *key,
 261                                                      gboolean server_account);
 262
 263 /**
 264  * modest_account_mgr_get_int:
 265  * @self: a ModestAccountMgr instance
 266  * @name: the name of the account
 267  * @key: the key of the value to retrieve
 268  * @server_account: if TRUE, this is a server account
 269  *
 270  * get a config int from an account
 271  *
 272  * Returns: an integer with the value for the key, or -1 in case of
 273  * error (but of course -1 does not necessarily imply an error)
 274  */
 275 gint            modest_account_mgr_get_int        (ModestAccountMgr *self,
 276                                                    const gchar *name,
 277                                                    const gchar *key,
 278                                                    gboolean server_account);
 279
 280 /**
 281  * modest_account_mgr_get_bool:
 282  * @self: a ModestAccountMgr instance
 283  * @name: the name of the account
 284  * @key: the key of the value to retrieve
 285  * @server_account: if TRUE, this is a server account
 286  *
 287  * get a config boolean from an account
 288  *
 289  * Returns: an boolean with the value for the key, or FALSE in case of
 290  * error (but of course FALSE does not necessarily imply an error)
 291  */
 292 gboolean        modest_account_mgr_get_bool       (ModestAccountMgr *self,
 293                                                    const gchar *name,
 294                                                    const gchar *key,
 295                                                    gboolean server_account);
 296
 297 /**
 298  * modest_account_mgr_get_list:
 299  * @self: a ModestAccountMgr instance
 300  * @name: the name of the account
 301  * @key: the key of the value to get
 302  * @list_type: the type of the members of the list
 303  * @server_account: if TRUE, this is a server account
 304  *
 305  * get a config list of values of type @list_type of an account
 306  *
 307  * Returns: a newly allocated list of elements
 308  */
 309 GSList*         modest_account_mgr_get_list       (ModestAccountMgr *self,
 310                                                    const gchar *name,
 311                                                    const gchar *key,
 312                                                    ModestConfValueType list_type,
 313                                                    gboolean server_account);
 314
 315 /**
 316  * modest_account_mgr_set_string:
 317  * @self: a ModestAccountMgr instance
 318  * @name: the name of the account
 319  * @key: the key of the value to set
 320  * @val: the value to set
 321  * @server_account: if TRUE, this is a server account
 322  *
 323  * set a config string for an account.
 324  *
 325  * Returns: TRUE if setting the value succeeded, or FALSE in case of error.
 326  */
 327 gboolean        modest_account_mgr_set_string     (ModestAccountMgr *self,
 328                                                    const gchar *name,
 329                                                    const gchar *key, const gchar* val,
 330                                                    gboolean server_account);
 331
 332
 333 /**
 334  * modest_account_mgr_set_password:
 335  * @self: a ModestAccountMgr instance
 336  * @name: the name of the account
 337  * @key: the key of the value to set
 338  * @val: the value to set
 339  * @server_account: if TRUE, this is a server account
 340  *
 341  * set a password for an account.
 342  *
 343  * Returns: TRUE if setting the value succeeded, or FALSE in case of error.
 344 * @err gives details in case of error
 345  */
 346 gboolean        modest_account_mgr_set_password     (ModestAccountMgr *self,
 347                                                      const gchar *name,
 348                                                      const gchar *key, const gchar* val,
 349                                                      gboolean server_account);
 350
 351 /**
 352  * modest_account_mgr_set_int:
 353  * @self: a ModestAccountMgr instance
 354  * @name: the name of the account
 355  * @key: the key of the value to set
 356  * @val: the value to set
 357  * @server_account: if TRUE, this is a server account
 358  *
 359  * set a config int for an account
 360  *
 361  * Returns: TRUE if setting the value succeeded, or FALSE in case of error.
 362  */
 363 gboolean        modest_account_mgr_set_int        (ModestAccountMgr *self,
 364                                                    const gchar *name,
 365                                                    const gchar *key, gint val,
 366                                                    gboolean server_account);
 367
 368 /**
 369  * modest_account_mgr_set_bool:
 370  * @self: a ModestAccountMgr instance
 371  * @name: the name of the account
 372  * @key: the key of the value to set
 373  * @val: the value to set
 374  * @server_account: if TRUE, this is a server account
 375  *
 376  * set a config bool for an account
 377  *
 378  * Returns: TRUE if setting the value succeeded, or FALSE in case of error.
 379  */
 380 gboolean        modest_account_mgr_set_bool       (ModestAccountMgr *self,
 381                                                    const gchar *name,
 382                                                    const gchar *key, gboolean val,
 383                                                    gboolean server_account);
 384
 385 /**
 386  * modest_account_mgr_set_list:
 387  * @self: a ModestAccountMgr instance
 388  * @name: the name of the account
 389  * @key: the key of the value to set
 390  * @val: the list with the values to set
 391  * @list_type: the type of the members of the list
 392  * @server_account: if TRUE, this is a server account
 393  *
 394  * * set a config list of values of type @list_type of an account
 395  *
 396  * returns TRUE if this succeeded, FALSE otherwise
 397  */
 398 gboolean                modest_account_mgr_set_list       (ModestAccountMgr *self,
 399                                                            const gchar *name,
 400                                                            const gchar *key,
 401                                                            GSList *val,
 402                                                            ModestConfValueType list_type,
 403                                                            gboolean server_account);
 404
 405 /**
 406  * modest_account_mgr_unset:
 407  * @self: a ModestAccountMgr instance
 408  * @name: the name of the account
 409  * @key: the key of the value to unset
 410  * @server_account: if TRUE, this is a server account
 411  * @err: a GError ptr, or NULL to ignore.
 412  *
 413  * unsets the config value of an account and all their children keys
 414  *
 415  * Returns: TRUE if unsetting the value succeeded, or FALSE in case of error.
 416  * @err gives details in case of error
 417  */
 418 gboolean        modest_account_mgr_unset           (ModestAccountMgr *self,
 419                                                     const gchar *name,
 420                                                     const gchar *key,
 421                                                     gboolean server_account);
 422
 423 G_END_DECLS
 424
 425 #endif /* __MODEST_ACCOUNT_MGR_H__ */