2 * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3 * Copyright (C) 1999-2001 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;
29 typedef struct _MHFolder MHFolder;
30 typedef struct _MboxFolder MboxFolder;
31 typedef struct _MaildirFolder MaildirFolder;
32 typedef struct _IMAPFolder IMAPFolder;
33 typedef struct _NewsFolder NewsFolder;
34 typedef struct _FolderItem FolderItem;
36 #include "prefs_folder_item.h"
38 #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)
52 #define MH_FOLDER(obj) ((MHFolder *)obj)
53 #define MBOX_FOLDER(obj) ((MboxFolder *)obj)
54 #define MAILDIR_FOLDER(obj) ((MaildirFolder *)obj)
55 #define IMAP_FOLDER(obj) ((IMAPFolder *)obj)
56 #define NEWS_FOLDER(obj) ((NewsFolder *)obj)
58 #define FOLDER_ITEM(obj) ((FolderItem *)obj)
78 } SpecialFolderItemType;
80 typedef void (*FolderUIFunc) (Folder *folder,
83 typedef void (*FolderDestroyNotify) (Folder *folder,
92 PrefsAccount *account;
100 FolderUIFunc ui_func;
101 gpointer ui_func_data;
107 /* virtual functions */
108 GSList * (*get_msg_list) (Folder *folder,
111 gchar * (*fetch_msg) (Folder *folder,
114 gint (*add_msg) (Folder *folder,
117 gboolean remove_source);
118 gint (*move_msg) (Folder *folder,
121 gint (*move_msgs_with_dest) (Folder *folder,
124 gint (*copy_msg) (Folder *folder,
127 gint (*copy_msgs_with_dest) (Folder *folder,
130 gint (*remove_msg) (Folder *folder,
133 gint (*remove_all_msg) (Folder *folder,
135 gboolean (*is_msg_changed) (Folder *folder,
138 void (*scan) (Folder *folder,
140 void (*scan_tree) (Folder *folder);
142 gint (*create_tree) (Folder *folder);
143 FolderItem * (*create_folder) (Folder *folder,
146 gint (*rename_folder) (Folder *folder,
149 gint (*remove_folder) (Folder *folder,
151 void (*update_mark) (Folder *folder,
153 void (*change_flags) (Folder *folder,
156 void (*finished_copy) (Folder * folder, FolderItem * item);
157 void (*finished_remove) (Folder * folder, FolderItem * item);
184 struct _MaildirFolder
191 RemoteFolder rfolder;
193 GList *namespace; /* list of IMAPNameSpace */
198 RemoteFolder rfolder;
205 SpecialFolderItemType stype;
209 PrefsAccount *account;
220 guint no_sub : 1; /* no child allowed? */
221 guint no_select : 1; /* not selectable? */
222 guint collapsed : 1; /* collapsed item */
223 guint threaded : 1; /* threaded folder view */
224 guint hide_read_msgs : 1; /* hide read messages */
225 guint ret_rcpt : 1; /* return receipt */
235 PrefsFolderItem * prefs;
241 guint hide_read_msgs : 1; /* CLAWS */
242 guint ret_rcpt : 1; /* CLAWS */
246 Folder *folder_new (FolderType type,
249 Folder *mh_folder_new (const gchar *name,
251 Folder *mbox_folder_new (const gchar *name,
253 Folder *maildir_folder_new (const gchar *name,
255 Folder *imap_folder_new (const gchar *name,
257 Folder *news_folder_new (const gchar *name,
259 FolderItem *folder_item_new (const gchar *name,
261 void folder_item_append (FolderItem *parent,
263 void folder_item_remove (FolderItem *item);
264 void folder_item_destroy (FolderItem *item);
265 void folder_set_ui_func (Folder *folder,
268 void folder_set_name (Folder *folder,
270 void folder_destroy (Folder *folder);
271 void folder_tree_destroy (Folder *folder);
273 void folder_add (Folder *folder);
275 GList *folder_get_list (void);
276 gint folder_read_list (void);
277 void folder_write_list (void);
278 void folder_update_op_count (void);
279 void folder_count_total_msgs (guint *new,
283 Folder *folder_find_from_path (const gchar *path);
284 FolderItem *folder_find_item_from_path (const gchar *path);
285 Folder *folder_get_default_folder (void);
286 FolderItem *folder_get_default_inbox (void);
287 FolderItem *folder_get_default_outbox (void);
288 FolderItem *folder_get_default_draft (void);
289 FolderItem *folder_get_default_queue (void);
290 FolderItem *folder_get_default_trash (void);
291 FolderItem *folder_get_default_processing (void);
293 gchar *folder_item_get_path (FolderItem *item);
294 void folder_item_scan (FolderItem *item);
295 void folder_item_scan_foreach (GHashTable *table);
296 gchar *folder_item_fetch_msg (FolderItem *item,
298 gint folder_item_add_msg (FolderItem *dest,
300 gboolean remove_source);
301 gint folder_item_move_msg (FolderItem *dest,
303 gint folder_item_move_msgs_with_dest (FolderItem *dest,
305 gint folder_item_copy_msg (FolderItem *dest,
307 gint folder_item_copy_msgs_with_dest (FolderItem *dest,
309 gint folder_item_remove_msg (FolderItem *item,
311 gint folder_item_remove_msgs (FolderItem *item,
313 gint folder_item_remove_all_msg (FolderItem *item);
314 gboolean folder_item_is_msg_changed (FolderItem *item,
316 gchar *folder_item_get_cache_file (FolderItem *item);
317 gchar *folder_item_get_mark_file (FolderItem *item);
318 gchar * folder_item_get_identifier(FolderItem * item);
319 FolderItem * folder_find_item_from_identifier(const gchar *identifier);
321 GHashTable *folder_persist_prefs_new (Folder *folder);
322 void folder_persist_prefs_free (GHashTable *pptable);
323 const PersistPrefs *folder_get_persist_prefs
324 (GHashTable *pptable, const char *name);
326 void folder_item_restore_persist_prefs (FolderItem *item, GHashTable *pptable);
328 #endif /* __FOLDER_H__ */