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