2 * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3 * Copyright (C) 1999-2002 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;
28 typedef struct _LocalFolder LocalFolder;
29 typedef struct _RemoteFolder RemoteFolder;
31 typedef struct _MaildirFolder MaildirFolder;
33 typedef struct _FolderItem FolderItem;
35 typedef struct _FolderUpdateData FolderUpdateData;
36 typedef struct _FolderItemUpdateData FolderItemUpdateData;
38 #define FOLDER(obj) ((Folder *)obj)
39 #define FOLDER_TYPE(obj) (FOLDER(obj)->klass->type)
41 #define FOLDER_CLASS(obj) (FOLDER(obj)->klass)
42 #define LOCAL_FOLDER(obj) ((LocalFolder *)obj)
43 #define REMOTE_FOLDER(obj) ((RemoteFolder *)obj)
45 #define FOLDER_IS_LOCAL(obj) (FOLDER_TYPE(obj) == F_MH || \
46 FOLDER_TYPE(obj) == F_MBOX || \
47 FOLDER_TYPE(obj) == F_MAILDIR)
50 #define MAILDIR_FOLDER(obj) ((MaildirFolder *)obj)
53 #define FOLDER_ITEM(obj) ((FolderItem *)obj)
55 #define FOLDER_UPDATE_HOOKLIST "folder_update"
56 #define FOLDER_ITEM_UPDATE_HOOKLIST "folder_item_update"
76 } SpecialFolderItemType;
104 F_MOVE_FAILED_DEST_IS_PARENT = -1,
105 F_MOVE_FAILED_DEST_IS_CHILD = -2,
106 F_MOVE_FAILED_DEST_OUTSIDE_MAILBOX = -3,
108 } FolderItemMoveResult;
112 FOLDER_TREE_CHANGED = 1 << 0,
115 FOLDER_NEW_FOLDERITEM
116 FOLDER_REMOVE_FOLDERITEM
122 F_ITEM_UPDATE_MSGCNT = 1 << 0,
123 F_ITEM_UPDATE_CONTENT = 1 << 1,
124 } FolderItemUpdateFlags;
126 typedef void (*FolderUIFunc) (Folder *folder,
129 typedef void (*FolderDestroyNotify) (Folder *folder,
132 typedef void (*FolderItemFunc) (FolderItem *item,
135 #include "prefs_folder_item.h"
137 #include "prefs_account.h"
140 #include "msgcache.h"
147 PrefsAccount *account;
155 FolderUIFunc ui_func;
156 gpointer ui_func_data;
171 /* virtual functions */
173 /* Folder funtions */
174 Folder *(*new_folder) (const gchar *name,
176 void (*destroy_folder) (Folder *folder);
177 void (*scan_tree) (Folder *folder);
179 gint (*create_tree) (Folder *folder);
181 /* FolderItem functions */
182 FolderItem *(*item_new) (Folder *folder);
183 void (*item_destroy) (Folder *folder,
185 FolderItem *(*create_folder) (Folder *folder,
188 gint (*rename_folder) (Folder *folder,
191 gint (*remove_folder) (Folder *folder,
193 gint (*get_num_list) (Folder *folder,
196 void (*update_mark) (Folder *folder,
198 void (*finished_copy) (Folder *folder,
200 void (*finished_remove) (Folder *folder,
202 gboolean (*check_msgnum_validity)(Folder *folder,
205 /* Message functions */
206 MsgInfo *(*get_msginfo) (Folder *folder,
209 GSList *(*get_msginfos) (Folder *folder,
211 MsgNumberList *msgnum_list);
212 gchar *(*fetch_msg) (Folder *folder,
215 gint (*add_msg) (Folder *folder,
218 gboolean remove_source);
219 gint (*copy_msg) (Folder *folder,
222 gint (*remove_msg) (Folder *folder,
225 gint (*remove_all_msg) (Folder *folder,
227 gboolean (*is_msg_changed) (Folder *folder,
230 void (*change_flags) (Folder *folder,
233 MsgPermFlags newflags);
251 struct _MaildirFolder
259 SpecialFolderItemType stype;
269 gint unreadmarked_msgs;
276 guint no_sub : 1; /* no child allowed? */
277 guint no_select : 1; /* not selectable? */
278 guint collapsed : 1; /* collapsed item */
279 guint thread_collapsed : 1; /* collapsed item */
280 guint threaded : 1; /* threaded folder view */
281 guint hide_read_msgs : 1; /* hide read messages */
282 guint ret_rcpt : 1; /* return receipt */
285 guint opened : 1; /* opened by summary view */
286 FolderItemUpdateFlags update_flags; /* folderview for this folder should be updated */
288 FolderSortKey sort_key;
289 FolderSortType sort_type;
295 PrefsAccount *account;
303 PrefsFolderItem * prefs;
307 FolderSortKey sort_key;
308 FolderSortType sort_type;
310 guint thread_collapsed : 1;
312 guint hide_read_msgs : 1; /* CLAWS */
313 guint ret_rcpt : 1; /* CLAWS */
316 struct _FolderUpdateData
319 FolderUpdateFlags update_flags;
325 struct _FolderItemUpdateData
328 FolderItemUpdateFlags update_flags;
331 void folder_system_init (void);
332 void folder_register_class (FolderClass *klass);
333 Folder *folder_new (FolderClass *type,
336 void folder_local_folder_init (Folder *folder,
339 void folder_remote_folder_init (Folder *folder,
343 void folder_destroy (Folder *folder);
344 void folder_local_folder_destroy (LocalFolder *lfolder);
345 void folder_remote_folder_destroy(RemoteFolder *rfolder);
347 FolderItem *folder_item_new (Folder *folder,
350 void folder_item_append (FolderItem *parent,
352 void folder_item_remove (FolderItem *item);
353 void folder_item_destroy (FolderItem *item);
355 void folder_set_ui_func (Folder *folder,
358 void folder_set_name (Folder *folder,
360 void folder_tree_destroy (Folder *folder);
362 void folder_add (Folder *folder);
364 GList *folder_get_list (void);
365 gint folder_read_list (void);
366 void folder_write_list (void);
367 void folder_scan_tree (Folder *folder);
368 FolderItem *folder_create_folder(FolderItem *parent, const gchar *name);
369 void folder_update_op_count (void);
370 void folder_func_to_all_folders (FolderItemFunc function,
372 void folder_count_total_msgs (guint *new_msgs,
374 guint *unreadmarked_msgs,
377 Folder *folder_find_from_path (const gchar *path);
378 Folder *folder_find_from_name (const gchar *name,
380 FolderItem *folder_find_item_from_path (const gchar *path);
381 FolderClass *folder_get_class_from_string (const gchar *str);
382 gchar *folder_get_identifier (Folder *folder);
383 gchar *folder_item_get_identifier (FolderItem *item);
384 FolderItem *folder_find_item_from_identifier (const gchar *identifier);
385 gchar *folder_item_get_name (FolderItem *item);
387 Folder *folder_get_default_folder (void);
388 FolderItem *folder_get_default_inbox (void);
389 FolderItem *folder_get_default_outbox (void);
390 FolderItem *folder_get_default_draft (void);
391 FolderItem *folder_get_default_queue (void);
392 FolderItem *folder_get_default_trash (void);
393 FolderItem *folder_get_default_processing (void);
394 void folder_set_missing_folders (void);
395 void folder_unref_account_all (PrefsAccount *account);
397 gchar *folder_get_path (Folder *folder);
398 gchar *folder_item_get_path (FolderItem *item);
400 gint folder_item_open (FolderItem *item);
401 void folder_item_close (FolderItem *item);
402 gint folder_item_scan (FolderItem *item);
403 void folder_item_scan_foreach (GHashTable *table);
404 MsgInfo *folder_item_get_msginfo (FolderItem *item,
406 MsgInfo *folder_item_get_msginfo_by_msgid(FolderItem *item,
408 GSList *folder_item_get_msg_list (FolderItem *item);
409 gchar *folder_item_fetch_msg (FolderItem *item,
411 gint folder_item_add_msg (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_with_dest (FolderItem *dest,
421 gint folder_item_copy_msg (FolderItem *dest,
423 gint folder_item_copy_msgs_with_dest (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__ */