mailbox.h
8.93 KB
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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
/* GNU mailutils - a suite of utilities for electronic mail
Copyright (C) 1999 Free Software Foundation, Inc.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU Library 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 Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */
#ifndef _MAILBOX_H
# define _MAILBOX_H
#include <url.h>
#ifdef __cplusplus
extern "C" {
#endif
#ifndef __P
# ifdef __STDC__
# define __P(args) args
# else
# define __P(args) ()
# endif
#endif /*__P */
/* forward declaration */
struct _mailbox;
typedef struct _mailbox *mailbox_t;
/* Lock settings */
typedef enum { MB_ULOCK, MB_RLOCK, MB_WLOCK } mailbox_lock_t;
struct mailbox_type
{
char *name;
int id;
struct url_type *utype;
int (*_init) __P ((mailbox_t *, const char *name, int id));
int (*_destroy) __P ((mailbox_t *);
};
struct _mailbox
{
/* Data */
char *name;
int messages;
int num_deleted;
long size;
int timeout;
int refresh;
mailbox_lock_t lock;
int (*notif) __P ((mailbox_t));
void *data;
struct mailbox_type *mtype;
/* Functions */
void (*_destroy) __P ((maibox_t *));
int (*_open) __P ((mailbox_t, int flag));
int (*_close) __P ((mailbox_t, int flag));
/* type */
int (*_get_name) __P ((mailbox_t, int *type, char *desc,
int offset, int len));
int (*_get_mtype) __P ((mailbox_t, int *type, char **desc,
int *len));
/* passwd if needed */
int (*_get_passwd) __P ((mailbox_t, char * passwd, int offset, int n));
int (*_get_mpasswd) __P ((mailbox_t, char ** passwd, int *n));
int (*_set_passwd) __P ((mailbox_t, const char * passwd,
int offset, int n));
/* deleting mesgs */
int (*_delete) __P ((mailbox_t, int id));
int (*_undelete) __P ((mailbox_t, int id));
int (*_is_deleted) __P ((mailbox_t, int id));
int (*_expunge) __P ((mailbox_t));
/* appending messages */
int (*_new_msg) __P ((mailbox_t, int *id));
int (*_set_header) __P ((mailbox_t, int id, const char *h,
int offset, int n, int replace));
int (*_set_body) __P ((mailbox_t, int id, const char *b,
int offset, int n, int replace));
int (*_append) __P ((mailbox_t, int id));
int (*_destroy_msg) __P ((mailbox_t, int id));
/* locking */
int (*_lock) __P ((mailbox_t, int flag));
int (*_unlock) __P ((mailbox_t));
/* reading mesgs */
int (*_get_body) __P ((mailbox_t, int id, char *v,
int offset, int n));
int (*_get_mbody) __P ((mailbox_t, int id, char **v, int *n));
int (*_get_header) __P ((mailbox_t, int id, char *h,
int offset, int n));
int (*_get_mheader) __P ((mailbox_t, int id, char **h, int *n));
/* misc */
int (*_scan) __P ((mailbox_t, int *msgs));
int (*_is_updated) __P ((mailbox_t));
int (*_get_timeout) __P ((mailbox_t, int *timeout));
int (*_set_timeout) __P ((mailbox_t, int timeout));
int (*_get_size) __P ((mailbox_t, int id, long *size));
int (*_get_refresh) __P ((mailbox_t, int *refresh));
int (*_set_refresh) __P ((mailbox_t, int refresh));
int (*_set_notification) __P ((mailbox_t, int (*notif) __P ((mailbox_t))));
};
/* constructor/destructor and possible types */
extern int mailbox_init __P ((mailbox_t *, const char *name, int id));
extern void mailbox_destroy __P ((mailbox_t *));
/* mailbox registration */
extern int mailbox_list_type __P ((struct mailbox_type mtype[], int size));
extern int mailbox_list_mtype __P ((struct mailbox_type **mtype, int *size));
extern int mailbox_add_type __P ((struct mailbox_type *mlist));
extern int mailbox_remove_type __P ((const struct mailbox_type *mlist));
extern int mailbox_get_type __P ((struct mailbox_type * const *mtype,
int id));
#ifndef INLINE
# ifdef __GNUC__
# define INLINE __inline__
# else
# define INLINE
# endif
#endif
extern INLINE int mailbox_open __P ((mailbox_t, int flag));
extern INLINE int mailbox_close __P ((mailbox_t, int flag));
/* type */
extern INLINE int mailbox_get_name __P ((mailbox_t, int *type, char *desc,
int offset, int len));
extern INLINE int mailbox_get_mname __P ((mailbox_t, int *type, char **desc,
int *len));
/* passwd */
extern INLINE int mailbox_get_passwd __P ((mailbox_t, char * passwd,
int offset, int len));
extern INLINE int mailbox_get_mpasswd __P ((mailbox_t, char ** passwd,
int *len));
extern INLINE int mailbox_set_passwd __P ((mailbox_t, const char * passwd,
int offset, int len));
/* deleting */
extern INLINE int mailbox_delete __P ((mailbox_t, int));
extern INLINE int mailbox_undelete __P ((mailbox_t, int));
extern INLINE int mailbox_expunge __P ((mailbox_t));
extern INLINE int mailbox_is_deleted __P ((mailbox_t, int));
/* appending */
extern INLINE int mailbox_new_msg __P ((mailbox_t, int * id));
extern INLINE int mailbox_set_header __P ((mailbox_t, int id, const char *h,
int offset, int n, int replace));
extern INLINE int mailbox_set_body __P ((mailbox_t, int id, const char *b,
int offset, int n, int replace));
extern INLINE int mailbox_append __P ((mailbox_t, int id));
extern INLINE int mailbox_destroy_msg __P ((mailbox_t, int id));
/* reading */
extern INLINE int mailbox_get_body __P ((mailbox_t, int id, char *b,
int offset, int n));
extern INLINE int mailbox_get_mbody __P ((mailbox_t, int id, char **b,
int *n));
extern INLINE int mailbox_get_header __P ((mailbox_t, int id, char *h,
int offset, int n));
extern INLINE int mailbox_get_mheader __P ((mailbox_t, int id, char **h,
int *n));
/* locking */
extern INLINE int mailbox_lock __P ((mailbox_t, int flag));
extern INLINE int mailbox_unlock __P ((mailbox_t));
/* misc */
extern INLINE int mailbox_scan __P ((mailbox_t, int *msgs));
extern INLINE int mailbox_is_updated __P ((mailbox_t));
extern INLINE int mailbox_get_timeout __P ((mailbox_t, int *timeout));
extern INLINE int mailbox_set_timeout __P ((mailbox_t, int timeout));
extern INLINE int mailbox_get_refresh __P ((mailbox_t, int *refresh));
extern INLINE int mailbox_set_refresh __P ((mailbox_t, int refresh));
extern INLINE int mailbox_set_notification __P ((mailbox_t, int
(*notif) __P ((mailbox_t))));
#ifdef MU_USE_MACROS
#define mailbox_open(m, f) m->_open (m, f)
#define mailbox_close(m, f) m->_close (m, f)
/* type */
#define mailbox_get_name(m, t, d, o, n) m->_get_name (m, t, d, o, n)
#define mailbox_get_mtype(m, t, d, n) m->_get_mtype (m, t, d, n)
/* passwd */
#define mailbox_get_passwd(m, p, o, n) m->_get_passwd (m, p, o, n)
#define mailbox_get_mpasswd(m, p, n) m->_get_mpasswd (m, p, n)
#define mailbox_set_passwd(m, p, o, n) m->_set_passwd (m, p, o, n)
/* deleting */
#define mailbox_delete(m, id) m->_delete (m, id)
#define mailbox_undelete(m, id) m->_undelete (m, id)
#define mailbox_is_deleted(m, id) m->_is_deleted (m, id)
#define mailbox_expunge(m) m->_expunge (m)
/* appending */
#define mailbox_new_msg(m, id) m->_new_msg (m, id)
#define mailbox_set_header(m, id, h, o, n, r) m->_set_header(m, id, h, o, n, r)
#define mailbox_set_body(m, id, b, o, n, r) m->_set_body (m, id, b, o, n, r)
#define mailbox_append(m, id) m->_append (m, id)
#define mailbox_destroy_msg(m, id) m->_destroy_msg (m, id)
/* locking */
#define mailbox_lock(m, f) m->_lock (m, f)
#define mailbox_unlock(m) m->_unlock (m)
/* reading */
#define mailbox_get_header(m, id, h, o, n) m->_get_header (m, id, h, o, n)
#define mailbox_get_mheader(m, id, h, n) m->_get_header (m, id, h, n)
#define mailbox_get_body(m, id, b, o, n) m->_get_body (m, id, b, o, n)
#define mailbox_get_mbody(m, id, b, n) m->_get_body (m, id, b, n)
/* misc */
#define mailbox_scan(m, t) m->_scan (m, t)
#define mailbox_is_updated(m) m->_is_updated (m)
#define mailbox_get_timeout(m, t) m->_get_timeout (m, t)
#define mailbox_set_timeout(m, t) m->_set_timeout (m, t)
#define mailbox_get_refresh(m, r) m->_get_refresh (m, r)
#define mailbox_set_refresh(m, r) m->_set_refresh (m, r)
#define mailbox_set_notification(m, notif) m->_set_notification (m, notif)
#endif /* MU_USE_MACROS */
#ifdef __cplusplus
}
#endif
#endif /* _MAILBOX_H */