Modified webpage: now tinymail repository is in gitorious.
[modest] / src / modest-tny-account-store.h
index 30d3f0a..815f9b9 100644 (file)
 #define __MODEST_TNY_ACCOUNT_STORE_H__
 
 #include <glib-object.h>
+#include <gtk/gtk.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 */
 
@@ -88,6 +88,9 @@ typedef enum {
 } 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:
  *
@@ -125,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 (#TNY_ACCOUNT_TYPE_STORE or #TNY_ACCOUNT_TYPE_STORE)
+ * @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
  * 
@@ -246,7 +249,16 @@ typedef void (*ModestTnyAccountStoreShutdownCallback) (ModestTnyAccountStore *ac
 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:
@@ -283,6 +295,52 @@ guint modest_tny_account_store_get_num_remote_accounts (ModestTnyAccountStore *s
  **/
 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_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__ */