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 necessary to access LDAP servers.
33 #include "addrcache.h"
34 #include "adbookbase.h"
36 #define SYLDAP_DFL_PORT 389
37 #define SYLDAP_MAX_ENTRIES 20
38 #define SYLDAP_DFL_TIMEOUT 30
39 #define SYLDAP_DFL_CRITERIA "(&(mail=*)(cn=%s*))"
41 #define SYLDAP_ATTR_DN "dn"
42 #define SYLDAP_ATTR_COMMONNAME "cn"
43 #define SYLDAP_ATTR_GIVENNAME "givenName"
44 #define SYLDAP_ATTR_SURNAME "sn"
45 #define SYLDAP_ATTR_EMAIL "mail"
46 #define SYLDAP_ATTR_UID "uid"
48 typedef struct _SyldapServer SyldapServer;
49 struct _SyldapServer {
51 AddressCache *addressCache;
58 gchar *searchCriteria;
66 void (*callBack)( void * );
70 /* Function prototypes */
71 SyldapServer *syldap_create ( void );
72 void syldap_set_name ( SyldapServer* ldapServer, const gchar *value );
73 void syldap_set_host ( SyldapServer* ldapServer, const gchar *value );
74 void syldap_set_port ( SyldapServer* ldapServer, const gint value );
75 void syldap_set_base_dn ( SyldapServer* ldapServer, const gchar *value );
76 void syldap_set_bind_dn ( SyldapServer* ldapServer, const gchar *value );
77 void syldap_set_bind_password ( SyldapServer* ldapServer, const gchar *value );
78 void syldap_set_search_criteria ( SyldapServer* ldapServer, const gchar *value );
79 void syldap_set_search_value ( SyldapServer* ldapServer, const gchar *value );
80 void syldap_set_max_entries ( SyldapServer* ldapServer, const gint value );
81 void syldap_set_timeout ( SyldapServer* ldapServer, const gint value );
82 void syldap_set_callback ( SyldapServer *ldapServer, void *func );
83 void syldap_set_accessed ( SyldapServer *ldapServer, const gboolean value );
84 void syldap_force_refresh ( SyldapServer *ldapServer );
85 void syldap_free ( SyldapServer *ldapServer );
86 gint syldap_get_status ( SyldapServer *ldapServer );
87 gboolean syldap_get_accessed ( SyldapServer *ldapServer );
88 gchar *syldap_get_name ( SyldapServer *ldapServer );
89 gboolean syldap_get_modified ( SyldapServer *ldapServer );
90 void syldap_set_modified ( SyldapServer *ldapServer, const gboolean value );
92 void syldap_print_data ( SyldapServer *ldapServer, FILE *stream );
93 gboolean syldap_check_search ( SyldapServer *ldapServer );
94 gint syldap_read_data ( SyldapServer *ldapServer );
95 gint syldap_read_data_th ( SyldapServer *ldapServer );
96 void syldap_cancel_read ( SyldapServer *ldapServer );
98 ItemFolder *syldap_get_root_folder ( SyldapServer *ldapServer );
99 GList *syldap_get_list_person ( SyldapServer *ldapServer );
100 GList *syldap_get_list_folder ( SyldapServer *ldapServer );
102 GList *syldap_read_basedn_s ( const gchar *host, const gint port, const gchar *bindDN,
103 const gchar *bindPW, const gint tov );
104 GList *syldap_read_basedn ( SyldapServer *ldapServer );
105 gboolean syldap_test_connect_s ( const gchar *host, const gint port );
106 gboolean syldap_test_connect ( SyldapServer *ldapServer );
107 gboolean syldap_test_ldap_lib ( void );
109 #endif /* USE_LDAP */
111 #endif /* __SYLDAP_H__ */