2 * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3 * Copyright (C) 1999-2003 Hiroyuki Yamamoto
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
26 typedef struct _Folder Folder;
27 typedef struct _FolderClass FolderClass;
29 typedef struct _FolderItem FolderItem;
30 typedef struct _FolderUpdateData FolderUpdateData;
31 typedef struct _FolderItemUpdateData FolderItemUpdateData;
32 typedef struct _PersistPrefs PersistPrefs;
34 #define FOLDER(obj) ((Folder *)obj)
35 #define FOLDER_CLASS(obj) (FOLDER(obj)->klass)
36 #define FOLDER_TYPE(obj) (FOLDER(obj)->klass->type)
38 #define FOLDER_IS_LOCAL(obj) (FOLDER_TYPE(obj) == F_MH || \
39 FOLDER_TYPE(obj) == F_MBOX || \
40 FOLDER_TYPE(obj) == F_MAILDIR)
42 #define FOLDER_ITEM(obj) ((FolderItem *)obj)
44 #define FOLDER_UPDATE_HOOKLIST "folder_update"
45 #define FOLDER_ITEM_UPDATE_HOOKLIST "folder_item_update"
65 } SpecialFolderItemType;
93 F_MOVE_FAILED_DEST_IS_PARENT = -1,
94 F_MOVE_FAILED_DEST_IS_CHILD = -2,
95 F_MOVE_FAILED_DEST_OUTSIDE_MAILBOX = -3,
97 } FolderItemMoveResult;
101 FOLDER_NEW_FOLDER = 1 << 0,
102 FOLDER_DESTROY_FOLDER = 1 << 1,
103 FOLDER_TREE_CHANGED = 1 << 2,
104 FOLDER_NEW_FOLDERITEM = 1 << 3,
105 FOLDER_REMOVE_FOLDERITEM = 1 << 4,
110 F_ITEM_UPDATE_MSGCNT = 1 << 0,
111 F_ITEM_UPDATE_CONTENT = 1 << 1,
112 } FolderItemUpdateFlags;
114 typedef void (*FolderUIFunc) (Folder *folder,
117 typedef void (*FolderDestroyNotify) (Folder *folder,
120 typedef void (*FolderItemFunc) (FolderItem *item,
124 #include "folder_item_prefs.h"
127 #include "msgcache.h"
129 #include "prefs_account.h"
136 PrefsAccount *account;
144 FolderUIFunc ui_func;
145 gpointer ui_func_data;
160 /* virtual functions */
162 /* Folder funtions */
163 Folder *(*new_folder) (const gchar *name,
165 void (*destroy_folder) (Folder *folder);
166 void (*set_xml) (Folder *folder,
168 XMLTag *(*get_xml) (Folder *folder);
169 gint (*scan_tree) (Folder *folder);
171 gint (*create_tree) (Folder *folder);
173 /* FolderItem functions */
174 FolderItem *(*item_new) (Folder *folder);
175 void (*item_destroy) (Folder *folder,
177 void (*item_set_xml) (Folder *folder,
180 XMLTag *(*item_get_xml) (Folder *folder,
182 gchar *(*item_get_path) (Folder *folder,
184 FolderItem *(*create_folder) (Folder *folder,
187 gint (*rename_folder) (Folder *folder,
190 gint (*remove_folder) (Folder *folder,
192 gint (*close) (Folder *folder,
194 gint (*get_num_list) (Folder *folder,
197 gboolean *old_uids_valid);
198 void (*update_mark) (Folder *folder,
200 void (*finished_copy) (Folder *folder,
202 void (*finished_remove) (Folder *folder,
204 gboolean (*scan_required) (Folder *folder,
207 /* Message functions */
208 MsgInfo *(*get_msginfo) (Folder *folder,
211 GSList *(*get_msginfos) (Folder *folder,
213 MsgNumberList *msgnum_list);
214 gchar *(*fetch_msg) (Folder *folder,
217 gint (*add_msg) (Folder *folder,
221 gint (*add_msgs) (Folder *folder,
224 GRelation *relation);
225 gint (*copy_msg) (Folder *folder,
228 gint (*copy_msgs) (Folder *folder,
230 MsgInfoList *msglist,
231 GRelation *relation);
232 gint (*remove_msg) (Folder *folder,
235 gint (*remove_all_msg) (Folder *folder,
237 gboolean (*is_msg_changed) (Folder *folder,
240 void (*change_flags) (Folder *folder,
243 MsgPermFlags newflags);
248 SpecialFolderItemType stype;
258 gint unreadmarked_msgs;
265 guint no_sub : 1; /* no child allowed? */
266 guint no_select : 1; /* not selectable? */
267 guint collapsed : 1; /* collapsed item */
268 guint thread_collapsed : 1; /* collapsed item */
269 guint threaded : 1; /* threaded folder view */
270 guint hide_read_msgs : 1; /* hide read messages */
271 guint ret_rcpt : 1; /* return receipt */
274 guint opened : 1; /* opened by summary view */
275 FolderItemUpdateFlags update_flags; /* folderview for this folder should be updated */
277 FolderSortKey sort_key;
278 FolderSortType sort_type;
286 PrefsAccount *account;
294 FolderItemPrefs * prefs;
299 FolderSortKey sort_key;
300 FolderSortType sort_type;
302 guint thread_collapsed : 1;
304 guint hide_read_msgs : 1; /* CLAWS */
305 guint ret_rcpt : 1; /* CLAWS */
308 struct _FolderUpdateData
311 FolderUpdateFlags update_flags;
315 struct _FolderItemUpdateData
318 FolderItemUpdateFlags update_flags;
321 void folder_system_init (void);
322 void folder_register_class (FolderClass *klass);
323 Folder *folder_new (FolderClass *type,
326 void folder_init (Folder *folder,
329 void folder_destroy (Folder *folder);
331 void folder_set_xml (Folder *folder,
333 XMLTag *folder_get_xml (Folder *folder);
335 FolderItem *folder_item_new (Folder *folder,
338 void folder_item_append (FolderItem *parent,
340 void folder_item_remove (FolderItem *item);
341 void folder_item_remove_children (FolderItem *item);
342 void folder_item_destroy (FolderItem *item);
344 void folder_item_set_xml (Folder *folder,
347 XMLTag *folder_item_get_xml (Folder *folder,
350 void folder_set_ui_func (Folder *folder,
353 void folder_set_name (Folder *folder,
355 void folder_tree_destroy (Folder *folder);
357 void folder_add (Folder *folder);
359 GList *folder_get_list (void);
360 gint folder_read_list (void);
361 void folder_write_list (void);
362 void folder_scan_tree (Folder *folder);
363 FolderItem *folder_create_folder(FolderItem *parent, const gchar *name);
364 void folder_update_op_count (void);
365 void folder_func_to_all_folders (FolderItemFunc function,
367 void folder_count_total_msgs (guint *new_msgs,
369 guint *unreadmarked_msgs,
371 gchar *folder_get_status (GPtrArray *folders,
374 Folder *folder_find_from_path (const gchar *path);
375 Folder *folder_find_from_name (const gchar *name,
377 FolderItem *folder_find_item_from_path (const gchar *path);
378 FolderClass *folder_get_class_from_string (const gchar *str);
379 gchar *folder_get_identifier (Folder *folder);
380 gchar *folder_item_get_identifier (FolderItem *item);
381 FolderItem *folder_find_item_from_identifier (const gchar *identifier);
382 gchar *folder_item_get_name (FolderItem *item);
384 Folder *folder_get_default_folder (void);
385 FolderItem *folder_get_default_inbox (void);
386 FolderItem *folder_get_default_outbox (void);
387 FolderItem *folder_get_default_draft (void);
388 FolderItem *folder_get_default_queue (void);
389 FolderItem *folder_get_default_trash (void);
390 FolderItem *folder_get_default_processing (void);
391 void folder_set_missing_folders (void);
392 void folder_unref_account_all (PrefsAccount *account);
394 gchar *folder_item_get_path (FolderItem *item);
396 gint folder_item_open (FolderItem *item);
397 gint folder_item_close (FolderItem *item);
398 gint folder_item_scan (FolderItem *item);
399 void folder_item_scan_foreach (GHashTable *table);
400 MsgInfo *folder_item_get_msginfo (FolderItem *item,
402 MsgInfo *folder_item_get_msginfo_by_msgid(FolderItem *item,
404 GSList *folder_item_get_msg_list (FolderItem *item);
405 gchar *folder_item_fetch_msg (FolderItem *item,
407 gint folder_item_add_msg (FolderItem *dest,
410 gboolean remove_source);
411 gint folder_item_add_msgs (FolderItem *dest,
413 gboolean remove_source);
414 gint folder_item_move_to (FolderItem *src,
416 FolderItem **new_item);
417 gint folder_item_move_msg (FolderItem *dest,
419 gint folder_item_move_msgs (FolderItem *dest,
421 gint folder_item_copy_msg (FolderItem *dest,
423 gint folder_item_copy_msgs (FolderItem *dest,
425 gint folder_item_remove_msg (FolderItem *item,
427 gint folder_item_remove_msgs (FolderItem *item,
429 gint folder_item_remove_all_msg (FolderItem *item);
430 void folder_item_change_msg_flags (FolderItem *item,
432 MsgPermFlags newflags);
433 gboolean folder_item_is_msg_changed (FolderItem *item,
435 gchar *folder_item_get_cache_file (FolderItem *item);
436 gchar *folder_item_get_mark_file (FolderItem *item);
437 gchar * folder_item_get_identifier (FolderItem * item);
439 GHashTable *folder_persist_prefs_new (Folder *folder);
440 void folder_persist_prefs_free (GHashTable *pptable);
441 const PersistPrefs *folder_get_persist_prefs
442 (GHashTable *pptable, const char *name);
444 void folder_item_restore_persist_prefs (FolderItem *item, GHashTable *pptable);
445 void folder_clean_cache_memory (void);
446 void folder_item_write_cache (FolderItem *item);
447 void folder_item_set_default_flags (FolderItem *dest, MsgFlags *flags);
449 void folder_item_apply_processing (FolderItem *item);
451 void folder_item_update (FolderItem *item,
452 FolderItemUpdateFlags update_flags);
453 void folder_item_update_recursive (FolderItem *item,
454 FolderItemUpdateFlags update_flags);
455 void folder_item_update_freeze (void);
456 void folder_item_update_thaw (void);
458 #endif /* __FOLDER_H__ */