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;
34 #include "prefs_folder_item.h"
36 #include "prefs_account.h"
40 #define FOLDER(obj) ((Folder *)obj)
41 #define FOLDER_TYPE(obj) (FOLDER(obj)->type)
43 #define LOCAL_FOLDER(obj) ((LocalFolder *)obj)
44 #define REMOTE_FOLDER(obj) ((RemoteFolder *)obj)
46 #define FOLDER_IS_LOCAL(obj) (FOLDER_TYPE(obj) == F_MH || \
47 FOLDER_TYPE(obj) == F_MBOX || \
48 FOLDER_TYPE(obj) == F_MAILDIR)
51 #define MAILDIR_FOLDER(obj) ((MaildirFolder *)obj)
54 #define FOLDER_ITEM(obj) ((FolderItem *)obj)
74 } SpecialFolderItemType;
76 typedef void (*FolderUIFunc) (Folder *folder,
79 typedef void (*FolderDestroyNotify) (Folder *folder,
88 PrefsAccount *account;
97 gpointer ui_func_data;
103 /* virtual functions */
104 GSList * (*get_msg_list) (Folder *folder,
107 gchar * (*fetch_msg) (Folder *folder,
110 gint (*add_msg) (Folder *folder,
113 gboolean remove_source);
114 gint (*move_msg) (Folder *folder,
117 gint (*move_msgs_with_dest) (Folder *folder,
120 gint (*copy_msg) (Folder *folder,
123 gint (*copy_msgs_with_dest) (Folder *folder,
126 gint (*remove_msg) (Folder *folder,
129 gint (*remove_all_msg) (Folder *folder,
131 gboolean (*is_msg_changed) (Folder *folder,
134 void (*scan) (Folder *folder,
136 void (*scan_tree) (Folder *folder);
138 gint (*create_tree) (Folder *folder);
139 FolderItem * (*create_folder) (Folder *folder,
142 gint (*rename_folder) (Folder *folder,
145 gint (*remove_folder) (Folder *folder,
147 void (*update_mark) (Folder *folder,
149 void (*change_flags) (Folder *folder,
152 void (*finished_copy) (Folder * folder, FolderItem * item);
153 void (*finished_remove) (Folder * folder, FolderItem * item);
171 struct _MaildirFolder
179 SpecialFolderItemType stype;
183 PrefsAccount *account;
194 guint no_sub : 1; /* no child allowed? */
195 guint no_select : 1; /* not selectable? */
196 guint collapsed : 1; /* collapsed item */
197 guint threaded : 1; /* threaded folder view */
198 guint hide_read_msgs : 1; /* hide read messages */
199 guint ret_rcpt : 1; /* return receipt */
209 PrefsFolderItem * prefs;
215 guint hide_read_msgs : 1; /* CLAWS */
216 guint ret_rcpt : 1; /* CLAWS */
219 Folder *folder_new (FolderType type,
222 void folder_local_folder_init (Folder *folder,
225 void folder_remote_folder_init (Folder *folder,
229 void folder_destroy (Folder *folder);
230 void folder_local_folder_destroy (LocalFolder *lfolder);
231 void folder_remote_folder_destroy(RemoteFolder *rfolder);
233 FolderItem *folder_item_new (const gchar *name,
235 void folder_item_append (FolderItem *parent,
237 void folder_item_remove (FolderItem *item);
238 void folder_item_destroy (FolderItem *item);
240 void folder_set_ui_func (Folder *folder,
243 void folder_set_name (Folder *folder,
245 void folder_tree_destroy (Folder *folder);
247 void folder_add (Folder *folder);
249 GList *folder_get_list (void);
250 gint folder_read_list (void);
251 void folder_write_list (void);
252 void folder_update_op_count (void);
253 void folder_count_total_msgs (guint *new,
257 Folder *folder_find_from_path (const gchar *path);
258 FolderItem *folder_find_item_from_path (const gchar *path);
259 Folder *folder_get_default_folder (void);
260 FolderItem *folder_get_default_inbox (void);
261 FolderItem *folder_get_default_outbox (void);
262 FolderItem *folder_get_default_draft (void);
263 FolderItem *folder_get_default_queue (void);
264 FolderItem *folder_get_default_trash (void);
265 FolderItem *folder_get_default_processing (void);
267 gchar *folder_item_get_path (FolderItem *item);
268 void folder_item_scan (FolderItem *item);
269 void folder_item_scan_foreach (GHashTable *table);
270 gchar *folder_item_fetch_msg (FolderItem *item,
272 gint folder_item_add_msg (FolderItem *dest,
274 gboolean remove_source);
275 gint folder_item_move_msg (FolderItem *dest,
277 gint folder_item_move_msgs_with_dest (FolderItem *dest,
279 gint folder_item_copy_msg (FolderItem *dest,
281 gint folder_item_copy_msgs_with_dest (FolderItem *dest,
283 gint folder_item_remove_msg (FolderItem *item,
285 gint folder_item_remove_msgs (FolderItem *item,
287 gint folder_item_remove_all_msg (FolderItem *item);
288 gboolean folder_item_is_msg_changed (FolderItem *item,
290 gchar *folder_item_get_cache_file (FolderItem *item);
291 gchar *folder_item_get_mark_file (FolderItem *item);
292 gchar * folder_item_get_identifier(FolderItem * item);
293 FolderItem * folder_find_item_from_identifier(const gchar *identifier);
295 GHashTable *folder_persist_prefs_new (Folder *folder);
296 void folder_persist_prefs_free (GHashTable *pptable);
297 const PersistPrefs *folder_get_persist_prefs
298 (GHashTable *pptable, const char *name);
300 void folder_item_restore_persist_prefs (FolderItem *item, GHashTable *pptable);
302 #endif /* __FOLDER_H__ */