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_account.h"
39 #include "prefs_folder_item.h"
41 #define FOLDER(obj) ((Folder *)obj)
42 #define FOLDER_TYPE(obj) (FOLDER(obj)->type)
44 #define LOCAL_FOLDER(obj) ((LocalFolder *)obj)
45 #define REMOTE_FOLDER(obj) ((RemoteFolder *)obj)
47 #define FOLDER_IS_LOCAL(obj) (FOLDER_TYPE(obj) == F_MH || \
48 FOLDER_TYPE(obj) == F_MBOX || \
49 FOLDER_TYPE(obj) == F_MAILDIR)
51 #define MH_FOLDER(obj) ((MHFolder *)obj)
52 #define MBOX_FOLDER(obj) ((MboxFolder *)obj)
53 #define MAILDIR_FOLDER(obj) ((MaildirFolder *)obj)
54 #define IMAP_FOLDER(obj) ((IMAPFolder *)obj)
55 #define NEWS_FOLDER(obj) ((NewsFolder *)obj)
57 #define FOLDER_ITEM(obj) ((FolderItem *)obj)
77 } SpecialFolderItemType;
79 typedef void (*FolderUIFunc) (Folder *folder,
82 typedef void (*FolderDestroyNotify) (Folder *folder,
91 PrefsAccount *account;
100 gpointer ui_func_data;
106 /* virtual functions */
107 GSList * (*get_msg_list) (Folder *folder,
110 gchar * (*fetch_msg) (Folder *folder,
113 gint (*add_msg) (Folder *folder,
116 gboolean remove_source);
117 gint (*move_msg) (Folder *folder,
120 gint (*move_msgs_with_dest) (Folder *folder,
123 gint (*copy_msg) (Folder *folder,
126 gint (*copy_msgs_with_dest) (Folder *folder,
129 gint (*remove_msg) (Folder *folder,
132 gint (*remove_all_msg) (Folder *folder,
134 gboolean (*is_msg_changed) (Folder *folder,
137 void (*scan) (Folder *folder,
139 void (*scan_tree) (Folder *folder);
141 gint (*create_tree) (Folder *folder);
142 FolderItem * (*create_folder) (Folder *folder,
145 gint (*rename_folder) (Folder *folder,
148 gint (*remove_folder) (Folder *folder,
150 void (*update_mark) (Folder *folder,
152 void (*change_flags) (Folder *folder,
155 void (*finished_copy) (Folder * folder, FolderItem * item);
156 void (*finished_remove) (Folder * folder, FolderItem * item);
183 struct _MaildirFolder
190 RemoteFolder rfolder;
192 GList *namespace; /* list of IMAPNameSpace */
197 RemoteFolder rfolder;
204 SpecialFolderItemType stype;
208 PrefsAccount *account;
219 guint no_sub : 1; /* no child allowed? */
220 guint no_select : 1; /* not selectable? */
221 guint collapsed : 1; /* collapsed item */
222 guint threaded : 1; /* threaded folder view */
223 guint hide_read_msgs : 1; /* hide read messages */
224 guint ret_rcpt : 1; /* return receipt */
234 PrefsFolderItem * prefs;
237 Folder *folder_new (FolderType type,
240 Folder *mh_folder_new (const gchar *name,
242 Folder *mbox_folder_new (const gchar *name,
244 Folder *maildir_folder_new (const gchar *name,
246 Folder *imap_folder_new (const gchar *name,
248 Folder *news_folder_new (const gchar *name,
250 FolderItem *folder_item_new (const gchar *name,
252 void folder_item_append (FolderItem *parent,
254 void folder_item_remove (FolderItem *item);
255 void folder_item_destroy (FolderItem *item);
256 void folder_set_ui_func (Folder *folder,
259 void folder_set_name (Folder *folder,
261 void folder_destroy (Folder *folder);
262 void folder_tree_destroy (Folder *folder);
264 void folder_add (Folder *folder);
266 GList *folder_get_list (void);
267 gint folder_read_list (void);
268 void folder_write_list (void);
269 void folder_update_op_count (void);
270 void folder_count_total_msgs (guint *new,
274 Folder *folder_find_from_path (const gchar *path);
275 FolderItem *folder_find_item_from_path (const gchar *path);
276 Folder *folder_get_default_folder (void);
277 FolderItem *folder_get_default_inbox (void);
278 FolderItem *folder_get_default_outbox (void);
279 FolderItem *folder_get_default_draft (void);
280 FolderItem *folder_get_default_queue (void);
281 FolderItem *folder_get_default_trash (void);
282 FolderItem *folder_get_default_processing (void);
284 gchar *folder_item_get_path (FolderItem *item);
285 void folder_item_scan (FolderItem *item);
286 void folder_item_scan_foreach (GHashTable *table);
287 gchar *folder_item_fetch_msg (FolderItem *item,
289 gint folder_item_add_msg (FolderItem *dest,
291 gboolean remove_source);
292 gint folder_item_move_msg (FolderItem *dest,
294 gint folder_item_move_msgs_with_dest (FolderItem *dest,
296 gint folder_item_copy_msg (FolderItem *dest,
298 gint folder_item_copy_msgs_with_dest (FolderItem *dest,
300 gint folder_item_remove_msg (FolderItem *item,
302 gint folder_item_remove_msgs (FolderItem *item,
304 gint folder_item_remove_all_msg (FolderItem *item);
305 gboolean folder_item_is_msg_changed (FolderItem *item,
307 gchar *folder_item_get_cache_file (FolderItem *item);
308 gchar *folder_item_get_mark_file (FolderItem *item);
309 gchar * folder_item_get_identifier(FolderItem * item);
310 FolderItem * folder_find_item_from_identifier(const gchar *identifier);
312 #endif /* __FOLDER_H__ */