2009-03-30 [colin] 3.7.1cvs30
[claws.git] / src / folder.h
index 1ab437e61e32038521ccbf54fa4302b8dde79d92..b740183917fee53f5bbfd2f091c1489fe6fe4a81 100644 (file)
@@ -2,11 +2,11 @@
 
 /*
  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
- * Copyright (C) 1999-2007 Hiroyuki Yamamoto and the Claws Mail team
+ * Copyright (C) 1999-2009 Hiroyuki Yamamoto and the Claws Mail team
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
+ * the Free Software Foundation; either version 3 of the License, or
  * (at your option) any later version.
  *
  * This program is distributed in the hope that it will be useful,
@@ -15,8 +15,8 @@
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ * 
  */
 
 #ifndef __FOLDER_H__
@@ -80,7 +80,9 @@ typedef enum
        SORT_BY_STATUS,
        SORT_BY_MIME,
        SORT_BY_TO,
-       SORT_BY_LOCKED
+       SORT_BY_LOCKED,
+       SORT_BY_TAGS,
+       SORT_BY_THREAD_DATE
 } FolderSortKey;
 
 typedef enum
@@ -390,6 +392,12 @@ struct _FolderClass
        gboolean        (*scan_required)        (Folder         *folder,
                                                 FolderItem     *item);
 
+       /**
+        * Updates the known mtime of a folder
+        */
+       void            (*set_mtime)            (Folder         *folder,
+                                                FolderItem     *item);
+
        /* Message functions */
        /**
         * Get a MsgInfo for a message in a \c FolderItem
@@ -513,6 +521,8 @@ struct _FolderClass
                                                 FolderItem     *item,
                                                 MsgInfoList    *msglist,
                                                 GRelation      *relation);
+       gint            (*expunge)              (Folder         *folder,
+                                                FolderItem     *item);
        /**
         * Remove all messages in a \ c FolderItem
         *
@@ -581,8 +591,10 @@ struct _FolderClass
        /* Called when switching offline or asking for synchronisation. the imple
         * mentation should do what's necessary to be able to read mails present
         * in the FolderItem at this time with no network connectivity. 
+        * Days: max number of days of mail to fetch.
         */
-       void            (*synchronise)          (FolderItem     *item);
+       void            (*synchronise)          (FolderItem     *item,
+                                                gint            days);
        
        /* Passed from claws-mail --subscribe scheme://uri. Implementations
         * should check if they handle this type of URI, and return TRUE in this
@@ -603,6 +615,22 @@ struct _FolderClass
        void            (*copy_private_data)    (Folder         *folder,
                                                 FolderItem     *src,
                                                 FolderItem     *dest);
+
+       void            (*remove_cached_msg)    (Folder         *folder,
+                                                FolderItem     *item,
+                                                MsgInfo        *msginfo);
+       void            (*commit_tags)          (FolderItem     *item,
+                                                MsgInfo        *msginfo,
+                                                GSList         *tags_set,
+                                                GSList         *tags_unset);
+       void            (*item_opened)          (FolderItem     *item);
+       void            (*item_closed)          (FolderItem     *item);
+};
+
+enum {
+       ITEM_NOT_SCANNING,
+       ITEM_SCANNING_WITH_FLAGS,
+       ITEM_SCANNING
 };
 
 struct _FolderItem
@@ -619,10 +647,20 @@ struct _FolderItem
        gint total_msgs;
        gint unreadmarked_msgs;
        gint marked_msgs;
+       gint replied_msgs;
+       gint forwarded_msgs;
+       gint locked_msgs;
+       gint ignored_msgs;
+       gint watched_msgs;
+
+       gint order;
 
        gint last_num;
 
        MsgCache *cache;
+       gboolean cache_dirty;
+       gboolean mark_dirty;
+       gboolean tags_dirty;
 
        /* special flags */
        guint no_sub         : 1; /* no child allowed?    */
@@ -633,6 +671,7 @@ struct _FolderItem
        guint hide_read_msgs : 1; /* hide read messages   */
        guint ret_rcpt       : 1; /* return receipt       */
        guint search_match   : 1;
+       guint hide_del_msgs : 1; /* hide deleted messages   */
 
        gint op_count;
        guint opened         : 1; /* opened by summary view */
@@ -658,7 +697,8 @@ struct _FolderItem
        /* for faster search of special parents */
        SpecialFolderItemType parent_stype;
        gboolean processing_pending;
-       gboolean scanning;
+       gint scanning;
+       guint last_seen;
 };
 
 struct _PersistPrefs
@@ -670,6 +710,7 @@ struct _PersistPrefs
        guint           threaded        : 1;
        guint           hide_read_msgs  : 1; /* CLAWS */
        guint           ret_rcpt        : 1; /* CLAWS */
+       guint           hide_del_msgs   : 1; /* CLAWS */
 };
 
 struct _FolderUpdateData
@@ -741,7 +782,9 @@ void   folder_func_to_all_folders   (FolderItemFunc function,
                                         gpointer data);
 void folder_count_total_msgs(guint *new_msgs, guint *unread_msgs, 
                             guint *unreadmarked_msgs, guint *marked_msgs,
-                            guint *total_msgs);
+                            guint *total_msgs, guint *replied_msgs,
+                            guint *forwarded_msgs, guint *locked_msgs,
+                            guint *ignored_msgs, guint *watched_msgs);
 gchar *folder_get_status       (GPtrArray      *folders,
                                 gboolean        full);
 
@@ -749,18 +792,27 @@ Folder     *folder_find_from_path         (const gchar    *path);
 Folder     *folder_find_from_name              (const gchar    *name,
                                                 FolderClass    *klass);
 FolderItem *folder_find_item_from_path         (const gchar    *path);
+FolderItem *folder_find_item_from_real_path    (const gchar    *path);
 FolderClass *folder_get_class_from_string      (const gchar    *str);
 FolderItem *folder_find_child_item_by_name     (FolderItem     *item,
                                                 const gchar    *name);
+/* return value is locale charset */
+gchar     *folder_get_identifier               (Folder *folder);
+/* return value is locale charset */
 gchar      *folder_item_get_identifier         (FolderItem     *item);
 FolderItem *folder_find_item_from_identifier   (const gchar    *identifier);
 gchar     *folder_item_get_name                (FolderItem     *item);
 
 FolderItem *folder_get_default_inbox   (void);
+FolderItem *folder_get_default_inbox_for_class(FolderType type);
 FolderItem *folder_get_default_outbox  (void);
+FolderItem *folder_get_default_outbox_for_class(FolderType type);
 FolderItem *folder_get_default_draft   (void);
+FolderItem *folder_get_default_draft_for_class(FolderType type);
 FolderItem *folder_get_default_queue   (void);
+FolderItem *folder_get_default_queue_for_class(FolderType type);
 FolderItem *folder_get_default_trash   (void);
+FolderItem *folder_get_default_trash_for_class(FolderType type);
 FolderItem *folder_get_default_processing (void);
 void folder_set_missing_folders                (void);
 void folder_unref_account_all          (PrefsAccount   *account);
@@ -773,8 +825,6 @@ gint   folder_item_close            (FolderItem     *item);
 gint   folder_item_scan                        (FolderItem     *item);
 gint   folder_item_scan_full           (FolderItem     *item, 
                                         gboolean        filtering);
-gint   folder_item_syncronize_flags    (FolderItem     *item);
-void   folder_item_scan_foreach                (GHashTable     *table);
 MsgInfo *folder_item_get_msginfo       (FolderItem     *item,
                                         gint            num);
 MsgInfo *folder_item_get_msginfo_by_msgid(FolderItem   *item,
@@ -787,7 +837,6 @@ gchar *folder_item_fetch_msg_full   (FolderItem     *item,
                                         gint            num, 
                                         gboolean        get_headers,
                                         gboolean        get_body);
-gint   folder_item_fetch_all_msg       (FolderItem     *item);
 gint   folder_item_add_msg             (FolderItem     *dest,
                                         const gchar    *file,
                                         MsgFlags       *flags,
@@ -811,19 +860,17 @@ gint   folder_item_remove_msg             (FolderItem     *item,
                                         gint            num);
 gint   folder_item_remove_msgs         (FolderItem     *item,
                                         GSList         *msglist);
+gint   folder_item_expunge             (FolderItem     *item);
 gint   folder_item_remove_all_msg      (FolderItem     *item);
 void   folder_item_change_msg_flags    (FolderItem     *item,
                                         MsgInfo        *msginfo,
                                         MsgPermFlags    newflags);
 gboolean folder_item_is_msg_changed    (FolderItem     *item,
                                         MsgInfo        *msginfo);
-/* return value is locale chaset */
-gchar * folder_item_get_identifier     (FolderItem * item);
 
 void folder_clean_cache_memory         (FolderItem *protected_item);
 void folder_clean_cache_memory_force   (void);
 void folder_item_write_cache           (FolderItem *item);
-void folder_item_set_default_flags     (FolderItem *dest, MsgFlags *flags);
 
 void folder_item_apply_processing      (FolderItem *item);
 
@@ -837,10 +884,6 @@ void folder_item_set_batch         (FolderItem *item, gboolean batch);
 gboolean folder_has_parent_of_type     (FolderItem *item, SpecialFolderItemType type);
 void folder_synchronise                        (Folder *folder);
 gboolean folder_want_synchronise       (Folder *folder);
-void folder_item_process_open          (FolderItem *item,
-                                        void (*before_proc_func)(gpointer data),
-                                        void (*after_proc_func)(gpointer data),
-                                        gpointer data);
 gboolean folder_subscribe              (const gchar *uri);
 gboolean folder_have_mailbox           (void);
 gboolean folder_item_free_cache                (FolderItem *item, gboolean force);
@@ -849,5 +892,8 @@ void folder_item_change_type                (FolderItem *item,
 gboolean folder_get_sort_type          (Folder         *folder,
                                         FolderSortKey  *sort_key,
                                         FolderSortType *sort_type);
+void folder_item_synchronise           (FolderItem *item);
+void folder_item_discard_cache         (FolderItem *item);
+void folder_item_commit_tags(FolderItem *item, MsgInfo *msginfo, GSList *tags_set, GSList *tags_unset);
 
 #endif /* __FOLDER_H__ */