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 _LocalFolder LocalFolder;
28 typedef struct _RemoteFolder RemoteFolder;
30 typedef struct _MaildirFolder MaildirFolder;
32 typedef struct _FolderItem FolderItem;
34 #include "prefs_folder_item.h"
36 #include "prefs_account.h"
41 #define FOLDER(obj) ((Folder *)obj)
42 #define FOLDER_TYPE(obj) (FOLDER(obj)->type)
44 #define LOCAL_FOLDER(obj) ((LocalFolder *)obj)
45 #define REMOTE_FOLDER(obj) ((RemoteFolder *)obj)
47 #define FOLDER_IS_LOCAL(obj) (FOLDER_TYPE(obj) == F_MH || \
48 FOLDER_TYPE(obj) == F_MBOX || \
49 FOLDER_TYPE(obj) == F_MAILDIR)
52 #define MAILDIR_FOLDER(obj) ((MaildirFolder *)obj)
55 #define FOLDER_ITEM(obj) ((FolderItem *)obj)
75 } SpecialFolderItemType;
99 typedef void (*FolderUIFunc) (Folder *folder,
102 typedef void (*FolderDestroyNotify) (Folder *folder,
105 typedef void (*FolderItemFunc) (FolderItem *item,
107 typedef void (*FolderItemUpdateFunc) (FolderItem *item,
108 gboolean contentchange,
116 PrefsAccount *account;
124 FolderUIFunc ui_func;
125 gpointer ui_func_data;
133 /* virtual functions */
135 GSList * (*get_msg_list) (Folder *folder,
139 FolderItem *(*item_new) (Folder *folder);
140 void (*item_destroy) (Folder *folder,
142 gchar * (*fetch_msg) (Folder *folder,
145 MsgInfo *(*fetch_msginfo) (Folder *folder,
148 GSList *(*fetch_msginfos) (Folder *folder,
150 GSList *msgnum_list);
151 gint (*add_msg) (Folder *folder,
154 gboolean remove_source);
155 gint (*move_msg) (Folder *folder,
158 gint (*move_msgs_with_dest) (Folder *folder,
161 gint (*copy_msg) (Folder *folder,
164 gint (*copy_msgs_with_dest) (Folder *folder,
167 gint (*remove_msg) (Folder *folder,
170 gint (*remove_msgs) (Folder *folder,
173 gint (*remove_all_msg) (Folder *folder,
175 gboolean (*is_msg_changed) (Folder *folder,
178 gint (*scan) (Folder *folder);
179 gint (*get_num_list) (Folder *folder,
182 void (*scan_tree) (Folder *folder);
184 gint (*create_tree) (Folder *folder);
185 FolderItem * (*create_folder) (Folder *folder,
188 gint (*rename_folder) (Folder *folder,
191 gint (*remove_folder) (Folder *folder,
194 void (*destroy) (Folder *folder);
195 void (*update_mark) (Folder *folder,
197 void (*change_flags) (Folder *folder,
200 void (*finished_copy) (Folder * folder, FolderItem * item);
201 void (*finished_remove) (Folder * folder, FolderItem * item);
202 gboolean (*check_msgnum_validity) (Folder * folder, FolderItem * item);
220 struct _MaildirFolder
228 SpecialFolderItemType stype;
244 guint no_sub : 1; /* no child allowed? */
245 guint no_select : 1; /* not selectable? */
246 guint collapsed : 1; /* collapsed item */
247 guint threaded : 1; /* threaded folder view */
248 guint hide_read_msgs : 1; /* hide read messages */
249 guint ret_rcpt : 1; /* return receipt */
252 guint opened : 1; /* opened by summary view */
253 guint need_update : 1; /* folderview for this folder should be updated */
255 FolderSortKey sort_key;
256 FolderSortType sort_type;
262 PrefsAccount *account;
270 PrefsFolderItem * prefs;
274 FolderSortKey sort_key;
275 FolderSortType sort_type;
278 guint hide_read_msgs : 1; /* CLAWS */
279 guint ret_rcpt : 1; /* CLAWS */
282 Folder *folder_new (FolderType type,
285 void folder_local_folder_init (Folder *folder,
288 void folder_remote_folder_init (Folder *folder,
292 void folder_destroy (Folder *folder);
293 void folder_local_folder_destroy (LocalFolder *lfolder);
294 void folder_remote_folder_destroy(RemoteFolder *rfolder);
296 FolderItem *folder_item_new (Folder *folder,
299 void folder_item_append (FolderItem *parent,
301 void folder_item_remove (FolderItem *item);
302 void folder_item_destroy (FolderItem *item);
304 void folder_set_ui_func (Folder *folder,
307 void folder_set_name (Folder *folder,
309 void folder_tree_destroy (Folder *folder);
311 void folder_add (Folder *folder);
313 GList *folder_get_list (void);
314 gint folder_read_list (void);
315 void folder_write_list (void);
316 void folder_scan_tree (Folder *folder);
317 FolderItem *folder_create_folder(FolderItem *parent, const gchar *name);
318 void folder_update_op_count (void);
319 void folder_func_to_all_folders (FolderItemFunc function,
321 void folder_count_total_msgs (guint *new,
325 Folder *folder_find_from_path (const gchar *path);
326 Folder *folder_find_from_name (const gchar *name,
328 FolderItem *folder_find_item_from_path (const gchar *path);
329 gchar *folder_get_identifier (Folder *folder);
330 gchar *folder_item_get_identifier (FolderItem *item);
331 FolderItem *folder_find_item_from_identifier (const gchar *identifier);
333 Folder *folder_get_default_folder (void);
334 FolderItem *folder_get_default_inbox (void);
335 FolderItem *folder_get_default_outbox (void);
336 FolderItem *folder_get_default_draft (void);
337 FolderItem *folder_get_default_queue (void);
338 FolderItem *folder_get_default_trash (void);
339 FolderItem *folder_get_default_processing (void);
340 void folder_set_missing_folders (void);
341 void folder_unref_account_all (PrefsAccount *account);
343 gchar *folder_get_path (Folder *folder);
344 gchar *folder_item_get_path (FolderItem *item);
346 gint folder_item_open (FolderItem *item);
347 void folder_item_close (FolderItem *item);
348 gint folder_item_scan (FolderItem *item);
349 void folder_item_scan_foreach (GHashTable *table);
350 MsgInfo *folder_item_fetch_msginfo (FolderItem *item,
352 MsgInfo *folder_item_fetch_msginfo_by_id(FolderItem *item,
354 GSList *folder_item_get_msg_list (FolderItem *item);
355 gchar *folder_item_fetch_msg (FolderItem *item,
357 gint folder_item_add_msg (FolderItem *dest,
359 gboolean remove_source);
360 FolderItem *folder_item_move_to (FolderItem *src,
363 gint folder_item_move_msg (FolderItem *dest,
365 gint folder_item_move_msgs_with_dest (FolderItem *dest,
367 gint folder_item_copy_msg (FolderItem *dest,
369 gint folder_item_copy_msgs_with_dest (FolderItem *dest,
371 gint folder_item_remove_msg (FolderItem *item,
373 gint folder_item_remove_msgs (FolderItem *item,
375 gint folder_item_remove_all_msg (FolderItem *item);
376 gboolean folder_item_is_msg_changed (FolderItem *item,
378 gchar *folder_item_get_cache_file (FolderItem *item);
379 gchar *folder_item_get_mark_file (FolderItem *item);
380 gchar * folder_item_get_identifier(FolderItem * item);
382 GHashTable *folder_persist_prefs_new (Folder *folder);
383 void folder_persist_prefs_free (GHashTable *pptable);
384 const PersistPrefs *folder_get_persist_prefs
385 (GHashTable *pptable, const char *name);
387 void folder_item_restore_persist_prefs (FolderItem *item, GHashTable *pptable);
388 void folder_clean_cache_memory ();
389 void folder_item_write_cache (FolderItem *item);
390 void folder_item_set_default_flags (FolderItem *dest, MsgFlags *flags);
392 void folder_item_apply_processing (FolderItem *item);
394 void folder_update_item (FolderItem *item,
395 gboolean contentchange);
396 void folder_update_items_when_required (gboolean contentchange);
397 void folder_update_item_recursive (FolderItem *item,
398 gboolean update_summary);
399 gint folder_item_update_callback_register(FolderItemUpdateFunc func,
401 void folder_item_update_callback_unregister(gint id);
403 #endif /* __FOLDER_H__ */