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