X-Git-Url: http://git.maemo.org/git/?p=modest;a=blobdiff_plain;f=src%2Fmodest-tny-account-store.h;h=76fbe912b6e02f07cbd6eb684ce1ffdbe534ebda;hp=2bdc960ad0748251be9570690623193b3ff29ce7;hb=40a8f5cbe03bd040fe3403dbfa6806df4fb6bc8a;hpb=6b39924eb8429cce9a95d4c35cd76fd1c998200a diff --git a/src/modest-tny-account-store.h b/src/modest-tny-account-store.h index 2bdc960..76fbe91 100644 --- a/src/modest-tny-account-store.h +++ b/src/modest-tny-account-store.h @@ -1,12 +1,46 @@ +/* Copyright (c) 2006, Nokia Corporation + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are + * met: + * + * * Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * * Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * * Neither the name of the Nokia Corporation nor the names of its + * contributors may be used to endorse or promote products derived from + * this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS + * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED + * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A + * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER + * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, + * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, + * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR + * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF + * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING + * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS + * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + + /* modest-tny-account-store.h */ -/* insert (c)/licensing information) */ #ifndef __MODEST_TNY_ACCOUNT_STORE_H__ #define __MODEST_TNY_ACCOUNT_STORE_H__ #include +#include #include #include +#include +#include +#include +#include /* other include files */ @@ -22,64 +56,119 @@ G_BEGIN_DECLS typedef struct _ModestTnyAccountStore ModestTnyAccountStore; typedef struct _ModestTnyAccountStoreClass ModestTnyAccountStoreClass; +typedef TnyGetPassFunc ModestTnyGetPassFunc; struct _ModestTnyAccountStore { - //TnyAccountStore parent; GObject parent; }; struct _ModestTnyAccountStoreClass { - //TnyAccountStoreClass parent_class; GObjectClass parent_class; - void (*password_requested) (ModestTnyAccountStore *self, - const gchar *account_name, - gpointer user_data); + void (*account_update) (ModestTnyAccountStore *self, + const gchar *account_name, + gpointer user_data); + void (*password_requested) (ModestTnyAccountStore *self, + const gchar *server_account_name, + gchar **username, + gchar **password, + gboolean *remember, + gboolean *cancel, + gpointer user_data); + + /* Signals */ + void (*account_changed) (TnyAccountStore *self, TnyAccount *account); + void (*account_inserted) (TnyAccountStore *self, TnyAccount *account); + void (*account_removed) (TnyAccountStore *self, TnyAccount *account); }; -/* member functions */ +typedef enum { + MODEST_TNY_ACCOUNT_STORE_QUERY_ID, + MODEST_TNY_ACCOUNT_STORE_QUERY_URL, +} ModestTnyAccountStoreQueryType; + /** * modest_tny_account_store_get_type: * - * returns GType of account store ??? - * - * Returns: ??? + * Returns: GType of the account store */ -GType modest_tny_account_store_get_type (void) G_GNUC_CONST; +GType modest_tny_account_store_get_type (void) G_GNUC_CONST; /** * modest_tny_account_store_new: - * @modest_acc_mgr: account manager to use for new account store + * @account_mgr: account manager to use for new account store * - * creates new tiny account store for account manager modest_acc_mgr + * creates new (tinymail) account store for account manager modest_acc_mgr * - * Returns: GObject of newly created account store + * Returns: newly created account store or NULL in case of error */ -GObject* modest_tny_account_store_new (ModestAccountMgr *modest_acc_mgr); +ModestTnyAccountStore* modest_tny_account_store_new (ModestAccountMgr *account_mgr, + TnyDevice *device); + /** - * modest_tny_account_store_get_accout_mgr: - * @self: a TnyAccountStore instance - * - * retrieve the account manager associated with this account store. - * - * Returns: the account manager for self. + * modest_tny_account_store_get_account_by + * @self: a ModestTnyAccountStore instance + * @id: some ID + * + * get the account with the given str or NULL if it's not found + * + * Returns: the tnyaccount or NULL, + * g_object_unref when it's no longer needed + */ +TnyAccount* modest_tny_account_store_get_tny_account_by (ModestTnyAccountStore *self, + ModestTnyAccountStoreQueryType type, + const gchar *str); + +/** + * modest_tny_account_store_get_server_account + * @self: a ModestTnyAccountStore instance + * @account_name: a modest account name + * @type: the tny account type (store or transport) + * + * Get the tny account corresponding to one of the server_accounts for account with @account_name + * + * Returns: the tnyaccount for the server account or NULL in case it's not found or error, + * g_object_unref when it's no longer needed. TODO: Check that callers are unreffing. */ -ModestAccountMgr *modest_tny_account_store_get_accout_mgr(TnyAccountStore *self); +TnyAccount* modest_tny_account_store_get_server_account (ModestTnyAccountStore *self, + const gchar *account_name, + TnyAccountType type); /** - * tny_account_store_get_session: + * modest_tny_account_store_get_transport_account_for_open_connection + * @self: a ModestTnyAccountStore instance + * @account_name: an account name + * + * Get the tny account corresponding to the transport server account for the account with @account_name, + * returning the connection-specific SMTP-server transport server account if one is specified, + * otherwise just returning the regular transport server account. + * + * Returns: the tnyaccount for the server account or NULL in case it's not found or error, + * g_object_unref when it's no longer needed + */ +TnyAccount* modest_tny_account_store_get_transport_account_for_open_connection (ModestTnyAccountStore *self, + const gchar *account_name); + +/** + * tny_account_store_get_session * @self: a TnyAccountStore instance + * + * get the tny-camel-session for this account store. Note that this function + * does NOT have the modest_ prefix, as tinymail requires the symbol to be like this... * - * retrieve current tinymail camel session - * - * Returns: current tinymail camel session + * Returns: a tny-camel-session */ -TnySessionCamel* tny_account_store_get_session (TnyAccountStore *self); +TnySessionCamel* modest_tny_account_store_get_session (TnyAccountStore *self); +/** modest_tny_account_store_get_local_folders_account: + * @self: a TnyAccountStore instance + * + * Get the user-visible local folders account. + **/ +TnyAccount * modest_tny_account_store_get_local_folders_account (ModestTnyAccountStore *self); G_END_DECLS #endif /* __MODEST_TNY_ACCOUNT_STORE_H__ */ -