1 /* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 8; tab-width: 8 -*- */
4 * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
5 * Copyright (C) 1999-2003 Hiroyuki Yamamoto
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
28 typedef struct _Folder Folder;
29 typedef struct _FolderClass FolderClass;
31 typedef struct _FolderItem FolderItem;
32 typedef struct _FolderUpdateData FolderUpdateData;
33 typedef struct _FolderItemUpdateData FolderItemUpdateData;
34 typedef struct _PersistPrefs PersistPrefs;
36 #define FOLDER(obj) ((Folder *)obj)
37 #define FOLDER_CLASS(obj) (FOLDER(obj)->klass)
38 #define FOLDER_TYPE(obj) (FOLDER(obj)->klass->type)
40 #define FOLDER_IS_LOCAL(obj) (FOLDER_TYPE(obj) == F_MH || \
41 FOLDER_TYPE(obj) == F_MBOX || \
42 FOLDER_TYPE(obj) == F_MAILDIR)
44 #define FOLDER_ITEM(obj) ((FolderItem *)obj)
46 #define FOLDER_UPDATE_HOOKLIST "folder_update"
47 #define FOLDER_ITEM_UPDATE_HOOKLIST "folder_item_update"
67 } SpecialFolderItemType;
95 F_MOVE_FAILED_DEST_IS_PARENT = -1,
96 F_MOVE_FAILED_DEST_IS_CHILD = -2,
97 F_MOVE_FAILED_DEST_OUTSIDE_MAILBOX = -3,
99 } FolderItemMoveResult;
103 FOLDER_ADD_FOLDER = 1 << 0,
104 FOLDER_REMOVE_FOLDER = 1 << 1,
105 FOLDER_TREE_CHANGED = 1 << 2,
106 FOLDER_ADD_FOLDERITEM = 1 << 3,
107 FOLDER_REMOVE_FOLDERITEM = 1 << 4,
112 F_ITEM_UPDATE_MSGCNT = 1 << 0,
113 F_ITEM_UPDATE_CONTENT = 1 << 1,
114 F_ITEM_UPDATE_ADDMSG = 1 << 2,
115 F_ITEM_UPDATE_REMOVEMSG = 1 << 3,
116 F_ITEM_UPDATE_NAME = 1 << 4,
117 F_ITEM_UPDATE_ICON = 1 << 5
118 } FolderItemUpdateFlags;
120 typedef void (*FolderUIFunc) (Folder *folder,
123 typedef void (*FolderDestroyNotify) (Folder *folder,
126 typedef void (*FolderItemFunc) (FolderItem *item,
130 #include "folder_item_prefs.h"
133 #include "msgcache.h"
135 #include "prefs_account.h"
142 PrefsAccount *account;
151 FolderUIFunc ui_func;
152 gpointer ui_func_data;
164 * A numeric identifier for the FolderClass. Will be removed in the future
168 * A string identifier for the FolderClass. Currently used in folderlist.xml.
169 * Should be lowercase.
173 * A string for the User Interface that identifies the FolderClass to the
174 * user. Can be upper and lowercase unlike the idstr.
178 /* virtual functions */
180 /* Folder funtions */
182 * Create a new \c Folder of this \c FolderClass.
184 * \param name The name of the new Folder
185 * \param path The path of the new Folder
186 * \return The new \c Folder, or \c NULL when creating the \c Folder
189 Folder *(*new_folder) (const gchar *name,
192 * Destroy a \c Folder of this \c FolderClass, frees all resources
193 * allocated by the Folder
195 * \param folder The \c Folder that should be destroyed.
197 void (*destroy_folder) (Folder *folder);
199 * Set the Folder's internal attributes from an \c XMLTag. Also sets the
200 * parameters of the root-FolderItem of the \c Folder. If \c NULL
201 * the default function of the basic \ยข FolderClass is used, so it
202 * must not be \c NULL if one of the parent \c FolderClasses has a \c set_xml
203 * function. In that case the parent \c FolderClass' \c set_xml function
204 * can be used or it has to be called with the \c folder and \c tag by
205 * the implementation.
207 * \param folder The \c Folder which's attributes should be updated
208 * \param tag The \c XMLTag containing the \c XMLAttrs for the attributes
210 void (*set_xml) (Folder *folder,
213 * Get an \c XMLTag for the attributes of the \c Folder and the root-FolderItem
214 * of the \c Folder. If \c NULL the default implementation for the basic
215 * FolderClass will be used, so it must not be \c NULL if one of the
216 * parent \c FolderClasses has it's own implementation for \c get_xml.
217 * In that case the parent FolderClass' \c get_xml function can be
218 * used or the \c XMLTag has to be fetched from the parent's \c get_xml
219 * function and then the \c FolderClass specific attributes can be
222 * \param Folder The \c Folder which's attributes should be set in the
223 * \c XMLTag's \c XMLAttrs
224 * \return XMLTag An \c XMLTag with \c XMLAttrs containing the \c Folder's
227 XMLTag *(*get_xml) (Folder *folder);
229 * Rebuild the folder tree from the folder's data
230 * \todo New implementations of MH and IMAP are actually syncronizing
231 * the tree with the folder by reusing the old \c FolderItems.
232 * Claws still destroys the old tree before calling this function.
234 * \param folder The folder which's tree should be rebuild
235 * \return 0 on success, a negative number otherwise
237 gint (*scan_tree) (Folder *folder);
239 gint (*create_tree) (Folder *folder);
241 /* FolderItem functions */
243 * Create a new \c FolderItem structure for the \c FolderClass.
244 * \c FolderClasses can have their own \c FolderItem structure with
247 * \param folder The \c Folder for that a \c FolderItem should be
249 * \return The new \c FolderItem or NULL in case of an error
251 FolderItem *(*item_new) (Folder *folder);
253 * Destroy a \c FolderItem from this \c FolderClass. The \c FolderClass
254 * has to free all private resources used by the \c FolderItem.
256 * \param folder The \c Folder of the \c FolderItem
257 * \param item The \c FolderItem that should be destroyed
259 void (*item_destroy) (Folder *folder,
262 * Set the \c FolderItem's internal attributes from an \c XMLTag. If
263 * \c NULL the default function of the basic \c FolderClass is used, so it
264 * must not be \c NULL if one of the parent \c FolderClasses has a \c item_set_xml
265 * function. In that case the parent \c FolderClass' \c item_set_xml function
266 * can be used or it has to be called with the \c folder, \c item and \c tag by
267 * the implementation.
269 * \param folder The \c Folder of the \c FolderItem
270 * \param item The \c FolderItems which's attributes should be set
271 * \param tag The \c XMLTag with \c XMLAttrs for the \c FolderItem's
274 void (*item_set_xml) (Folder *folder,
278 * Get an \c XMLTag for the attributes of the \c FolderItem If \c NULL
279 * the default implementation for the basic \c FolderClass will be used,
280 * so it must not be \c NULL if one of the parent \c FolderClasses has
281 * it's own implementation for \c item_get_xml. In that case the parent
282 * FolderClass' \c item_get_xml function can be used or the \c XMLTag
283 * has to be fetched from the parent's \c item_get_xml function and
284 * then the \c FolderClass specific attributes can be added to it.
286 * \param folder The \c Folder of the \c FolderItem
287 * \parem item The \c FolderItem which's attributes should be set in
288 * the \c XMLTag's \c XMLAttrs
289 * \return An \c XMLTag with \c XMLAttrs containing the \c FolderItem's
292 XMLTag *(*item_get_xml) (Folder *folder,
295 * Get a local path for the \c FolderItem where Sylpheed can save
296 * it's cache data. For local directory based folders this can be the
297 * real path. For other folders it can be the local cache directory.
299 * \param folder The \c Folder of the \c FolderItem
300 * \param item The \c FolderItem for that a path should be returned
301 * \return A path for the \c FolderItem
303 gchar *(*item_get_path) (Folder *folder,
306 * Create a new \c FolderItem. The function must use folder_item_append
307 * to add the new \c FolderItem to the folder tree
309 * \param folder The \c Folder in which a new \c FolderItem should be
311 * \param parent \c The parent \c FolderItem for the new \c FolderItem
312 * \parem name The name for the new \c FolderItem
313 * \return The new \c FolderItem
315 FolderItem *(*create_folder) (Folder *folder,
319 * Rename a \c FolderItem
321 * \param folder The \c Folder of the \c FolderItem that should be
323 * \param item The \c FolderItem that should be renamed
324 * \param name The new name of the \c FolderItem
325 * \return 0 on success, a negative number otherwise
327 gint (*rename_folder) (Folder *folder,
331 * Remove a \c FolderItem from the \c Folder
333 * \param folder The \c Folder that contains the \c FolderItem
334 * \param item The \c FolderItem that should be removed
335 * \return 0 on sucess, a negative number otherwise
337 gint (*remove_folder) (Folder *folder,
340 * Close a \c FolderItem. Called when the user deselects a
343 * \attention In Sylpheed-Main operations can only be done on the
344 * \c FolderItem that is opened in the SummaryView. This
345 * \c FolderItem will be closed when you select a new
346 * \c FolderItem in the FolderView. In Claws operations can
347 * be done any time on any folder and you should not expect
348 * that all \c FolderItems get closed after operations
350 * \param folder The \c Folder that contains the \c FolderItem
351 * \param item The \c FolderItem that should be closed
352 * \return 0 on success, a negative number otherwise
354 gint (*close) (Folder *folder,
357 * Get the list of message numbers for the messages in the \c FolderItem
359 * \param folder The \c Folder that contains the \c FolderItem
360 * \param item The \c FolderItem for which the message numbers should
362 * \param list Pointer to a GSList where message numbers have to be
363 * added. Because of the implementation of the GSList that
364 * changes the pointer of the GSList itself when the first
365 * item is added this is a pointer to a pointer to a
366 * GSList structure. Use *item = g_slist_...(*item, ...)
367 * operations to modify the list.
368 * \param old_uids_valid In some \c Folders the old UIDs can be invalid.
369 * Set this pointer to a gboolean to TRUE if the
370 * old UIDs are still valid, otherwise set it to
371 * FALSE and the folder system will discard it's
372 * cache data of the previously know UIDs
373 * \return The number of message numbers add to the list on success,
374 * a negative number otherwise.
376 gint (*get_num_list) (Folder *folder,
379 gboolean *old_uids_valid);
381 * Tell the folder system if a \c FolderItem should be scanned
382 * (cache data syncronized with the folder content) when it is required
383 * because the \c FolderItem's content changed. If NULL the folder
384 * system will not do automatic scanning of \c FolderItems
386 * \param folder The \c Folder that contains the \c FolderItem
387 * \param item The \c FolderItem which's content should be checked
388 * \return TRUE if the \c FolderItem should be scanned, FALSE otherwise
390 gboolean (*scan_required) (Folder *folder,
393 /* Message functions */
395 * Get a MsgInfo for a message in a \c FolderItem
397 * \param folder The \c Folder containing the message
398 * \param item The \c FolderItem containing the message
399 * \param num The message number of the message
400 * \return A pointer to a \c MsgInfo decribing the message or \c
401 * NULL in case of an error
403 MsgInfo *(*get_msginfo) (Folder *folder,
407 * Get \c MsgInfos for a list of message numbers
409 * \param folder The \c Folder containing the message
410 * \param item The \c FolderItem containing the message
411 * \param msgnum_list A list of message numbers for which the
412 * \c MsgInfos should be fetched
413 * \return A list of \c MsgInfos for the messages in the \c msgnum_list
414 * that really exist. Messages that are not found can simply
417 MsgInfoList *(*get_msginfos) (Folder *folder,
419 MsgNumberList *msgnum_list);
421 * Get the filename for a message. This can either be the real message
422 * file for local folders or a temporary file for remote folders.
424 * \param folder The \c Folder containing the message
425 * \param item The \c FolderItem containing the message
426 * \param num The message number of the message
427 * \return A string with the filename of the message file. The returned
428 * string has to be freed with \c g_free(). If message is not
429 * available return NULL.
431 gchar *(*fetch_msg) (Folder *folder,
435 * Add a single message file to a folder with the given flags (if
436 * flag handling is supported by the folder)
438 * \param folder The target \c Folder for the message
439 * \param dest the target \c FolderItem for the message
440 * \param file The file that contains the message
441 * \param flags The flags the new message should have in the folder
442 * \return 0 on success, a negative number otherwise
444 gint (*add_msg) (Folder *folder,
449 * Add multiple messages to a \c FolderItem. If NULL the folder
450 * system will add messages with \c add_msg one by one
452 * \param folder The target \c Folder for the messages
453 * \param dest the target \c FolderItem for the messages
454 * \param file_list A list of \c MsgFileInfos which contain the
455 * filenames and flags for the new messages
456 * \param relation Insert tuples of (MsgFileInfo, new message number) to
457 * provide feedback for the folder system which new
458 * message number a \c MsgFileInfo got in dest. Insert
459 * 0 if the new message number is unknown.
461 gint (*add_msgs) (Folder *folder,
464 GRelation *relation);
466 * Copy a message to a FolderItem
468 * \param folder The \c Folder of the destination FolderItem
469 * \param dest The destination \c FolderItem for the message
470 * \param msginfo The message that should be copied
471 * \return The message number the copied message got, 0 if it is
472 * unknown because message numbers are assigned by an external
473 * system and not available after copying or a negative number
474 * if an error occuried
476 gint (*copy_msg) (Folder *folder,
480 * Copy multiple messages to a \c FolderItem. If \c NULL the folder
481 * system will use \c copy_msg to copy messages one by one.
483 * \param folder The \c Folder of the destination FolderItem
484 * \param dest The destination \c FolderItem for the message
485 * \param msglist A list of \c MsgInfos which should be copied to dest
486 * \param relation Insert tuples of (MsgInfo, new message number) to
487 * provide feedback for the folder system which new
488 * message number a \c MsgInfo got in dest. Insert
489 * 0 if the new message number is unknown.
490 * \return 0 on success, a negative number otherwise
492 gint (*copy_msgs) (Folder *folder,
494 MsgInfoList *msglist,
495 GRelation *relation);
497 * Remove a message from a \c FolderItem.
499 * \param folder The \c Folder of the message
500 * \param item The \c FolderItem containing the message
501 * \param num The message number of the message
502 * \return 0 on success, a negative number otherwise
504 gint (*remove_msg) (Folder *folder,
508 * Remove all messages in a \ c FolderItem
510 * \param folder The \c Folder of the \c FolderItem
511 * \param item The \FolderItem which's messages should be deleted
512 * \return 0 on succes, a negative number otherwise
514 gint (*remove_all_msg) (Folder *folder,
517 * Check if a message has been modified by someone else
519 * \param folder The \c Folder of the message
520 * \param item The \c FolderItem containing the message
521 * \param msginfo The \c MsgInfo for the message that should be checked
522 * \return \c TRUE if the message was modified, \c FALSE otherwise
524 gboolean (*is_msg_changed) (Folder *folder,
528 * Update a message's flags in the folder data. If NULL only the
529 * internal flag management will be used. The function has to set
530 * \c msginfo->flags.perm_flags. It does not have to set the flags
531 * that it got as \c newflags. If a flag can not be set in this
532 * \c FolderClass the function can refuse to set it. Flags that are not
533 * supported by the \c FolderClass should not be refused. They will be
534 * managed by the internal cache in this case.
536 * \param folder The \c Folder of the message
537 * \param item The \c FolderItem of the message
538 * \param msginfo The \c MsgInfo for the message which's flags should be
540 * \param newflags The flags the message should get
542 void (*change_flags) (Folder *folder,
545 MsgPermFlags newflags);
547 * Get the flags for a list of messages. Flags that are not supported
548 * by the folder should be preserved. They can be copied from
549 * \c msginfo->flags.perm_flags
551 * \param folder The \c Folder of the messages
552 * \param item The \c FolderItem of the messages
553 * \param msglist The list of \c MsgInfos for which the flags should
555 * \param msgflags A \c GRelation for tuples of (MsgInfo, new permanent
556 * flags for MsgInfo). Add tuples for the messages in msglist
557 * \return 0 on success, a negative number otherwise
559 gint (*get_flags) (Folder *folder,
561 MsgInfoList *msglist,
562 GRelation *msgflags);
567 SpecialFolderItemType stype;
569 gchar *name; /* UTF-8 */
570 gchar *path; /* UTF-8 */
577 gint unreadmarked_msgs;
584 guint no_sub : 1; /* no child allowed? */
585 guint no_select : 1; /* not selectable? */
586 guint collapsed : 1; /* collapsed item */
587 guint thread_collapsed : 1; /* collapsed item */
588 guint threaded : 1; /* threaded folder view */
589 guint hide_read_msgs : 1; /* hide read messages */
590 guint ret_rcpt : 1; /* return receipt */
593 guint opened : 1; /* opened by summary view */
594 FolderItemUpdateFlags update_flags; /* folderview for this folder should be updated */
596 FolderSortKey sort_key;
597 FolderSortType sort_type;
603 PrefsAccount *account;
611 FolderItemPrefs * prefs;
616 FolderSortKey sort_key;
617 FolderSortType sort_type;
619 guint thread_collapsed : 1;
621 guint hide_read_msgs : 1; /* CLAWS */
622 guint ret_rcpt : 1; /* CLAWS */
625 struct _FolderUpdateData
628 FolderUpdateFlags update_flags;
632 struct _FolderItemUpdateData
635 FolderItemUpdateFlags update_flags;
639 void folder_system_init (void);
640 void folder_register_class (FolderClass *klass);
641 void folder_unregister_class (FolderClass *klass);
642 Folder *folder_new (FolderClass *type,
645 void folder_init (Folder *folder,
648 void folder_destroy (Folder *folder);
650 void folder_set_xml (Folder *folder,
652 XMLTag *folder_get_xml (Folder *folder);
654 FolderItem *folder_item_new (Folder *folder,
657 void folder_item_append (FolderItem *parent,
659 void folder_item_remove (FolderItem *item);
660 void folder_item_remove_children (FolderItem *item);
661 void folder_item_destroy (FolderItem *item);
662 FolderItem *folder_item_parent (FolderItem *item);
664 void folder_item_set_xml (Folder *folder,
667 XMLTag *folder_item_get_xml (Folder *folder,
670 void folder_set_ui_func (Folder *folder,
673 void folder_set_name (Folder *folder,
675 void folder_set_sort (Folder *folder,
677 void folder_tree_destroy (Folder *folder);
679 void folder_add (Folder *folder);
680 void folder_remove (Folder *folder);
682 GList *folder_get_list (void);
683 gint folder_read_list (void);
684 void folder_write_list (void);
685 void folder_scan_tree (Folder *folder);
686 FolderItem *folder_create_folder(FolderItem *parent, const gchar *name);
687 gint folder_item_rename (FolderItem *item, gchar *newname);
688 void folder_update_op_count (void);
689 void folder_func_to_all_folders (FolderItemFunc function,
691 void folder_count_total_msgs (guint *new_msgs,
693 guint *unreadmarked_msgs,
695 gchar *folder_get_status (GPtrArray *folders,
698 Folder *folder_find_from_path (const gchar *path);
699 Folder *folder_find_from_name (const gchar *name,
701 FolderItem *folder_find_item_from_path (const gchar *path);
702 FolderClass *folder_get_class_from_string (const gchar *str);
703 FolderItem *folder_find_child_item_by_name (FolderItem *item,
705 gchar *folder_get_identifier (Folder *folder);
706 gchar *folder_item_get_identifier (FolderItem *item);
707 FolderItem *folder_find_item_from_identifier (const gchar *identifier);
708 gchar *folder_item_get_name (FolderItem *item);
710 Folder *folder_get_default_folder (void);
711 FolderItem *folder_get_default_inbox (void);
712 FolderItem *folder_get_default_outbox (void);
713 FolderItem *folder_get_default_draft (void);
714 FolderItem *folder_get_default_queue (void);
715 FolderItem *folder_get_default_trash (void);
716 FolderItem *folder_get_default_processing (void);
717 void folder_set_missing_folders (void);
718 void folder_unref_account_all (PrefsAccount *account);
720 /* return value is locale encoded file name */
721 gchar *folder_item_get_path (FolderItem *item);
723 gint folder_item_open (FolderItem *item);
724 gint folder_item_close (FolderItem *item);
725 gint folder_item_scan (FolderItem *item);
726 gint folder_item_syncronize_flags (FolderItem *item);
727 void folder_item_scan_foreach (GHashTable *table);
728 MsgInfo *folder_item_get_msginfo (FolderItem *item,
730 MsgInfo *folder_item_get_msginfo_by_msgid(FolderItem *item,
732 GSList *folder_item_get_msg_list (FolderItem *item);
733 /* return value is locale charset */
734 gchar *folder_item_fetch_msg (FolderItem *item,
736 gint folder_item_fetch_all_msg (FolderItem *item);
737 gint folder_item_add_msg (FolderItem *dest,
740 gboolean remove_source);
741 gint folder_item_add_msgs (FolderItem *dest,
743 gboolean remove_source);
744 gint folder_item_move_to (FolderItem *src,
746 FolderItem **new_item);
747 gint folder_item_move_msg (FolderItem *dest,
749 gint folder_item_move_msgs (FolderItem *dest,
751 gint folder_item_copy_msg (FolderItem *dest,
753 gint folder_item_copy_msgs (FolderItem *dest,
755 gint folder_item_remove_msg (FolderItem *item,
757 gint folder_item_remove_msgs (FolderItem *item,
759 gint folder_item_remove_all_msg (FolderItem *item);
760 void folder_item_change_msg_flags (FolderItem *item,
762 MsgPermFlags newflags);
763 gboolean folder_item_is_msg_changed (FolderItem *item,
765 /* return value is locale chaset */
766 gchar *folder_item_get_cache_file (FolderItem *item);
767 gchar *folder_item_get_mark_file (FolderItem *item);
768 gchar * folder_item_get_identifier (FolderItem * item);
770 GHashTable *folder_persist_prefs_new (Folder *folder);
771 void folder_persist_prefs_free (GHashTable *pptable);
772 const PersistPrefs *folder_get_persist_prefs
773 (GHashTable *pptable, const char *name);
775 void folder_item_restore_persist_prefs (FolderItem *item, GHashTable *pptable);
776 void folder_clean_cache_memory (void);
777 void folder_item_write_cache (FolderItem *item);
778 void folder_item_set_default_flags (FolderItem *dest, MsgFlags *flags);
780 void folder_item_apply_processing (FolderItem *item);
782 void folder_item_update (FolderItem *item,
783 FolderItemUpdateFlags update_flags);
784 void folder_item_update_recursive (FolderItem *item,
785 FolderItemUpdateFlags update_flags);
786 void folder_item_update_freeze (void);
787 void folder_item_update_thaw (void);
789 #endif /* __FOLDER_H__ */