2 * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3 * Copyright (C) 1999-2003 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,
113 FOLDER_NEW_FOLDERITEM = 1 << 1,
114 FOLDER_REMOVE_FOLDERITEM = 1 << 2,
119 F_ITEM_UPDATE_MSGCNT = 1 << 0,
120 F_ITEM_UPDATE_CONTENT = 1 << 1,
121 } FolderItemUpdateFlags;
123 typedef void (*FolderUIFunc) (Folder *folder,
126 typedef void (*FolderDestroyNotify) (Folder *folder,
129 typedef void (*FolderItemFunc) (FolderItem *item,
132 #include "folder_item_prefs.h"
134 #include "prefs_account.h"
137 #include "msgcache.h"
144 PrefsAccount *account;
152 FolderUIFunc ui_func;
153 gpointer ui_func_data;
168 /* virtual functions */
170 /* Folder funtions */
171 Folder *(*new_folder) (const gchar *name,
173 void (*destroy_folder) (Folder *folder);
174 void (*scan_tree) (Folder *folder);
176 gint (*create_tree) (Folder *folder);
178 /* FolderItem functions */
179 FolderItem *(*item_new) (Folder *folder);
180 void (*item_destroy) (Folder *folder,
182 gchar *(*item_get_path) (Folder *folder,
184 FolderItem *(*create_folder) (Folder *folder,
187 gint (*rename_folder) (Folder *folder,
190 gint (*remove_folder) (Folder *folder,
192 gint (*close) (Folder *folder,
194 gint (*get_num_list) (Folder *folder,
197 gboolean *old_uids_valid);
198 void (*update_mark) (Folder *folder,
200 void (*finished_copy) (Folder *folder,
202 void (*finished_remove) (Folder *folder,
204 gboolean (*scan_required) (Folder *folder,
207 /* Message functions */
208 MsgInfo *(*get_msginfo) (Folder *folder,
211 GSList *(*get_msginfos) (Folder *folder,
213 MsgNumberList *msgnum_list);
214 gchar *(*fetch_msg) (Folder *folder,
217 gint (*add_msg) (Folder *folder,
221 gint (*add_msgs) (Folder *folder,
224 GRelation *relation);
225 gint (*copy_msg) (Folder *folder,
228 gint (*copy_msgs) (Folder *folder,
230 MsgInfoList *msglist,
231 GRelation *relation);
232 gint (*remove_msg) (Folder *folder,
235 gint (*remove_all_msg) (Folder *folder,
237 gboolean (*is_msg_changed) (Folder *folder,
240 void (*change_flags) (Folder *folder,
243 MsgPermFlags newflags);
261 struct _MaildirFolder
269 SpecialFolderItemType stype;
279 gint unreadmarked_msgs;
286 guint no_sub : 1; /* no child allowed? */
287 guint no_select : 1; /* not selectable? */
288 guint collapsed : 1; /* collapsed item */
289 guint thread_collapsed : 1; /* collapsed item */
290 guint threaded : 1; /* threaded folder view */
291 guint hide_read_msgs : 1; /* hide read messages */
292 guint ret_rcpt : 1; /* return receipt */
295 guint opened : 1; /* opened by summary view */
296 FolderItemUpdateFlags update_flags; /* folderview for this folder should be updated */
298 FolderSortKey sort_key;
299 FolderSortType sort_type;
307 PrefsAccount *account;
315 FolderItemPrefs * prefs;
319 FolderSortKey sort_key;
320 FolderSortType sort_type;
322 guint thread_collapsed : 1;
324 guint hide_read_msgs : 1; /* CLAWS */
325 guint ret_rcpt : 1; /* CLAWS */
328 struct _FolderUpdateData
331 FolderUpdateFlags update_flags;
335 struct _FolderItemUpdateData
338 FolderItemUpdateFlags update_flags;
341 void folder_system_init (void);
342 void folder_register_class (FolderClass *klass);
343 Folder *folder_new (FolderClass *type,
346 void folder_local_folder_init (Folder *folder,
349 void folder_remote_folder_init (Folder *folder,
353 void folder_destroy (Folder *folder);
354 void folder_local_folder_destroy (LocalFolder *lfolder);
355 void folder_remote_folder_destroy(RemoteFolder *rfolder);
357 FolderItem *folder_item_new (Folder *folder,
360 void folder_item_append (FolderItem *parent,
362 void folder_item_remove (FolderItem *item);
363 void folder_item_remove_children (FolderItem *item);
364 void folder_item_destroy (FolderItem *item);
366 void folder_set_ui_func (Folder *folder,
369 void folder_set_name (Folder *folder,
371 void folder_tree_destroy (Folder *folder);
373 void folder_add (Folder *folder);
375 GList *folder_get_list (void);
376 gint folder_read_list (void);
377 void folder_write_list (void);
378 void folder_scan_tree (Folder *folder);
379 FolderItem *folder_create_folder(FolderItem *parent, const gchar *name);
380 void folder_update_op_count (void);
381 void folder_func_to_all_folders (FolderItemFunc function,
383 void folder_count_total_msgs (guint *new_msgs,
385 guint *unreadmarked_msgs,
387 gchar *folder_get_status (GPtrArray *folders,
390 Folder *folder_find_from_path (const gchar *path);
391 Folder *folder_find_from_name (const gchar *name,
393 FolderItem *folder_find_item_from_path (const gchar *path);
394 FolderClass *folder_get_class_from_string (const gchar *str);
395 gchar *folder_get_identifier (Folder *folder);
396 gchar *folder_item_get_identifier (FolderItem *item);
397 FolderItem *folder_find_item_from_identifier (const gchar *identifier);
398 gchar *folder_item_get_name (FolderItem *item);
400 Folder *folder_get_default_folder (void);
401 FolderItem *folder_get_default_inbox (void);
402 FolderItem *folder_get_default_outbox (void);
403 FolderItem *folder_get_default_draft (void);
404 FolderItem *folder_get_default_queue (void);
405 FolderItem *folder_get_default_trash (void);
406 FolderItem *folder_get_default_processing (void);
407 void folder_set_missing_folders (void);
408 void folder_unref_account_all (PrefsAccount *account);
410 gchar *folder_item_get_path (FolderItem *item);
412 gint folder_item_open (FolderItem *item);
413 gint folder_item_close (FolderItem *item);
414 gint folder_item_scan (FolderItem *item);
415 void folder_item_scan_foreach (GHashTable *table);
416 MsgInfo *folder_item_get_msginfo (FolderItem *item,
418 MsgInfo *folder_item_get_msginfo_by_msgid(FolderItem *item,
420 GSList *folder_item_get_msg_list (FolderItem *item);
421 gchar *folder_item_fetch_msg (FolderItem *item,
423 gint folder_item_add_msg (FolderItem *dest,
426 gboolean remove_source);
427 gint folder_item_add_msgs (FolderItem *dest,
429 gboolean remove_source);
430 gint folder_item_move_to (FolderItem *src,
432 FolderItem **new_item);
433 gint folder_item_move_msg (FolderItem *dest,
435 gint folder_item_move_msgs (FolderItem *dest,
437 gint folder_item_copy_msg (FolderItem *dest,
439 gint folder_item_copy_msgs (FolderItem *dest,
441 gint folder_item_remove_msg (FolderItem *item,
443 gint folder_item_remove_msgs (FolderItem *item,
445 gint folder_item_remove_all_msg (FolderItem *item);
446 void folder_item_change_msg_flags (FolderItem *item,
448 MsgPermFlags newflags);
449 gboolean folder_item_is_msg_changed (FolderItem *item,
451 gchar *folder_item_get_cache_file (FolderItem *item);
452 gchar *folder_item_get_mark_file (FolderItem *item);
453 gchar * folder_item_get_identifier (FolderItem * item);
455 GHashTable *folder_persist_prefs_new (Folder *folder);
456 void folder_persist_prefs_free (GHashTable *pptable);
457 const PersistPrefs *folder_get_persist_prefs
458 (GHashTable *pptable, const char *name);
460 void folder_item_restore_persist_prefs (FolderItem *item, GHashTable *pptable);
461 void folder_clean_cache_memory (void);
462 void folder_item_write_cache (FolderItem *item);
463 void folder_item_set_default_flags (FolderItem *dest, MsgFlags *flags);
465 void folder_item_apply_processing (FolderItem *item);
467 void folder_item_update (FolderItem *item,
468 FolderItemUpdateFlags update_flags);
469 void folder_item_update_recursive (FolderItem *item,
470 FolderItemUpdateFlags update_flags);
471 void folder_item_update_freeze (void);
472 void folder_item_update_thaw (void);
474 #endif /* __FOLDER_H__ */