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;
106 F_MOVE_FAILED_DEST_IS_PARENT,
107 F_MOVE_FAILED_DEST_IS_CHILD,
108 F_MOVE_FAILED_DEST_OUTSIDE_MAILBOX,
112 typedef void (*FolderUIFunc) (Folder *folder,
115 typedef void (*FolderDestroyNotify) (Folder *folder,
118 typedef void (*FolderItemFunc) (FolderItem *item,
126 PrefsAccount *account;
134 FolderUIFunc ui_func;
135 gpointer ui_func_data;
143 /* virtual functions */
145 GSList * (*get_msg_list) (Folder *folder,
149 FolderItem *(*item_new) (Folder *folder);
150 void (*item_destroy) (Folder *folder,
152 gchar * (*fetch_msg) (Folder *folder,
155 MsgInfo * (*get_msginfo) (Folder *folder,
158 GSList * (*get_msginfos) (Folder *folder,
160 GSList *msgnum_list);
161 gint (*add_msg) (Folder *folder,
164 gboolean remove_source);
165 gint (*move_msg) (Folder *folder,
168 gint (*move_msgs_with_dest) (Folder *folder,
171 gint (*copy_msg) (Folder *folder,
174 gint (*copy_msgs_with_dest) (Folder *folder,
177 gint (*remove_msg) (Folder *folder,
180 gint (*remove_msgs) (Folder *folder,
183 gint (*remove_all_msg) (Folder *folder,
185 gboolean (*is_msg_changed) (Folder *folder,
188 gint (*scan) (Folder *folder);
189 gint (*get_num_list) (Folder *folder,
192 void (*scan_tree) (Folder *folder);
194 gint (*create_tree) (Folder *folder);
195 FolderItem * (*create_folder) (Folder *folder,
198 gint (*rename_folder) (Folder *folder,
201 gint (*remove_folder) (Folder *folder,
204 void (*destroy) (Folder *folder);
205 void (*update_mark) (Folder *folder,
207 void (*change_flags) (Folder *folder,
210 void (*finished_copy) (Folder * folder, FolderItem * item);
211 void (*finished_remove) (Folder * folder, FolderItem * item);
212 gboolean (*check_msgnum_validity) (Folder * folder, FolderItem * item);
230 struct _MaildirFolder
238 SpecialFolderItemType stype;
255 guint no_sub : 1; /* no child allowed? */
256 guint no_select : 1; /* not selectable? */
257 guint collapsed : 1; /* collapsed item */
258 guint threaded : 1; /* threaded folder view */
259 guint hide_read_msgs : 1; /* hide read messages */
260 guint ret_rcpt : 1; /* return receipt */
263 guint opened : 1; /* opened by summary view */
264 guint need_update : 1; /* folderview for this folder should be updated */
266 FolderSortKey sort_key;
267 FolderSortType sort_type;
273 PrefsAccount *account;
281 PrefsFolderItem * prefs;
285 FolderSortKey sort_key;
286 FolderSortType sort_type;
289 guint hide_read_msgs : 1; /* CLAWS */
290 guint ret_rcpt : 1; /* CLAWS */
293 struct _FolderItemUpdateData
296 gboolean content_change;
299 Folder *folder_new (FolderType type,
302 void folder_local_folder_init (Folder *folder,
305 void folder_remote_folder_init (Folder *folder,
309 void folder_destroy (Folder *folder);
310 void folder_local_folder_destroy (LocalFolder *lfolder);
311 void folder_remote_folder_destroy(RemoteFolder *rfolder);
313 FolderItem *folder_item_new (Folder *folder,
316 void folder_item_append (FolderItem *parent,
318 void folder_item_remove (FolderItem *item);
319 void folder_item_destroy (FolderItem *item);
321 void folder_set_ui_func (Folder *folder,
324 void folder_set_name (Folder *folder,
326 void folder_tree_destroy (Folder *folder);
328 void folder_add (Folder *folder);
330 GList *folder_get_list (void);
331 gint folder_read_list (void);
332 void folder_write_list (void);
333 void folder_scan_tree (Folder *folder);
334 FolderItem *folder_create_folder(FolderItem *parent, const gchar *name);
335 void folder_update_op_count (void);
336 void folder_func_to_all_folders (FolderItemFunc function,
338 void folder_count_total_msgs (guint *new,
343 Folder *folder_find_from_path (const gchar *path);
344 Folder *folder_find_from_name (const gchar *name,
346 FolderItem *folder_find_item_from_path (const gchar *path);
347 gchar *folder_get_identifier (Folder *folder);
348 gchar *folder_item_get_identifier (FolderItem *item);
349 FolderItem *folder_find_item_from_identifier (const gchar *identifier);
351 Folder *folder_get_default_folder (void);
352 FolderItem *folder_get_default_inbox (void);
353 FolderItem *folder_get_default_outbox (void);
354 FolderItem *folder_get_default_draft (void);
355 FolderItem *folder_get_default_queue (void);
356 FolderItem *folder_get_default_trash (void);
357 FolderItem *folder_get_default_processing (void);
358 void folder_set_missing_folders (void);
359 void folder_unref_account_all (PrefsAccount *account);
361 gchar *folder_get_path (Folder *folder);
362 gchar *folder_item_get_path (FolderItem *item);
364 gint folder_item_open (FolderItem *item);
365 void folder_item_close (FolderItem *item);
366 gint folder_item_scan (FolderItem *item);
367 void folder_item_scan_foreach (GHashTable *table);
368 MsgInfo *folder_item_get_msginfo (FolderItem *item,
370 MsgInfo *folder_item_get_msginfo_by_msgid(FolderItem *item,
372 GSList *folder_item_get_msg_list (FolderItem *item);
373 gchar *folder_item_fetch_msg (FolderItem *item,
375 gint folder_item_add_msg (FolderItem *dest,
377 gboolean remove_source);
378 gint folder_item_move_to (FolderItem *src,
380 FolderItem **new_item);
381 gint folder_item_move_msg (FolderItem *dest,
383 gint folder_item_move_msgs_with_dest (FolderItem *dest,
385 gint folder_item_copy_msg (FolderItem *dest,
387 gint folder_item_copy_msgs_with_dest (FolderItem *dest,
389 gint folder_item_remove_msg (FolderItem *item,
391 gint folder_item_remove_msgs (FolderItem *item,
393 gint folder_item_remove_all_msg (FolderItem *item);
394 gboolean folder_item_is_msg_changed (FolderItem *item,
396 gchar *folder_item_get_cache_file (FolderItem *item);
397 gchar *folder_item_get_mark_file (FolderItem *item);
398 gchar * folder_item_get_identifier(FolderItem * item);
400 GHashTable *folder_persist_prefs_new (Folder *folder);
401 void folder_persist_prefs_free (GHashTable *pptable);
402 const PersistPrefs *folder_get_persist_prefs
403 (GHashTable *pptable, const char *name);
405 void folder_item_restore_persist_prefs (FolderItem *item, GHashTable *pptable);
406 void folder_clean_cache_memory ();
407 void folder_item_write_cache (FolderItem *item);
408 void folder_item_set_default_flags (FolderItem *dest, MsgFlags *flags);
410 void folder_item_apply_processing (FolderItem *item);
412 void folder_update_item (FolderItem *item,
413 gboolean contentchange);
414 void folder_update_items_when_required (gboolean contentchange);
415 void folder_update_item_recursive (FolderItem *item,
416 gboolean update_summary);
418 #endif /* __FOLDER_H__ */