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;
33 typedef struct _FolderItemUpdateData FolderItemUpdateData;
35 #include "prefs_folder_item.h"
37 #include "prefs_account.h"
42 #define FOLDER(obj) ((Folder *)obj)
43 #define FOLDER_TYPE(obj) (FOLDER(obj)->type)
45 #define LOCAL_FOLDER(obj) ((LocalFolder *)obj)
46 #define REMOTE_FOLDER(obj) ((RemoteFolder *)obj)
48 #define FOLDER_IS_LOCAL(obj) (FOLDER_TYPE(obj) == F_MH || \
49 FOLDER_TYPE(obj) == F_MBOX || \
50 FOLDER_TYPE(obj) == F_MAILDIR)
53 #define MAILDIR_FOLDER(obj) ((MaildirFolder *)obj)
56 #define FOLDER_ITEM(obj) ((FolderItem *)obj)
58 #define FOLDER_ITEM_UPDATE_HOOKLIST "folder_item_update"
78 } SpecialFolderItemType;
105 F_MOVE_FAILED_DEST_IS_PARENT,
106 F_MOVE_FAILED_DEST_IS_CHILD,
107 F_MOVE_FAILED_DEST_OUTSIDE_MAILBOX,
111 typedef void (*FolderUIFunc) (Folder *folder,
114 typedef void (*FolderDestroyNotify) (Folder *folder,
117 typedef void (*FolderItemFunc) (FolderItem *item,
125 PrefsAccount *account;
133 FolderUIFunc ui_func;
134 gpointer ui_func_data;
142 /* virtual functions */
144 GSList * (*get_msg_list) (Folder *folder,
148 FolderItem *(*item_new) (Folder *folder);
149 void (*item_destroy) (Folder *folder,
151 gchar * (*fetch_msg) (Folder *folder,
154 MsgInfo * (*get_msginfo) (Folder *folder,
157 GSList * (*get_msginfos) (Folder *folder,
159 GSList *msgnum_list);
160 gint (*add_msg) (Folder *folder,
163 gboolean remove_source);
164 gint (*move_msg) (Folder *folder,
167 gint (*move_msgs_with_dest) (Folder *folder,
170 gint (*copy_msg) (Folder *folder,
173 gint (*copy_msgs_with_dest) (Folder *folder,
176 gint (*remove_msg) (Folder *folder,
179 gint (*remove_msgs) (Folder *folder,
182 gint (*remove_all_msg) (Folder *folder,
184 gboolean (*is_msg_changed) (Folder *folder,
187 gint (*scan) (Folder *folder);
188 gint (*get_num_list) (Folder *folder,
191 void (*scan_tree) (Folder *folder);
193 gint (*create_tree) (Folder *folder);
194 FolderItem * (*create_folder) (Folder *folder,
197 gint (*rename_folder) (Folder *folder,
200 gint (*remove_folder) (Folder *folder,
203 void (*destroy) (Folder *folder);
204 void (*update_mark) (Folder *folder,
206 void (*change_flags) (Folder *folder,
209 void (*finished_copy) (Folder * folder, FolderItem * item);
210 void (*finished_remove) (Folder * folder, FolderItem * item);
211 gboolean (*check_msgnum_validity) (Folder * folder, FolderItem * item);
229 struct _MaildirFolder
237 SpecialFolderItemType stype;
254 guint no_sub : 1; /* no child allowed? */
255 guint no_select : 1; /* not selectable? */
256 guint collapsed : 1; /* collapsed item */
257 guint threaded : 1; /* threaded folder view */
258 guint hide_read_msgs : 1; /* hide read messages */
259 guint ret_rcpt : 1; /* return receipt */
262 guint opened : 1; /* opened by summary view */
263 guint need_update : 1; /* folderview for this folder should be updated */
265 FolderSortKey sort_key;
266 FolderSortType sort_type;
272 PrefsAccount *account;
280 PrefsFolderItem * prefs;
284 FolderSortKey sort_key;
285 FolderSortType sort_type;
288 guint hide_read_msgs : 1; /* CLAWS */
289 guint ret_rcpt : 1; /* CLAWS */
292 struct _FolderItemUpdateData
295 gboolean content_change;
298 Folder *folder_new (FolderType type,
301 void folder_local_folder_init (Folder *folder,
304 void folder_remote_folder_init (Folder *folder,
308 void folder_destroy (Folder *folder);
309 void folder_local_folder_destroy (LocalFolder *lfolder);
310 void folder_remote_folder_destroy(RemoteFolder *rfolder);
312 FolderItem *folder_item_new (Folder *folder,
315 void folder_item_append (FolderItem *parent,
317 void folder_item_remove (FolderItem *item);
318 void folder_item_destroy (FolderItem *item);
320 void folder_set_ui_func (Folder *folder,
323 void folder_set_name (Folder *folder,
325 void folder_tree_destroy (Folder *folder);
327 void folder_add (Folder *folder);
329 GList *folder_get_list (void);
330 gint folder_read_list (void);
331 void folder_write_list (void);
332 void folder_scan_tree (Folder *folder);
333 FolderItem *folder_create_folder(FolderItem *parent, const gchar *name);
334 void folder_update_op_count (void);
335 void folder_func_to_all_folders (FolderItemFunc function,
337 void folder_count_total_msgs (guint *new,
342 Folder *folder_find_from_path (const gchar *path);
343 Folder *folder_find_from_name (const gchar *name,
345 FolderItem *folder_find_item_from_path (const gchar *path);
346 gchar *folder_get_identifier (Folder *folder);
347 gchar *folder_item_get_identifier (FolderItem *item);
348 FolderItem *folder_find_item_from_identifier (const gchar *identifier);
350 Folder *folder_get_default_folder (void);
351 FolderItem *folder_get_default_inbox (void);
352 FolderItem *folder_get_default_outbox (void);
353 FolderItem *folder_get_default_draft (void);
354 FolderItem *folder_get_default_queue (void);
355 FolderItem *folder_get_default_trash (void);
356 FolderItem *folder_get_default_processing (void);
357 void folder_set_missing_folders (void);
358 void folder_unref_account_all (PrefsAccount *account);
360 gchar *folder_get_path (Folder *folder);
361 gchar *folder_item_get_path (FolderItem *item);
363 gint folder_item_open (FolderItem *item);
364 void folder_item_close (FolderItem *item);
365 gint folder_item_scan (FolderItem *item);
366 void folder_item_scan_foreach (GHashTable *table);
367 MsgInfo *folder_item_get_msginfo (FolderItem *item,
369 MsgInfo *folder_item_get_msginfo_by_msgid(FolderItem *item,
371 GSList *folder_item_get_msg_list (FolderItem *item);
372 gchar *folder_item_fetch_msg (FolderItem *item,
374 gint folder_item_add_msg (FolderItem *dest,
376 gboolean remove_source);
377 gint folder_item_move_to (FolderItem *src,
379 FolderItem **new_item);
380 gint folder_item_move_msg (FolderItem *dest,
382 gint folder_item_move_msgs_with_dest (FolderItem *dest,
384 gint folder_item_copy_msg (FolderItem *dest,
386 gint folder_item_copy_msgs_with_dest (FolderItem *dest,
388 gint folder_item_remove_msg (FolderItem *item,
390 gint folder_item_remove_msgs (FolderItem *item,
392 gint folder_item_remove_all_msg (FolderItem *item);
393 gboolean folder_item_is_msg_changed (FolderItem *item,
395 gchar *folder_item_get_cache_file (FolderItem *item);
396 gchar *folder_item_get_mark_file (FolderItem *item);
397 gchar * folder_item_get_identifier(FolderItem * item);
399 GHashTable *folder_persist_prefs_new (Folder *folder);
400 void folder_persist_prefs_free (GHashTable *pptable);
401 const PersistPrefs *folder_get_persist_prefs
402 (GHashTable *pptable, const char *name);
404 void folder_item_restore_persist_prefs (FolderItem *item, GHashTable *pptable);
405 void folder_clean_cache_memory ();
406 void folder_item_write_cache (FolderItem *item);
407 void folder_item_set_default_flags (FolderItem *dest, MsgFlags *flags);
409 void folder_item_apply_processing (FolderItem *item);
411 void folder_update_item (FolderItem *item,
412 gboolean contentchange);
413 void folder_update_items_when_required (gboolean contentchange);
414 void folder_update_item_recursive (FolderItem *item,
415 gboolean update_summary);
417 #endif /* __FOLDER_H__ */