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__
33 typedef struct _AddressCache AddressCache;
35 struct _AddressCache {
42 ItemFolder *rootFolder;
49 /* Function prototypes */
50 AddressCache *addrcache_create ( void );
51 ItemFolder *addrcache_get_root_folder ( AddressCache *cache );
52 GList *addrcache_get_list_folder ( AddressCache *cache );
53 GList *addrcache_get_list_person ( AddressCache *cache );
54 gboolean addrcache_get_dirty ( AddressCache *cache );
55 void addrcache_set_dirty ( AddressCache *cache,
56 const gboolean value );
57 gboolean addrcache_get_modified ( AddressCache *cache );
58 void addrcache_set_modified ( AddressCache *cache,
59 const gboolean value );
60 gboolean addrcache_get_read_flag ( AddressCache *cache );
61 void addrcache_set_read_flag ( AddressCache *cache,
62 const gboolean value );
63 gboolean addrcache_get_accessed ( AddressCache *cache );
64 void addrcache_set_accessed ( AddressCache *cache,
65 const gboolean value );
66 gchar *addrcache_get_name ( AddressCache *cache );
67 void addrcache_set_name ( AddressCache *cache,
70 void addrcache_refresh ( AddressCache *cache );
71 void addrcache_clear ( AddressCache *cache );
72 void addrcache_free ( AddressCache *cache );
73 gboolean addrcache_check_file ( AddressCache *cache, gchar *path );
74 gboolean addrcache_mark_file ( AddressCache *cache, gchar *path );
76 void addrcache_print_item_list ( GList *list, FILE *stream );
77 void addrcache_print ( AddressCache *cache, FILE *stream );
78 void addrcache_dump_hash ( AddressCache *cache, FILE *stream );
80 void addrcache_id_person ( AddressCache *cache, ItemPerson *person );
81 void addrcache_id_group ( AddressCache *cache, ItemGroup *group );
82 void addrcache_id_folder ( AddressCache *cache, ItemFolder *folder );
83 void addrcache_id_email ( AddressCache *cache, ItemEMail *email );
84 void addrcache_id_attribute ( AddressCache *cache, UserAttribute *attrib );
86 gboolean addrcache_hash_add_person ( AddressCache *cache, ItemPerson *person );
87 gboolean addrcache_hash_add_group ( AddressCache *cache, ItemGroup *group );
88 gboolean addrcache_hash_add_folder ( AddressCache *cache, ItemFolder *folder );
90 gboolean addrcache_folder_add_person ( AddressCache *cache,
93 gboolean addrcache_folder_add_folder ( AddressCache *cache,
96 gboolean addrcache_folder_add_group ( AddressCache *cache,
100 gboolean addrcache_add_person ( AddressCache *cache,
101 ItemPerson *person );
102 gboolean addrcache_add_group ( AddressCache *cache,
104 gboolean addrcache_person_add_email ( AddressCache *cache,
107 gboolean addrcache_group_add_email ( AddressCache *cache,
110 gboolean addrcache_add_folder ( AddressCache *cache,
111 ItemFolder *folder );
113 void addrcache_folder_move_person ( AddressCache *cache,
115 ItemFolder *target );
116 void addrcache_folder_move_group ( AddressCache *cache,
118 ItemFolder *target );
119 void addrcache_folder_move_folder ( AddressCache *cache,
121 ItemFolder *target );
123 AddrItemObject *addrcache_get_object ( AddressCache *cache, const gchar *uid );
124 ItemPerson *addrcache_get_person ( AddressCache *cache, const gchar *uid );
125 ItemGroup *addrcache_get_group ( AddressCache *cache, const gchar *uid );
126 ItemEMail *addrcache_get_email ( AddressCache *cache, const gchar *eid );
128 UserAttribute *addrcache_person_remove_attrib_id( AddressCache *cache,
131 UserAttribute *addrcache_person_remove_attribute( AddressCache *cache,
133 UserAttribute *attrib );
135 ItemGroup *addrcache_remove_group ( AddressCache *cache, ItemGroup *group );
136 ItemPerson *addrcache_remove_person ( AddressCache *cache, ItemPerson *person );
137 ItemEMail *addrcache_remove_email ( AddressCache *cache, ItemEMail *email );
139 ItemEMail *addrcache_person_remove_email( AddressCache *cache,
142 void addrcache_person_move_email ( AddressCache *cache,
144 ItemPerson *target );
146 GList *addrcache_folder_get_address_list( AddressCache *cache, ItemFolder *folder );
147 GList *addrcache_folder_get_person_list ( AddressCache *cache, ItemFolder *folder );
148 GList *addrcache_folder_get_group_list ( AddressCache *cache, ItemFolder *folder );
149 GList *addrcache_folder_get_folder_list ( AddressCache *cache, ItemFolder *folder );
151 GList *addrcache_get_address_list ( AddressCache *cache );
152 GList *addrcache_get_person_list ( AddressCache *cache );
153 GList *addrcache_get_group_list ( AddressCache *cache );
154 GList *addrcache_get_folder_list ( AddressCache *cache );
156 GList *addrcache_get_group_for_person ( AddressCache *cache, ItemPerson *person );
158 ItemFolder *addrcache_find_root_folder ( ItemFolder *folder );
159 GList *addrcache_get_all_persons ( AddressCache *cache );
160 GList *addrcache_get_all_groups ( AddressCache *cache );
162 ItemFolder *addrcache_remove_folder ( AddressCache *cache,
163 ItemFolder *folder );
164 ItemFolder *addrcache_remove_folder_delete ( AddressCache *cache,
165 ItemFolder *folder );
167 ItemPerson *addrcache_add_contact ( AddressCache *cache,
170 const gchar *address,
171 const gchar *remarks );
173 ItemFolder *addrcache_add_new_folder ( AddressCache *cache,
174 ItemFolder *parent );
176 #endif /* __ADDRCACHE_H__ */