2 * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3 * Copyright (C) 2001-2003 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.
24 #ifndef __ADDRITEM_H__
25 #define __ADDRITEM_H__
30 #define ADDRITEM_OBJECT(obj) ((AddrItemObject *)obj)
31 #define ADDRITEM_TYPE(obj) (ADDRITEM_OBJECT(obj)->type)
32 #define ADDRITEM_NAME(obj) (ADDRITEM_OBJECT(obj)->name)
33 #define ADDRITEM_ID(obj) (ADDRITEM_OBJECT(obj)->uid)
34 #define ADDRITEM_PARENT(obj) (ADDRITEM_OBJECT(obj)->parent)
35 #define ADDRITEM_SUBTYPE(obj) (ADDRITEM_OBJECT(obj)->subType)
53 ADDRFOLDER_QUERY_RESULTS
56 typedef struct _AddrItemObject AddrItemObject;
57 struct _AddrItemObject {
61 AddrItemObject *parent;
65 typedef struct _ItemPerson ItemPerson;
77 typedef struct _ItemEMail ItemEMail;
84 typedef struct _UserAttribute UserAttribute;
85 struct _UserAttribute {
91 typedef struct _ItemFolder ItemFolder;
95 gboolean isRoot; /* TRUE if root folder */
96 GList *listItems; /* Used for temporary items only */
97 GList *listFolder; /* List of contained (child) folders */
98 GList *listPerson; /* List of contained persons */
99 GList *listGroup; /* List of contained (child) groups */
100 AddressFolderType folderType; /* Folder type */
101 gpointer *folderData; /* Pointer to folder's data */
102 gboolean isHidden; /* TRUE if folder is hidden */
105 typedef struct _ItemGroup ItemGroup;
112 /* Function prototypes */
113 ItemEMail *addritem_create_item_email ( void );
114 ItemEMail *addritem_copy_item_email ( ItemEMail *item );
115 ItemEMail *addritem_copyfull_item_email ( ItemEMail *item );
116 void addritem_email_set_id ( ItemEMail *email, const gchar *value );
117 void addritem_email_set_alias ( ItemEMail *email, const gchar *value );
118 void addritem_email_set_address ( ItemEMail *email, const gchar *value );
119 void addritem_email_set_remarks ( ItemEMail *email, const gchar *value );
120 void addritem_free_item_email ( ItemEMail *item );
122 UserAttribute *addritem_create_attribute( void );
123 UserAttribute *addritem_copy_attribute ( UserAttribute *item );
124 void addritem_attrib_set_id ( UserAttribute *item, const gchar *value );
125 void addritem_attrib_set_name ( UserAttribute *item, const gchar *value );
126 void addritem_attrib_set_value ( UserAttribute *item, const gchar *value );
127 void addritem_free_attribute ( UserAttribute *item );
129 ItemPerson *addritem_create_item_person ( void );
130 ItemPerson *addritem_copy_item_person ( ItemPerson *item );
131 void addritem_person_set_id ( ItemPerson *person, const gchar *value );
132 void addritem_person_set_first_name ( ItemPerson *person, const gchar *value );
133 void addritem_person_set_last_name ( ItemPerson *person, const gchar *value );
134 void addritem_person_set_nick_name ( ItemPerson *person, const gchar *value );
135 void addritem_person_set_common_name ( ItemPerson *person, const gchar *value );
136 void addritem_person_set_external_id ( ItemPerson *person, const gchar *value );
137 void addritem_person_set_opened ( ItemPerson *person, const gboolean value );
138 void addritem_free_item_person ( ItemPerson *person );
139 gboolean addritem_person_empty ( ItemPerson *person );
140 void addritem_free_list_email ( GList *list );
141 void addritem_free_list_attribute ( GList *list );
143 ItemGroup *addritem_create_item_group ( void );
144 ItemGroup *addritem_copy_item_group ( ItemGroup *item );
145 void addritem_free_item_group ( ItemGroup *group );
146 void addritem_group_set_id ( ItemGroup *group, const gchar *value );
147 void addritem_group_set_name ( ItemGroup *group, const gchar *value );
148 void addritem_group_set_remarks ( ItemGroup *group, const gchar *value );
150 void addritem_print_item_email ( ItemEMail *item, FILE *stream );
151 void addritem_print_attribute ( UserAttribute *item, FILE *stream );
152 void addritem_print_item_person ( ItemPerson *person, FILE *stream );
153 void addritem_print_item_group ( ItemGroup *group, FILE *stream );
154 void addritem_print_item_folder ( ItemFolder *folder, FILE *stream );
155 void addritem_print_item ( AddrItemObject *aio, FILE *stream );
157 gboolean addritem_person_add_email ( ItemPerson *person, ItemEMail *email );
158 ItemEMail *addritem_person_get_email ( ItemPerson *person, const gchar *eid );
159 ItemEMail *addritem_person_remove_email_id ( ItemPerson *person, const gchar *eid );
160 ItemEMail *addritem_person_remove_email ( ItemPerson *person, ItemEMail *email );
162 void addritem_person_add_attribute ( ItemPerson *person, UserAttribute *attrib );
163 UserAttribute *addritem_person_get_attribute ( ItemPerson *person, const gchar *aid );
164 UserAttribute *addritem_person_remove_attrib_id ( ItemPerson *person, const gchar *aid );
165 UserAttribute *addritem_person_remove_attribute ( ItemPerson *person, UserAttribute *attrib );
167 ItemFolder *addritem_create_item_folder ( void );
168 ItemFolder *addritem_copy_item_folder ( ItemFolder *item );
169 void addritem_folder_set_id ( ItemFolder *folder, const gchar *value );
170 void addritem_folder_set_name ( ItemFolder *folder, const gchar *value );
171 void addritem_folder_set_remarks ( ItemFolder *folder, const gchar *value );
172 void addritem_folder_set_hidden ( ItemFolder *folder, const gboolean value );
173 void addritem_free_item_folder ( ItemFolder *folder );
174 void addritem_free_item_folder_recurse ( ItemFolder *parent );
176 gboolean addritem_group_add_email ( ItemGroup *group, ItemEMail *email );
177 ItemEMail *addritem_group_remove_email ( ItemGroup *group, ItemEMail *email );
178 ItemEMail *addritem_group_remove_email_id( ItemGroup *group, const gchar *eid );
180 gboolean addritem_folder_add_person ( ItemFolder *folder, ItemPerson *item );
181 ItemPerson *addritem_folder_remove_person( ItemFolder *group, ItemPerson *person );
183 gboolean addritem_folder_add_folder ( ItemFolder *folder, ItemFolder *item );
184 gboolean addritem_folder_add_group ( ItemFolder *folder, ItemGroup *item );
185 void addritem_folder_free_person ( ItemFolder *folder );
186 GList *addritem_folder_get_person_list ( ItemFolder *folder );
187 GList *addritem_folder_get_group_list ( ItemFolder *folder );
189 ItemEMail *addritem_move_email_before ( ItemPerson *person,
191 ItemEMail *itemTarget );
192 ItemEMail *addritem_move_email_after ( ItemPerson *person,
194 ItemEMail *itemTarget );
196 void addritem_parse_first_last ( ItemPerson *person );
197 GList *addritem_folder_path ( const ItemFolder *folder,
198 const gboolean seq );
199 gchar *addritem_format_email ( ItemEMail *email );
201 #endif /* __ADDRITEM_H__ */