2 * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3 * Copyright (C) 2001-2002 Match Grun
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.
21 * Definitions for address cache.
24 #ifndef __ADDRCACHE_H__
25 #define __ADDRCACHE_H__
31 #include "addrcindex.h"
34 typedef struct _AddressCache AddressCache;
36 struct _AddressCache {
43 ItemFolder *rootFolder;
48 AddrCacheIndex *searchIndex;
51 /* Function prototypes */
52 AddressCache *addrcache_create();
53 ItemFolder *addrcache_get_root_folder ( AddressCache *cache );
54 GList *addrcache_get_list_folder ( AddressCache *cache );
55 GList *addrcache_get_list_person ( AddressCache *cache );
56 gboolean addrcache_get_dirty ( AddressCache *cache );
57 void addrcache_set_dirty ( AddressCache *cache,
58 const gboolean value );
59 gboolean addrcache_get_modified ( AddressCache *cache );
60 void addrcache_set_modified ( AddressCache *cache,
61 const gboolean value );
62 gboolean addrcache_get_read_flag ( AddressCache *cache );
63 void addrcache_set_read_flag ( AddressCache *cache,
64 const gboolean value );
65 gboolean addrcache_get_accessed ( AddressCache *cache );
66 void addrcache_set_accessed ( AddressCache *cache,
67 const gboolean value );
68 gchar *addrcache_get_name ( AddressCache *cache );
69 void addrcache_set_name ( AddressCache *cache,
72 void addrcache_refresh ( AddressCache *cache );
73 void addrcache_clear ( AddressCache *cache );
74 void addrcache_free ( AddressCache *cache );
75 gboolean addrcache_check_file ( AddressCache *cache, gchar *path );
76 gboolean addrcache_mark_file ( AddressCache *cache, gchar *path );
78 void addrcache_print_item_list ( GList *list, FILE *stream );
79 void addrcache_print ( AddressCache *cache, FILE *stream );
80 void addrcache_dump_hash ( AddressCache *cache, FILE *stream );
82 void addrcache_id_person ( AddressCache *cache, ItemPerson *person );
83 void addrcache_id_group ( AddressCache *cache, ItemGroup *group );
84 void addrcache_id_folder ( AddressCache *cache, ItemFolder *folder );
85 void addrcache_id_email ( AddressCache *cache, ItemEMail *email );
86 void addrcache_id_attribute ( AddressCache *cache, UserAttribute *attrib );
88 gboolean addrcache_hash_add_person ( AddressCache *cache, ItemPerson *person );
89 gboolean addrcache_hash_add_group ( AddressCache *cache, ItemGroup *group );
90 gboolean addrcache_hash_add_folder ( AddressCache *cache, ItemFolder *folder );
92 gboolean addrcache_folder_add_person ( AddressCache *cache,
95 gboolean addrcache_folder_add_folder ( AddressCache *cache,
98 gboolean addrcache_folder_add_group ( AddressCache *cache,
102 gboolean addrcache_add_person ( AddressCache *cache,
103 ItemPerson *person );
104 gboolean addrcache_add_group ( AddressCache *cache,
106 gboolean addrcache_person_add_email ( AddressCache *cache,
109 gboolean addrcache_group_add_email ( AddressCache *cache,
112 gboolean addrcache_add_folder ( AddressCache *cache,
113 ItemFolder *folder );
115 void addrcache_folder_move_person ( AddressCache *cache,
117 ItemFolder *target );
118 void addrcache_folder_move_group ( AddressCache *cache,
120 ItemFolder *target );
121 void addrcache_folder_move_folder ( AddressCache *cache,
123 ItemFolder *target );
125 AddrItemObject *addrcache_get_object ( AddressCache *cache, const gchar *uid );
126 ItemPerson *addrcache_get_person ( AddressCache *cache, const gchar *uid );
127 ItemGroup *addrcache_get_group ( AddressCache *cache, const gchar *uid );
128 ItemEMail *addrcache_get_email ( AddressCache *cache, const gchar *eid );
130 UserAttribute *addrcache_person_remove_attrib_id( AddressCache *cache,
133 UserAttribute *addrcache_person_remove_attribute( AddressCache *cache,
135 UserAttribute *attrib );
137 ItemGroup *addrcache_remove_group ( AddressCache *cache, ItemGroup *group );
138 ItemPerson *addrcache_remove_person ( AddressCache *cache, ItemPerson *person );
139 ItemEMail *addrcache_remove_email ( AddressCache *cache, ItemEMail *email );
141 ItemEMail *addrcache_person_remove_email( AddressCache *cache,
144 void addrcache_person_move_email ( AddressCache *cache,
146 ItemPerson *target );
148 GList *addrcache_folder_get_address_list( AddressCache *cache, ItemFolder *folder );
149 GList *addrcache_folder_get_person_list ( AddressCache *cache, ItemFolder *folder );
150 GList *addrcache_folder_get_group_list ( AddressCache *cache, ItemFolder *folder );
151 GList *addrcache_folder_get_folder_list ( AddressCache *cache, ItemFolder *folder );
153 GList *addrcache_get_address_list ( AddressCache *cache );
154 GList *addrcache_get_person_list ( AddressCache *cache );
155 GList *addrcache_get_group_list ( AddressCache *cache );
156 GList *addrcache_get_folder_list ( AddressCache *cache );
158 GList *addrcache_get_group_for_person ( AddressCache *cache, ItemPerson *person );
160 ItemFolder *addrcache_find_root_folder ( ItemFolder *folder );
161 GList *addrcache_get_all_persons ( AddressCache *cache );
162 GList *addrcache_get_all_groups ( AddressCache *cache );
164 ItemFolder *addrcache_remove_folder ( AddressCache *cache,
165 ItemFolder *folder );
166 ItemFolder *addrcache_remove_folder_delete ( AddressCache *cache,
167 ItemFolder *folder );
169 ItemPerson *addrcache_add_contact ( AddressCache *cache,
172 const gchar *address,
173 const gchar *remarks );
175 void addrcache_clear_index ( AddressCache *cache );
176 void addrcache_create_index ( AddressCache *cache,
178 void addrcache_build_index ( AddressCache *cache );
179 void addrcache_invalidate ( AddressCache *cache );
181 #endif /* __ADDRCACHE_H__ */