1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
|
/* -*-mode:c; c-style:k&r; c-basic-offset:4; -*- */
/* Balsa E-Mail Client
*
* Copyright (C) 1997-2005 Stuart Parmenter and others,
* See the file AUTHORS for a list.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2, or (at your option)
* any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
* 02111-1307, USA.
*/
#ifndef __LIBBALSA_ADDRESS_BOOK_H__
#define __LIBBALSA_ADDRESS_BOOK_H__
#include "address.h"
#define LIBBALSA_TYPE_ADDRESS_BOOK (libbalsa_address_book_get_type())
#define LIBBALSA_ADDRESS_BOOK(obj) (G_TYPE_CHECK_INSTANCE_CAST (obj, LIBBALSA_TYPE_ADDRESS_BOOK, LibBalsaAddressBook))
#define LIBBALSA_ADDRESS_BOOK_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST (klass, LIBBALSA_TYPE_ADDRESS_BOOK, LibBalsaAddressBookClass))
#define LIBBALSA_IS_ADDRESS_BOOK(obj) (G_TYPE_CHECK_INSTANCE_TYPE (obj, LIBBALSA_TYPE_ADDRESS_BOOK))
#define LIBBALSA_IS_ADDRESS_BOOK_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE (klass, LIBBALSA_TYPE_ADDRESS_BOOK))
#define LIBBALSA_ADDRESS_BOOK_GET_CLASS(obj) \
(G_TYPE_INSTANCE_GET_CLASS ((obj), LIBBALSA_TYPE_ADDRESS_BOOK, \
LibBalsaAddressBookClass))
typedef enum {
LBABERR_OK = 0,
LBABERR_CANNOT_READ,
LBABERR_CANNOT_WRITE,
LBABERR_CANNOT_CONNECT,
LBABERR_CANNOT_SEARCH,
LBABERR_DUPLICATE,
LBABERR_ADDRESS_NOT_FOUND
} LibBalsaABErr;
typedef struct _LibBalsaAddressBook LibBalsaAddressBook;
typedef struct _LibBalsaAddressBookClass LibBalsaAddressBookClass;
typedef LibBalsaABErr (*LibBalsaAddressBookLoadFunc)(LibBalsaAddressBook *ab,
LibBalsaAddress *address,
gpointer closure);
struct _LibBalsaAddressBook {
GObject parent;
/* The gnome_config prefix where we save this address book */
gchar *config_prefix;
gchar *name;
gchar *ext_op_code; /* extra description for last operation */
gboolean is_expensive; /* is lookup to the address book expensive?
e.g. LDAP address book */
gboolean expand_aliases;
gboolean dist_list_mode;
};
struct _LibBalsaAddressBookClass {
GObjectClass parent;
LibBalsaABErr (*load) (LibBalsaAddressBook * ab,
const gchar *filter,
LibBalsaAddressBookLoadFunc callback,
gpointer closure);
/* adds given address to the address book, updating the permanent
* storage. */
LibBalsaABErr (*add_address) (LibBalsaAddressBook * ab,
LibBalsaAddress * address);
/* remove given address to the address book, updating the permanent
* storage. */
LibBalsaABErr (*remove_address) (LibBalsaAddressBook * ab,
LibBalsaAddress * address);
/* Sets new entries for given address, copying fields from newval.
* Updates the permanent storage. */
LibBalsaABErr (*modify_address) (LibBalsaAddressBook * ab,
LibBalsaAddress * address,
LibBalsaAddress * newval);
void (*save_config) (LibBalsaAddressBook * ab, const gchar * prefix);
void (*load_config) (LibBalsaAddressBook * ab, const gchar * prefix);
GList* (*alias_complete) (LibBalsaAddressBook * ab, const gchar *prefix,
gchar ** new_prefix);
};
GType libbalsa_address_book_get_type(void);
LibBalsaAddressBook *libbalsa_address_book_new_from_config(const gchar *
prefix);
/*
This will call the callback function once for each address in the
address book. The recipient should make sure to ref the address if
they will be keeping a reference to it around. The callback may
occur asynchronously.
After all addresses are loaded the callback will be called with
address==NULL.
*/
LibBalsaABErr libbalsa_address_book_load(LibBalsaAddressBook * ab,
const char *filter,
LibBalsaAddressBookLoadFunc callback,
gpointer closure);
LibBalsaABErr libbalsa_address_book_add_address(LibBalsaAddressBook *ab,
LibBalsaAddress *address);
LibBalsaABErr libbalsa_address_book_remove_address(LibBalsaAddressBook *ab,
LibBalsaAddress *address);
LibBalsaABErr libbalsa_address_book_modify_address(LibBalsaAddressBook *ab,
LibBalsaAddress *address,
LibBalsaAddress *newval);
/* set_status takes over the string ownership */
void libbalsa_address_book_set_status(LibBalsaAddressBook * ab, gchar *str);
void libbalsa_address_book_save_config(LibBalsaAddressBook * ab,
const gchar * prefix);
void libbalsa_address_book_load_config(LibBalsaAddressBook * ab,
const gchar * prefix);
const gchar* libbalsa_address_book_strerror(LibBalsaAddressBook * ab,
LibBalsaABErr err);
/*
Returns a list of LibBalsaAddress objects. The caller is responsible
for unref()ing these address objects when it is finished with them
and for freeing the list.
*/
GList *libbalsa_address_book_alias_complete(LibBalsaAddressBook * ab,
const gchar *prefix,
gchar **new_prefix);
gboolean libbalsa_address_is_dist_list(const LibBalsaAddressBook *ab,
const LibBalsaAddress *address);
#endif
|
