Modified webpage: now tinymail repository is in gitorious.
[modest] / src / modest-tny-account-store.h
index 50dc0b8..815f9b9 100644 (file)
@@ -34,7 +34,7 @@
 #define __MODEST_TNY_ACCOUNT_STORE_H__
 
 #include <glib-object.h>
-#include <modest-defs.h>
+#include <gtk/gtk.h>
 #include <tny-account-store.h>
 #include <tny-session-camel.h>
 #include <tny-shared.h>
@@ -75,15 +75,22 @@ struct _ModestTnyAccountStoreClass {
                                       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);
 };
 
 typedef enum {
        MODEST_TNY_ACCOUNT_STORE_QUERY_ID,
-       MODEST_TNY_ACCOUNT_STORE_QUERY_NAME,
        MODEST_TNY_ACCOUNT_STORE_QUERY_URL,
 } ModestTnyAccountStoreQueryType;
 
 
+/* We set 5Mb as the upper limit to consider disk full conditions */
+#define MODEST_TNY_ACCOUNT_STORE_MIN_FREE_SPACE 5 * 1024 * 1024
+
 /**
  * modest_tny_account_store_get_type:
  *
@@ -121,7 +128,7 @@ TnyAccount* modest_tny_account_store_get_tny_account_by  (ModestTnyAccountStore
  * 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)
+ * @type: the tny account type (#TNY_ACCOUNT_TYPE_STORE or #TNY_ACCOUNT_TYPE_TRANSPORT)
  * 
  * Get the tny account corresponding to one of the server_accounts for account with @account_name
  * 
@@ -147,6 +154,9 @@ TnyAccount* modest_tny_account_store_get_server_account (ModestTnyAccountStore *
 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
  * @self: a TnyAccountStore instance
@@ -161,29 +171,176 @@ TnySessionCamel*    modest_tny_account_store_get_session    (TnyAccountStore *se
 /** modest_tny_account_store_get_local_folders_account:
  * @self: a TnyAccountStore instance
  * 
- * Get the user-visible local folders account.
+ * 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 (TnyAccountStore *self);
+TnyAccount * modest_tny_account_store_get_local_folders_account (ModestTnyAccountStore *self);
 
-/** modest_tny_account_is_virtual_local_folders:
- * @self A TnyAccount.
+/**
+ * modest_tny_account_store_get_mmc_folders_account:
+ * @self: a TnyAccountStore instance
  * 
- * A convenience function to identify whether TnyAccount 
- * is the virtual local folders account, containing the folders from local_folders/
- * and the outboxes from outboxes/<account-name>/.
+ * Get the mmc folders account.
+ *
+ * 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_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);
+
+/**
+ * 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
  **/
-gboolean modest_tny_account_is_virtual_local_folders (TnyAccount *self);
+TnyMsg *modest_tny_account_store_find_msg_in_outboxes (ModestTnyAccountStore *self, 
+                                                      const gchar *uri,
+                                                      TnyAccount **ac_out);
 
-/** modest_tny_account_is_memory_card_account:
- * @self A TnyAccount.
+
+/**
+ * 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_shutdown:
+ * @self: a #ModestTnyAccountStore
+ *
+ * Check if all accounts are disconnected
+ *
+ * Returns: %TRUE if all accounts are disconnected, %FALSE otherwise.
+ */
+gboolean modest_tny_account_store_is_shutdown (ModestTnyAccountStore *self);
+
+/**
+ * modest_tny_account_store_is_send_mail_blocked:
+ * @self: a #ModestTnyAccountStore
+ * 
+ * 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: %TRUE if sending mail is blocked
+ */
+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
  * 
- * A convenience function to identify whether TnyAccount 
- * is the memory card account.
+ * 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);
+
+/**
+ * modest_tny_account_store_start_send_queues:
+ * @self: a #ModestTnyAccountStore
+ *
+ * Instantiates the send queues for the available transport
+ * accounts. Note that send queues will start to listen to
+ * connection-changed signals to try to send pending emails ASAP
+ **/
+void modest_tny_account_store_start_send_queues (ModestTnyAccountStore *self);
+
+/**
+ * modest_utils_check_disk_full_error:
+ * @parent_window: a #GtkWidget that will be used as the parent of information banners that will be shown
+ * @err: a #GError
+ * @alternate: a string that contains the error that will be shown if
+ * the memory full conditions happen in the MMC external storage
+ *
+ * Shows an information banner if the passed #GError is a disk full error.
+ *
+ * Returns: TRUE if it's a disk full error, false otherwise
+ **/
+gboolean modest_tny_account_store_check_disk_full_error (ModestTnyAccountStore *self,
+                                                        GtkWidget *parent_window,
+                                                        GError *err,
+                                                        TnyAccount *account,
+                                                        const gchar *alternate);
+
+/**
+ * modest_utils_is_disk_full_error:
+ * @error: a #GError
+ * @mail_op: the #ModestMailOperation that returned the error
+ * @is_mmc: returns if the disk full error happens in the external MMC or not
+ *
+ * This function returns if the given #GError is a disk full error or
+ * not, whithout showing anything to the user. The optional #is_mmc
+ * returns TRUE if the disk full conditions happen in the external MMC
+ * account
+ *
+ * Returns: TRUE if is a memory full error, FALSE otherwise.
  **/
-gboolean
-modest_tny_account_is_memory_card_account (TnyAccount *self);
+gboolean modest_tny_account_store_is_disk_full_error (ModestTnyAccountStore *self,
+                                                     GError *error,
+                                                     TnyAccount *account);
+
+
+/**
+ * modest_tny_account_store_forget_password_in_memory
+ * @self: a TnyAccountStore instance
+ * @account: A server account.
+ *
+ * Forget any password stored in memory for this account.
+ * For instance, this should be called when the user has changed the password in the account settings.
+ */
+void    modest_tny_account_store_forget_password_in_memory (ModestTnyAccountStore *self,
+                                                           const gchar *server_account_name);
 
 G_END_DECLS
 
 #endif /* __MODEST_TNY_ACCOUNT_STORE_H__ */
-