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 #include <modest-tny-local-folders-account.h>
  44
  45 /* other include files */
  46
  47 G_BEGIN_DECLS
  48
  49 /* convenience macros */
  50 #define MODEST_TYPE_TNY_ACCOUNT_STORE             (modest_tny_account_store_get_type())
  51 #define MODEST_TNY_ACCOUNT_STORE(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_TNY_ACCOUNT_STORE,ModestTnyAccountStore))
  52 #define MODEST_TNY_ACCOUNT_STORE_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_TNY_ACCOUNT_STORE,ModestTnyAccountStoreClass))
  53 #define MODEST_IS_TNY_ACCOUNT_STORE(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_TNY_ACCOUNT_STORE))
  54 #define MODEST_IS_TNY_ACCOUNT_STORE_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_TNY_ACCOUNT_STORE))
  55 #define MODEST_TNY_ACCOUNT_STORE_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_TNY_ACCOUNT_STORE,ModestTnyAccountStoreClass))
  56
  57 typedef struct _ModestTnyAccountStore      ModestTnyAccountStore;
  58 typedef struct _ModestTnyAccountStoreClass ModestTnyAccountStoreClass;
  59 typedef TnyGetPassFunc ModestTnyGetPassFunc;
  60
  61 struct _ModestTnyAccountStore {
  62         GObject parent;
  63 };
  64
  65 struct _ModestTnyAccountStoreClass {
  66         GObjectClass parent_class;
  67
  68         void (*account_update)        (ModestTnyAccountStore *self,
  69                                       const gchar *account_name,
  70                                       gpointer user_data);
  71         void (*password_requested)    (ModestTnyAccountStore *self,
  72                                        const gchar *server_account_name,
  73                                        gchar **username,
  74                                        gchar **password,
  75                                        gboolean *remember,
  76                                        gboolean *cancel,
  77                                        gpointer user_data);
  78
  79         /* Signals */
  80         void (*account_changed) (TnyAccountStore *self, TnyAccount *account);
  81         void (*account_inserted) (TnyAccountStore *self, TnyAccount *account);
  82         void (*account_removed) (TnyAccountStore *self, TnyAccount *account);
  83 };
  84
  85 typedef enum {
  86         MODEST_TNY_ACCOUNT_STORE_QUERY_ID,
  87         MODEST_TNY_ACCOUNT_STORE_QUERY_URL,
  88 } ModestTnyAccountStoreQueryType;
  89
  90
  91 /**
  92  * modest_tny_account_store_get_type:
  93  *
  94  * Returns: GType of the account store
  95  */
  96 GType  modest_tny_account_store_get_type   (void) G_GNUC_CONST;
  97
  98 /**
  99  * modest_tny_account_store_new:
 100  * @account_mgr: account manager to use for new account store
 101  *
 102  * creates new (tinymail) account store for account manager modest_acc_mgr
 103  *
 104  * Returns: newly created account store or NULL in case of error
 105  */
 106 ModestTnyAccountStore*    modest_tny_account_store_new (ModestAccountMgr *account_mgr,
 107                                                         TnyDevice *device);
 108
 109
 110 /**
 111  * modest_tny_account_store_get_account_by
 112  * @self: a ModestTnyAccountStore instance
 113  * @id: some ID
 114  *
 115  * get the account with the given str or NULL if it's not found
 116  *
 117  * Returns: the tnyaccount or NULL,
 118  * g_object_unref when it's no longer needed
 119  */
 120 TnyAccount* modest_tny_account_store_get_tny_account_by  (ModestTnyAccountStore *self,
 121                                                           ModestTnyAccountStoreQueryType type,
 122                                                           const gchar *str);
 123
 124 /**
 125  * modest_tny_account_store_get_server_account
 126  * @self: a ModestTnyAccountStore instance
 127  * @account_name: a modest account name
 128  * @type: the tny account type (store or transport)
 129  *
 130  * Get the tny account corresponding to one of the server_accounts for account with @account_name
 131  *
 132  * Returns: the tnyaccount for the server account or NULL in case it's not found or error,
 133  * g_object_unref when it's no longer needed. TODO: Check that callers are unreffing.
 134  */
 135 TnyAccount* modest_tny_account_store_get_server_account (ModestTnyAccountStore *self,
 136                                                          const gchar *account_name,
 137                                                          TnyAccountType type);
 138
 139 /**
 140  * modest_tny_account_store_get_transport_account_for_open_connection
 141  * @self: a ModestTnyAccountStore instance
 142  * @account_name: an account name
 143  *
 144  * Get the tny account corresponding to the transport server account for the account with @account_name,
 145  * returning the connection-specific SMTP-server transport server account if one is specified,
 146  * otherwise just returning the regular transport server account.
 147  *
 148  * Returns: the tnyaccount for the server account or NULL in case it's not found or error,
 149  * g_object_unref when it's no longer needed
 150  */
 151 TnyAccount* modest_tny_account_store_get_transport_account_for_open_connection (ModestTnyAccountStore *self,
 152                                                                                 const gchar *account_name);
 153
 154 /**
 155  * tny_account_store_get_session
 156  * @self: a TnyAccountStore instance
 157  *
 158  * get the tny-camel-session for this account store. Note that this function
 159  * does NOT have the modest_ prefix, as tinymail requires the symbol to be like this...
 160  *
 161  * Returns: a tny-camel-session
 162  */
 163 TnySessionCamel*    modest_tny_account_store_get_session    (TnyAccountStore *self);
 164
 165 /** modest_tny_account_store_get_local_folders_account:
 166  * @self: a TnyAccountStore instance
 167  *
 168  * Get the user-visible local folders account.
 169  **/
 170 TnyAccount * modest_tny_account_store_get_local_folders_account (ModestTnyAccountStore *self);
 171
 172 /**
 173  * modest_tny_account_store_get_mmc_folders_account:
 174  * @self: a TnyAccountStore instance
 175  *
 176  * Get the mmc folders account.
 177  *
 178  * Returns: a #TnyAccount, or %NULL if no mmc account is available now.
 179  */
 180 TnyAccount * modest_tny_account_store_get_mmc_folders_account (ModestTnyAccountStore *self);
 181
 182 /** modest_tny_account_store_forget_already_asked:
 183   * @self: a TnyAccountStore instance
 184   * @account: the account to forget the already asked status for
 185   *
 186   * Forget the already asked status of an account
 187   **/
 188 void modest_tny_account_store_forget_already_asked (ModestTnyAccountStore *self, TnyAccount *account);
 189
 190 /**
 191  * modest_tny_account_store_find_msg_in_outboxes:
 192  * @self: a #ModestTnyAccountStore
 193  * @uri: the uri of the message
 194  * @ac_out: output attribute, %NULL, or the #TnyAccount of the message
 195  *
 196  * finds a message in the set of outboxes, using the uri.
 197  *
 198  * Returns: %NULL or a #TnyMsg
 199  **/
 200 TnyMsg *modest_tny_account_store_find_msg_in_outboxes (ModestTnyAccountStore *self,
 201                                                        const gchar *uri,
 202                                                        TnyAccount **ac_out);
 203
 204
 205 /**
 206  * modest_tny_account_store_get_transport_account_from_outbox_header:
 207  * @self: a #ModestTnyAccountStore
 208  * @header: a #TnyHeader
 209  *
 210  * Gets the transport account from a header that is in the outbox
 211  *
 212  * Returns: %NULL or a %TnyTransportAccount
 213  */
 214 TnyTransportAccount *
 215 modest_tny_account_store_get_transport_account_from_outbox_header(ModestTnyAccountStore *self,
 216                                                                   TnyHeader *header);
 217
 218 G_END_DECLS
 219
 220 #endif /* __MODEST_TNY_ACCOUNT_STORE_H__ */