This is a manual merge of branch drop split view intro trunk.
[modest] / src / modest-tny-account-store.h
index ff89590..239deb4 100644 (file)
 #define __MODEST_TNY_ACCOUNT_STORE_H__
 
 #include <glib-object.h>
-#include <modest-defs.h>
 #include <tny-account-store.h>
 #include <tny-session-camel.h>
 #include <tny-shared.h>
+#include <tny-folder.h>
 #include <modest-account-mgr.h>
+#include <modest-tny-local-folders-account.h>
+#include <gtk/gtkwidget.h>
 
 /* other include files */
 
@@ -63,12 +65,28 @@ struct _ModestTnyAccountStore {
 struct _ModestTnyAccountStoreClass {
        GObjectClass parent_class;
 
-       void (*account_update)    (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:
@@ -85,7 +103,56 @@ GType  modest_tny_account_store_get_type   (void) G_GNUC_CONST;
  *
  * Returns: newly created account store or NULL in case of error
  */
-ModestTnyAccountStore*    modest_tny_account_store_new (ModestAccountMgr *account_mgr);
+ModestTnyAccountStore*    modest_tny_account_store_new (ModestAccountMgr *account_mgr,
+                                                       TnyDevice *device);
+
+
+/**
+ * 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 (#TNY_ACCOUNT_TYPE_STORE or #TNY_ACCOUNT_TYPE_STORE)
+ * 
+ * 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.
+ */
+TnyAccount* modest_tny_account_store_get_server_account (ModestTnyAccountStore *self,
+                                                        const gchar *account_name,
+                                                        TnyAccountType type);
+
+/**
+ * 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);
+
+TnyAccount* modest_tny_account_store_get_smtp_specific_transport_account_for_open_connection (ModestTnyAccountStore *self,
+                                                                                             const gchar *account_name);
 
 /**
  * tny_account_store_get_session
@@ -96,35 +163,116 @@ ModestTnyAccountStore*    modest_tny_account_store_new (ModestAccountMgr *accoun
  *
  * 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. It returns a new
+ * reference so the caller must unref it when no longer needed
+ **/
+TnyAccount * modest_tny_account_store_get_local_folders_account (ModestTnyAccountStore *self);
 
 /**
- * tny_account_store_get_local_folders_account 
- * @self: a ModestTnyAccountStore instance
+ * modest_tny_account_store_get_mmc_folders_account:
+ * @self: a TnyAccountStore instance
  * 
- * return the account corresponding to the local folders
+ * Get the mmc folders account.
  *
- * Returns: the tnyaccount for the local folders
+ * Returns: a #TnyAccount, or %NULL if no mmc account is available
+ * now. It returns a new reference so the caller must unref it when no
+ * longer needed
  */
-TnyAccount*    modest_tny_account_store_get_local_folders_account    (ModestTnyAccountStore *self);
+TnyAccount * modest_tny_account_store_get_mmc_folders_account (ModestTnyAccountStore *self);
 
+/** modest_tny_account_store_forget_already_asked:
+  * @self: a TnyAccountStore instance
+  * @account: the account to forget the already asked status for
+  *
+  * Forget the already asked status of an account
+  **/
+void modest_tny_account_store_forget_already_asked (ModestTnyAccountStore *self, TnyAccount *account);
 
 /**
- * tny_account_store_get_special_folder
- * @self: a ModestTnyAccountStore instance
- * @type: some tny folder type
+ * modest_tny_account_store_find_msg_in_outboxes:
+ * @self: a #ModestTnyAccountStore
+ * @uri: the uri of the message
+ * @ac_out: output attribute, %NULL, or the #TnyAccount of the message
+ *
+ * finds a message in the set of outboxes, using the uri.
+ *
+ * Returns: %NULL or a #TnyMsg
+ **/
+TnyMsg *modest_tny_account_store_find_msg_in_outboxes (ModestTnyAccountStore *self, 
+                                                      const gchar *uri,
+                                                      TnyAccount **ac_out);
+
+
+/**
+ * modest_tny_account_store_get_transport_account_from_outbox_header:
+ * @self: a #ModestTnyAccountStore
+ * @header: a #TnyHeader
+ *
+ * Gets the transport account from a header that is in the outbox
+ *
+ * Returns: %NULL or a %TnyTransportAccount. Returns a new reference
+ * so the caller must unref it when no longer needed
+ */
+TnyTransportAccount * modest_tny_account_store_get_transport_account_from_outbox_header(ModestTnyAccountStore *self,
+                                                                                      TnyHeader *header);
+
+/**
+ * modest_tny_account_store_new_connection_specific_transport_account:
+ * @self: a #ModestTnyAccountStore
+ * @name: the name of the connection specific smtp transport account
+ *
+ * Creates a connection specific transport account and put it in the merged outbox
+ *
+ * Returns: the new #TnyTransportAccount
+ */
+TnyTransportAccount * modest_tny_account_store_new_connection_specific_transport_account (ModestTnyAccountStore *self,
+                                                                                         const gchar *name);
+
+typedef void (*ModestTnyAccountStoreShutdownCallback) (ModestTnyAccountStore *account_store, gpointer userdata);
+
+/**
+ * modest_tny_account_store_shutdown:
+ * @self: a #ModestTnyAccountStore
+ * @callback: a #ModestTnyAccountStoreShutdownCallback
+ * @userdata: a #gpointer
+ *
+ * Disconnects all registered accounts (forcing syncs for all of them).
+ */
+void modest_tny_account_store_shutdown (ModestTnyAccountStore *self,
+                                       ModestTnyAccountStoreShutdownCallback callback,
+                                       gpointer userdata);
+                                       
+
+/**
+ * modest_tny_account_store_is_send_mail_blocked:
+ * @self: a #ModestTnyAccountStore
  * 
- * get the special (Inbox,Outbox,Sent,Draft etc.) folder for this account
+ * Tells if we've blocked the send queue flush attempts temporally. This is
+ * usually done when we're editing an account, to prevent sending mails as
+ * it can cause problems
  *
- * Returns: the tny folder corresponding to this special folder, or NULL
+ * Returns: %TRUE if sending mail is blocked
  */
-TnyFolder*    modest_tny_account_store_get_special_folder   (ModestTnyAccountStore *self,
-                                                            TnyAccount *account,
-                                                            TnyFolderType special_type);
+gboolean modest_tny_account_store_is_send_mail_blocked (ModestTnyAccountStore *self);
+
+/**
+ * modest_tny_account_store_set_send_mail_blocked:
+ * @self: a #ModestTnyAccountStore
+ * @blocked: a #gboolean
+ * 
+ * Sets as blocked/non blocked the send queue flush attempts temporally. This is
+ * usually done when we're editing an account, to prevent sending mails as
+ * it can cause problems
+ */
+void modest_tny_account_store_set_send_mail_blocked (ModestTnyAccountStore *self, gboolean blocked);
+
+guint modest_tny_account_store_get_num_remote_accounts (ModestTnyAccountStore *self);
 
 G_END_DECLS
 
 #endif /* __MODEST_TNY_ACCOUNT_STORE_H__ */
-