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 _LocalFolder LocalFolder;
30 typedef struct _RemoteFolder RemoteFolder;
32 typedef struct _MaildirFolder MaildirFolder;
35 typedef struct _FolderItem FolderItem;
36 typedef struct _FolderUpdateData FolderUpdateData;
37 typedef struct _FolderItemUpdateData FolderItemUpdateData;
39 #define FOLDER(obj) ((Folder *)obj)
40 #define FOLDER_CLASS(obj) (FOLDER(obj)->klass)
41 #define FOLDER_TYPE(obj) (FOLDER(obj)->klass->type)
43 #define LOCAL_FOLDER(obj) ((LocalFolder *)obj)
44 #define REMOTE_FOLDER(obj) ((RemoteFolder *)obj)
46 #define FOLDER_IS_LOCAL(obj) (FOLDER_TYPE(obj) == F_MH || \
47 FOLDER_TYPE(obj) == F_MBOX || \
48 FOLDER_TYPE(obj) == F_MAILDIR)
51 #define MAILDIR_FOLDER(obj) ((MaildirFolder *)obj)
54 #define FOLDER_ITEM(obj) ((FolderItem *)obj)
56 #define FOLDER_UPDATE_HOOKLIST "folder_update"
57 #define FOLDER_ITEM_UPDATE_HOOKLIST "folder_item_update"
77 } SpecialFolderItemType;
105 F_MOVE_FAILED_DEST_IS_PARENT = -1,
106 F_MOVE_FAILED_DEST_IS_CHILD = -2,
107 F_MOVE_FAILED_DEST_OUTSIDE_MAILBOX = -3,
109 } FolderItemMoveResult;
113 FOLDER_TREE_CHANGED = 1 << 0,
114 FOLDER_NEW_FOLDERITEM = 1 << 1,
115 FOLDER_REMOVE_FOLDERITEM = 1 << 2,
120 F_ITEM_UPDATE_MSGCNT = 1 << 0,
121 F_ITEM_UPDATE_CONTENT = 1 << 1,
122 } FolderItemUpdateFlags;
124 typedef void (*FolderUIFunc) (Folder *folder,
127 typedef void (*FolderDestroyNotify) (Folder *folder,
130 typedef void (*FolderItemFunc) (FolderItem *item,
133 #include "folder_item_prefs.h"
135 #include "prefs_account.h"
138 #include "msgcache.h"
145 PrefsAccount *account;
153 FolderUIFunc ui_func;
154 gpointer ui_func_data;
169 /* virtual functions */
171 /* Folder funtions */
172 Folder *(*new_folder) (const gchar *name,
174 void (*destroy_folder) (Folder *folder);
175 gint (*scan_tree) (Folder *folder);
177 gint (*create_tree) (Folder *folder);
179 /* FolderItem functions */
180 FolderItem *(*item_new) (Folder *folder);
181 void (*item_destroy) (Folder *folder,
183 gchar *(*item_get_path) (Folder *folder,
185 FolderItem *(*create_folder) (Folder *folder,
188 gint (*rename_folder) (Folder *folder,
191 gint (*remove_folder) (Folder *folder,
193 gint (*close) (Folder *folder,
195 gint (*get_num_list) (Folder *folder,
198 gboolean *old_uids_valid);
199 void (*update_mark) (Folder *folder,
201 void (*finished_copy) (Folder *folder,
203 void (*finished_remove) (Folder *folder,
205 gboolean (*scan_required) (Folder *folder,
208 /* Message functions */
209 MsgInfo *(*get_msginfo) (Folder *folder,
212 GSList *(*get_msginfos) (Folder *folder,
214 MsgNumberList *msgnum_list);
215 gchar *(*fetch_msg) (Folder *folder,
218 gint (*add_msg) (Folder *folder,
222 gint (*add_msgs) (Folder *folder,
225 GRelation *relation);
226 gint (*copy_msg) (Folder *folder,
229 gint (*copy_msgs) (Folder *folder,
231 MsgInfoList *msglist,
232 GRelation *relation);
233 gint (*remove_msg) (Folder *folder,
236 gint (*remove_all_msg) (Folder *folder,
238 gboolean (*is_msg_changed) (Folder *folder,
241 void (*change_flags) (Folder *folder,
244 MsgPermFlags newflags);
262 struct _MaildirFolder
270 SpecialFolderItemType stype;
280 gint unreadmarked_msgs;
287 guint no_sub : 1; /* no child allowed? */
288 guint no_select : 1; /* not selectable? */
289 guint collapsed : 1; /* collapsed item */
290 guint thread_collapsed : 1; /* collapsed item */
291 guint threaded : 1; /* threaded folder view */
292 guint hide_read_msgs : 1; /* hide read messages */
293 guint ret_rcpt : 1; /* return receipt */
296 guint opened : 1; /* opened by summary view */
297 FolderItemUpdateFlags update_flags; /* folderview for this folder should be updated */
299 FolderSortKey sort_key;
300 FolderSortType sort_type;
308 PrefsAccount *account;
316 FolderItemPrefs * prefs;
320 FolderSortKey sort_key;
321 FolderSortType sort_type;
323 guint thread_collapsed : 1;
325 guint hide_read_msgs : 1; /* CLAWS */
326 guint ret_rcpt : 1; /* CLAWS */
329 struct _FolderUpdateData
332 FolderUpdateFlags update_flags;
336 struct _FolderItemUpdateData
339 FolderItemUpdateFlags update_flags;
342 void folder_system_init (void);
343 void folder_register_class (FolderClass *klass);
344 Folder *folder_new (FolderClass *type,
347 void folder_local_folder_init (Folder *folder,
350 void folder_remote_folder_init (Folder *folder,
354 void folder_destroy (Folder *folder);
355 void folder_local_folder_destroy (LocalFolder *lfolder);
356 void folder_remote_folder_destroy(RemoteFolder *rfolder);
358 FolderItem *folder_item_new (Folder *folder,
361 void folder_item_append (FolderItem *parent,
363 void folder_item_remove (FolderItem *item);
364 void folder_item_remove_children (FolderItem *item);
365 void folder_item_destroy (FolderItem *item);
367 void folder_set_ui_func (Folder *folder,
370 void folder_set_name (Folder *folder,
372 void folder_tree_destroy (Folder *folder);
374 void folder_add (Folder *folder);
376 GList *folder_get_list (void);
377 gint folder_read_list (void);
378 void folder_write_list (void);
379 void folder_scan_tree (Folder *folder);
380 FolderItem *folder_create_folder(FolderItem *parent, const gchar *name);
381 void folder_update_op_count (void);
382 void folder_func_to_all_folders (FolderItemFunc function,
384 void folder_count_total_msgs (guint *new_msgs,
386 guint *unreadmarked_msgs,
388 gchar *folder_get_status (GPtrArray *folders,
391 Folder *folder_find_from_path (const gchar *path);
392 Folder *folder_find_from_name (const gchar *name,
394 FolderItem *folder_find_item_from_path (const gchar *path);
395 FolderClass *folder_get_class_from_string (const gchar *str);
396 gchar *folder_get_identifier (Folder *folder);
397 gchar *folder_item_get_identifier (FolderItem *item);
398 FolderItem *folder_find_item_from_identifier (const gchar *identifier);
399 gchar *folder_item_get_name (FolderItem *item);
401 Folder *folder_get_default_folder (void);
402 FolderItem *folder_get_default_inbox (void);
403 FolderItem *folder_get_default_outbox (void);
404 FolderItem *folder_get_default_draft (void);
405 FolderItem *folder_get_default_queue (void);
406 FolderItem *folder_get_default_trash (void);
407 FolderItem *folder_get_default_processing (void);
408 void folder_set_missing_folders (void);
409 void folder_unref_account_all (PrefsAccount *account);
411 gchar *folder_item_get_path (FolderItem *item);
413 gint folder_item_open (FolderItem *item);
414 gint folder_item_close (FolderItem *item);
415 gint folder_item_scan (FolderItem *item);
416 void folder_item_scan_foreach (GHashTable *table);
417 MsgInfo *folder_item_get_msginfo (FolderItem *item,
419 MsgInfo *folder_item_get_msginfo_by_msgid(FolderItem *item,
421 GSList *folder_item_get_msg_list (FolderItem *item);
422 gchar *folder_item_fetch_msg (FolderItem *item,
424 gint folder_item_add_msg (FolderItem *dest,
427 gboolean remove_source);
428 gint folder_item_add_msgs (FolderItem *dest,
430 gboolean remove_source);
431 gint folder_item_move_to (FolderItem *src,
433 FolderItem **new_item);
434 gint folder_item_move_msg (FolderItem *dest,
436 gint folder_item_move_msgs (FolderItem *dest,
438 gint folder_item_copy_msg (FolderItem *dest,
440 gint folder_item_copy_msgs (FolderItem *dest,
442 gint folder_item_remove_msg (FolderItem *item,
444 gint folder_item_remove_msgs (FolderItem *item,
446 gint folder_item_remove_all_msg (FolderItem *item);
447 void folder_item_change_msg_flags (FolderItem *item,
449 MsgPermFlags newflags);
450 gboolean folder_item_is_msg_changed (FolderItem *item,
452 gchar *folder_item_get_cache_file (FolderItem *item);
453 gchar *folder_item_get_mark_file (FolderItem *item);
454 gchar * folder_item_get_identifier (FolderItem * item);
456 GHashTable *folder_persist_prefs_new (Folder *folder);
457 void folder_persist_prefs_free (GHashTable *pptable);
458 const PersistPrefs *folder_get_persist_prefs
459 (GHashTable *pptable, const char *name);
461 void folder_item_restore_persist_prefs (FolderItem *item, GHashTable *pptable);
462 void folder_clean_cache_memory (void);
463 void folder_item_write_cache (FolderItem *item);
464 void folder_item_set_default_flags (FolderItem *dest, MsgFlags *flags);
466 void folder_item_apply_processing (FolderItem *item);
468 void folder_item_update (FolderItem *item,
469 FolderItemUpdateFlags update_flags);
470 void folder_item_update_recursive (FolderItem *item,
471 FolderItemUpdateFlags update_flags);
472 void folder_item_update_freeze (void);
473 void folder_item_update_thaw (void);
475 #endif /* __FOLDER_H__ */