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 _FolderClass FolderClass;
28 typedef struct _LocalFolder LocalFolder;
29 typedef struct _RemoteFolder RemoteFolder;
31 typedef struct _MaildirFolder MaildirFolder;
33 typedef struct _FolderItem FolderItem;
34 typedef struct _FolderItemUpdateData FolderItemUpdateData;
36 #include "prefs_folder_item.h"
38 #include "prefs_account.h"
43 #define FOLDER(obj) ((Folder *)obj)
44 #define FOLDER_TYPE(obj) (FOLDER(obj)->class->type)
46 #define FOLDER_CLASS(obj) (FOLDER(obj)->class)
47 #define LOCAL_FOLDER(obj) ((LocalFolder *)obj)
48 #define REMOTE_FOLDER(obj) ((RemoteFolder *)obj)
50 #define FOLDER_IS_LOCAL(obj) (FOLDER_TYPE(obj) == F_MH || \
51 FOLDER_TYPE(obj) == F_MBOX || \
52 FOLDER_TYPE(obj) == F_MAILDIR)
55 #define MAILDIR_FOLDER(obj) ((MaildirFolder *)obj)
58 #define FOLDER_ITEM(obj) ((FolderItem *)obj)
60 #define FOLDER_ITEM_UPDATE_HOOKLIST "folder_item_update"
80 } SpecialFolderItemType;
108 F_MOVE_FAILED_DEST_IS_PARENT,
109 F_MOVE_FAILED_DEST_IS_CHILD,
110 F_MOVE_FAILED_DEST_OUTSIDE_MAILBOX,
116 F_ITEM_UPDATE_MSGCNT = 1 << 0,
117 F_ITEM_UPDATE_CONTENT = 1 << 1,
118 } FolderItemUpdateFlags;
120 typedef void (*FolderUIFunc) (Folder *folder,
123 typedef void (*FolderDestroyNotify) (Folder *folder,
126 typedef void (*FolderItemFunc) (FolderItem *item,
134 PrefsAccount *account;
142 FolderUIFunc ui_func;
143 gpointer ui_func_data;
157 /* virtual functions */
159 /* Folder funtions */
160 Folder *(*new) (const gchar *name,
162 void (*destroy) (Folder *folder);
163 void (*scan_tree) (Folder *folder);
165 gint (*create_tree) (Folder *folder);
167 /* FolderItem functions */
168 FolderItem *(*item_new) (Folder *folder);
169 void (*item_destroy) (Folder *folder,
171 FolderItem *(*create_folder) (Folder *folder,
174 gint (*rename_folder) (Folder *folder,
177 gint (*remove_folder) (Folder *folder,
179 gint (*get_num_list) (Folder *folder,
182 void (*update_mark) (Folder *folder,
184 void (*finished_copy) (Folder *folder,
186 void (*finished_remove) (Folder *folder,
188 gboolean (*check_msgnum_validity)(Folder *folder,
191 /* Message functions */
192 MsgInfo *(*get_msginfo) (Folder *folder,
195 GSList *(*get_msginfos) (Folder *folder,
197 GSList *msgnum_list);
198 gchar *(*fetch_msg) (Folder *folder,
201 gint (*add_msg) (Folder *folder,
204 gboolean remove_source);
205 gint (*move_msg) (Folder *folder,
208 gint (*move_msgs_with_dest) (Folder *folder,
211 gint (*copy_msg) (Folder *folder,
214 gint (*copy_msgs_with_dest) (Folder *folder,
217 gint (*remove_msg) (Folder *folder,
220 gint (*remove_msgs) (Folder *folder,
223 gint (*remove_all_msg) (Folder *folder,
225 gboolean (*is_msg_changed) (Folder *folder,
228 void (*change_flags) (Folder *folder,
248 struct _MaildirFolder
256 SpecialFolderItemType stype;
273 guint no_sub : 1; /* no child allowed? */
274 guint no_select : 1; /* not selectable? */
275 guint collapsed : 1; /* collapsed item */
276 guint thread_collapsed : 1; /* collapsed item */
277 guint threaded : 1; /* threaded folder view */
278 guint hide_read_msgs : 1; /* hide read messages */
279 guint ret_rcpt : 1; /* return receipt */
282 guint opened : 1; /* opened by summary view */
283 FolderItemUpdateFlags update_flags; /* folderview for this folder should be updated */
285 FolderSortKey sort_key;
286 FolderSortType sort_type;
292 PrefsAccount *account;
300 PrefsFolderItem * prefs;
304 FolderSortKey sort_key;
305 FolderSortType sort_type;
307 guint thread_collapsed : 1;
309 guint hide_read_msgs : 1; /* CLAWS */
310 guint ret_rcpt : 1; /* CLAWS */
313 struct _FolderItemUpdateData
316 FolderItemUpdateFlags update_flags;
319 void folder_system_init ();
320 void folder_register_class (FolderClass *class);
321 Folder *folder_new (FolderClass *type,
324 void folder_local_folder_init (Folder *folder,
327 void folder_remote_folder_init (Folder *folder,
331 void folder_destroy (Folder *folder);
332 void folder_local_folder_destroy (LocalFolder *lfolder);
333 void folder_remote_folder_destroy(RemoteFolder *rfolder);
335 FolderItem *folder_item_new (Folder *folder,
338 void folder_item_append (FolderItem *parent,
340 void folder_item_remove (FolderItem *item);
341 void folder_item_destroy (FolderItem *item);
343 void folder_set_ui_func (Folder *folder,
346 void folder_set_name (Folder *folder,
348 void folder_tree_destroy (Folder *folder);
350 void folder_add (Folder *folder);
352 GList *folder_get_list (void);
353 gint folder_read_list (void);
354 void folder_write_list (void);
355 void folder_scan_tree (Folder *folder);
356 FolderItem *folder_create_folder(FolderItem *parent, const gchar *name);
357 void folder_update_op_count (void);
358 void folder_func_to_all_folders (FolderItemFunc function,
360 void folder_count_total_msgs (guint *new,
365 Folder *folder_find_from_path (const gchar *path);
366 Folder *folder_find_from_name (const gchar *name,
368 FolderItem *folder_find_item_from_path (const gchar *path);
369 FolderClass *folder_get_class_from_string (const gchar *str);
370 gchar *folder_get_identifier (Folder *folder);
371 gchar *folder_item_get_identifier (FolderItem *item);
372 FolderItem *folder_find_item_from_identifier (const gchar *identifier);
374 Folder *folder_get_default_folder (void);
375 FolderItem *folder_get_default_inbox (void);
376 FolderItem *folder_get_default_outbox (void);
377 FolderItem *folder_get_default_draft (void);
378 FolderItem *folder_get_default_queue (void);
379 FolderItem *folder_get_default_trash (void);
380 FolderItem *folder_get_default_processing (void);
381 void folder_set_missing_folders (void);
382 void folder_unref_account_all (PrefsAccount *account);
384 gchar *folder_get_path (Folder *folder);
385 gchar *folder_item_get_path (FolderItem *item);
387 gint folder_item_open (FolderItem *item);
388 void folder_item_close (FolderItem *item);
389 gint folder_item_scan (FolderItem *item);
390 void folder_item_scan_foreach (GHashTable *table);
391 MsgInfo *folder_item_get_msginfo (FolderItem *item,
393 MsgInfo *folder_item_get_msginfo_by_msgid(FolderItem *item,
395 GSList *folder_item_get_msg_list (FolderItem *item);
396 gchar *folder_item_fetch_msg (FolderItem *item,
398 gint folder_item_add_msg (FolderItem *dest,
400 gboolean remove_source);
401 gint folder_item_move_to (FolderItem *src,
403 FolderItem **new_item);
404 gint folder_item_move_msg (FolderItem *dest,
406 gint folder_item_move_msgs_with_dest (FolderItem *dest,
408 gint folder_item_copy_msg (FolderItem *dest,
410 gint folder_item_copy_msgs_with_dest (FolderItem *dest,
412 gint folder_item_remove_msg (FolderItem *item,
414 gint folder_item_remove_msgs (FolderItem *item,
416 gint folder_item_remove_all_msg (FolderItem *item);
417 gboolean folder_item_is_msg_changed (FolderItem *item,
419 gchar *folder_item_get_cache_file (FolderItem *item);
420 gchar *folder_item_get_mark_file (FolderItem *item);
421 gchar * folder_item_get_identifier(FolderItem * item);
423 GHashTable *folder_persist_prefs_new (Folder *folder);
424 void folder_persist_prefs_free (GHashTable *pptable);
425 const PersistPrefs *folder_get_persist_prefs
426 (GHashTable *pptable, const char *name);
428 void folder_item_restore_persist_prefs (FolderItem *item, GHashTable *pptable);
429 void folder_clean_cache_memory ();
430 void folder_item_write_cache (FolderItem *item);
431 void folder_item_set_default_flags (FolderItem *dest, MsgFlags *flags);
433 void folder_item_apply_processing (FolderItem *item);
435 void folder_item_update (FolderItem *item,
436 FolderItemUpdateFlags update_flags);
437 void folder_item_update_recursive (FolderItem *item,
438 FolderItemUpdateFlags update_flags);
439 void folder_item_update_freeze ();
440 void folder_item_update_thaw ();
442 #endif /* __FOLDER_H__ */