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,
114 F_ITEM_UPDATE_MSGCNT = 1 << 0,
115 F_ITEM_UPDATE_CONTENT = 1 << 1,
116 } FolderItemUpdateFlags;
118 typedef void (*FolderUIFunc) (Folder *folder,
121 typedef void (*FolderDestroyNotify) (Folder *folder,
124 typedef void (*FolderItemFunc) (FolderItem *item,
132 PrefsAccount *account;
140 FolderUIFunc ui_func;
141 gpointer ui_func_data;
149 /* virtual functions */
151 GSList * (*get_msg_list) (Folder *folder,
155 FolderItem *(*item_new) (Folder *folder);
156 void (*item_destroy) (Folder *folder,
158 gchar * (*fetch_msg) (Folder *folder,
161 MsgInfo * (*get_msginfo) (Folder *folder,
164 GSList * (*get_msginfos) (Folder *folder,
166 GSList *msgnum_list);
167 gint (*add_msg) (Folder *folder,
170 gboolean remove_source);
171 gint (*move_msg) (Folder *folder,
174 gint (*move_msgs_with_dest) (Folder *folder,
177 gint (*copy_msg) (Folder *folder,
180 gint (*copy_msgs_with_dest) (Folder *folder,
183 gint (*remove_msg) (Folder *folder,
186 gint (*remove_msgs) (Folder *folder,
189 gint (*remove_all_msg) (Folder *folder,
191 gboolean (*is_msg_changed) (Folder *folder,
194 gint (*scan) (Folder *folder);
195 gint (*get_num_list) (Folder *folder,
198 void (*scan_tree) (Folder *folder);
200 gint (*create_tree) (Folder *folder);
201 FolderItem * (*create_folder) (Folder *folder,
204 gint (*rename_folder) (Folder *folder,
207 gint (*remove_folder) (Folder *folder,
210 void (*destroy) (Folder *folder);
211 void (*update_mark) (Folder *folder,
213 void (*change_flags) (Folder *folder,
216 void (*finished_copy) (Folder * folder, FolderItem * item);
217 void (*finished_remove) (Folder * folder, FolderItem * item);
218 gboolean (*check_msgnum_validity) (Folder * folder, FolderItem * item);
236 struct _MaildirFolder
244 SpecialFolderItemType stype;
261 guint no_sub : 1; /* no child allowed? */
262 guint no_select : 1; /* not selectable? */
263 guint collapsed : 1; /* collapsed item */
264 guint threaded : 1; /* threaded folder view */
265 guint hide_read_msgs : 1; /* hide read messages */
266 guint ret_rcpt : 1; /* return receipt */
269 guint opened : 1; /* opened by summary view */
270 FolderItemUpdateFlags update_flags; /* folderview for this folder should be updated */
272 FolderSortKey sort_key;
273 FolderSortType sort_type;
279 PrefsAccount *account;
287 PrefsFolderItem * prefs;
291 FolderSortKey sort_key;
292 FolderSortType sort_type;
295 guint hide_read_msgs : 1; /* CLAWS */
296 guint ret_rcpt : 1; /* CLAWS */
299 struct _FolderItemUpdateData
302 FolderItemUpdateFlags update_flags;
305 Folder *folder_new (FolderType type,
308 void folder_local_folder_init (Folder *folder,
311 void folder_remote_folder_init (Folder *folder,
315 void folder_destroy (Folder *folder);
316 void folder_local_folder_destroy (LocalFolder *lfolder);
317 void folder_remote_folder_destroy(RemoteFolder *rfolder);
319 FolderItem *folder_item_new (Folder *folder,
322 void folder_item_append (FolderItem *parent,
324 void folder_item_remove (FolderItem *item);
325 void folder_item_destroy (FolderItem *item);
327 void folder_set_ui_func (Folder *folder,
330 void folder_set_name (Folder *folder,
332 void folder_tree_destroy (Folder *folder);
334 void folder_add (Folder *folder);
336 GList *folder_get_list (void);
337 gint folder_read_list (void);
338 void folder_write_list (void);
339 void folder_scan_tree (Folder *folder);
340 FolderItem *folder_create_folder(FolderItem *parent, const gchar *name);
341 void folder_update_op_count (void);
342 void folder_func_to_all_folders (FolderItemFunc function,
344 void folder_count_total_msgs (guint *new,
349 Folder *folder_find_from_path (const gchar *path);
350 Folder *folder_find_from_name (const gchar *name,
352 FolderItem *folder_find_item_from_path (const gchar *path);
353 gchar *folder_get_identifier (Folder *folder);
354 gchar *folder_item_get_identifier (FolderItem *item);
355 FolderItem *folder_find_item_from_identifier (const gchar *identifier);
357 Folder *folder_get_default_folder (void);
358 FolderItem *folder_get_default_inbox (void);
359 FolderItem *folder_get_default_outbox (void);
360 FolderItem *folder_get_default_draft (void);
361 FolderItem *folder_get_default_queue (void);
362 FolderItem *folder_get_default_trash (void);
363 FolderItem *folder_get_default_processing (void);
364 void folder_set_missing_folders (void);
365 void folder_unref_account_all (PrefsAccount *account);
367 gchar *folder_get_path (Folder *folder);
368 gchar *folder_item_get_path (FolderItem *item);
370 gint folder_item_open (FolderItem *item);
371 void folder_item_close (FolderItem *item);
372 gint folder_item_scan (FolderItem *item);
373 void folder_item_scan_foreach (GHashTable *table);
374 MsgInfo *folder_item_get_msginfo (FolderItem *item,
376 MsgInfo *folder_item_get_msginfo_by_msgid(FolderItem *item,
378 GSList *folder_item_get_msg_list (FolderItem *item);
379 gchar *folder_item_fetch_msg (FolderItem *item,
381 gint folder_item_add_msg (FolderItem *dest,
383 gboolean remove_source);
384 gint folder_item_move_to (FolderItem *src,
386 FolderItem **new_item);
387 gint folder_item_move_msg (FolderItem *dest,
389 gint folder_item_move_msgs_with_dest (FolderItem *dest,
391 gint folder_item_copy_msg (FolderItem *dest,
393 gint folder_item_copy_msgs_with_dest (FolderItem *dest,
395 gint folder_item_remove_msg (FolderItem *item,
397 gint folder_item_remove_msgs (FolderItem *item,
399 gint folder_item_remove_all_msg (FolderItem *item);
400 gboolean folder_item_is_msg_changed (FolderItem *item,
402 gchar *folder_item_get_cache_file (FolderItem *item);
403 gchar *folder_item_get_mark_file (FolderItem *item);
404 gchar * folder_item_get_identifier(FolderItem * item);
406 GHashTable *folder_persist_prefs_new (Folder *folder);
407 void folder_persist_prefs_free (GHashTable *pptable);
408 const PersistPrefs *folder_get_persist_prefs
409 (GHashTable *pptable, const char *name);
411 void folder_item_restore_persist_prefs (FolderItem *item, GHashTable *pptable);
412 void folder_clean_cache_memory ();
413 void folder_item_write_cache (FolderItem *item);
414 void folder_item_set_default_flags (FolderItem *dest, MsgFlags *flags);
416 void folder_item_apply_processing (FolderItem *item);
418 void folder_item_update (FolderItem *item,
419 FolderItemUpdateFlags update_flags);
420 void folder_item_update_recursive (FolderItem *item,
421 FolderItemUpdateFlags update_flags);
422 void folder_item_update_freeze ();
423 void folder_item_update_thaw ();
425 #endif /* __FOLDER_H__ */