git.maemo.org Git - modest/blob - src/modest-tny-account-store.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 /* modest-tny-account-store.h */
  32
  33 #ifndef __MODEST_TNY_ACCOUNT_STORE_H__
  34 #define __MODEST_TNY_ACCOUNT_STORE_H__
  35
  36 #include <glib-object.h>
  37 #include <modest-defs.h>
  38 #include <tny-account-store.h>
  39 #include <tny-session-camel.h>
  40 #include <tny-shared.h>
  41 #include <tny-folder.h>
  42 #include <modest-account-mgr.h>
  43
  44 /* other include files */
  45
  46 G_BEGIN_DECLS
  47
  48 /* convenience macros */
  49 #define MODEST_TYPE_TNY_ACCOUNT_STORE             (modest_tny_account_store_get_type())
  50 #define MODEST_TNY_ACCOUNT_STORE(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_TNY_ACCOUNT_STORE,ModestTnyAccountStore))
  51 #define MODEST_TNY_ACCOUNT_STORE_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_TNY_ACCOUNT_STORE,ModestTnyAccountStoreClass))
  52 #define MODEST_IS_TNY_ACCOUNT_STORE(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_TNY_ACCOUNT_STORE))
  53 #define MODEST_IS_TNY_ACCOUNT_STORE_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_TNY_ACCOUNT_STORE))
  54 #define MODEST_TNY_ACCOUNT_STORE_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_TNY_ACCOUNT_STORE,ModestTnyAccountStoreClass))
  55
  56 typedef struct _ModestTnyAccountStore      ModestTnyAccountStore;
  57 typedef struct _ModestTnyAccountStoreClass ModestTnyAccountStoreClass;
  58 typedef TnyGetPassFunc ModestTnyGetPassFunc;
  59
  60 struct _ModestTnyAccountStore {
  61         GObject parent;
  62 };
  63
  64 struct _ModestTnyAccountStoreClass {
  65         GObjectClass parent_class;
  66
  67         void (*account_update)    (ModestTnyAccountStore *self,
  68                                    const gchar *account_name,
  69                                    gpointer user_data);
  70 };
  71
  72 /* member functions */
  73
  74 /**
  75  * modest_tny_account_store_get_type:
  76  *
  77  * Returns: GType of the account store
  78  */
  79 GType  modest_tny_account_store_get_type   (void) G_GNUC_CONST;
  80
  81 /**
  82  * modest_tny_account_store_new:
  83  * @account_mgr: account manager to use for new account store
  84  *
  85  * creates new (tinymail) account store for account manager modest_acc_mgr
  86  *
  87  * Returns: newly created account store or NULL in case of error
  88  */
  89 ModestTnyAccountStore*    modest_tny_account_store_new (ModestAccountMgr *account_mgr);
  90
  91 /**
  92  * tny_account_store_get_session
  93  * @self: a TnyAccountStore instance
  94  *
  95  * get the tny-camel-session for this account store. Note that this function
  96  * does NOT have the modest_ prefix, as tinymail requires the symbol to be like this...
  97  *
  98  * Returns: a tny-camel-session
  99  */
 100 TnySessionCamel*    tny_account_store_get_session    (TnyAccountStore *self);
 101
 102
 103
 104 /**
 105  * tny_account_store_get_local_folders_account
 106  * @self: a ModestTnyAccountStore instance
 107  *
 108  * return the account corresponding to the local folders
 109  *
 110  * Returns: the tnyaccount for the local folders
 111  */
 112 TnyAccount*    modest_tny_account_store_get_local_folders_account    (ModestTnyAccountStore *self);
 113
 114
 115 /**
 116  * tny_account_store_get_special_folder
 117  * @self: a ModestTnyAccountStore instance
 118  * @type: some tny folder type
 119  *
 120  * get the special (Inbox,Outbox,Sent,Draft etc.) folder for this account
 121  *
 122  * Returns: the tny folder corresponding to this special folder, or NULL
 123  */
 124 TnyFolder*    modest_tny_account_store_get_special_folder   (ModestTnyAccountStore *self,
 125                                                              TnyAccount *account,
 126                                                              TnyFolderType special_type);
 127
 128 G_END_DECLS
 129
 130 #endif /* __MODEST_TNY_ACCOUNT_STORE_H__ */
 131