/[imapfilter]/imapfilter/imapfilter.h
ViewVC logotype

Contents of /imapfilter/imapfilter.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.34 - (show annotations)
Sat Jul 13 14:11:08 2002 UTC (21 years, 8 months ago) by lefcha
Branch: MAIN
Changes since 1.33: +20 -19 lines
File MIME type: text/plain
Added variable to enable direct expunge of marked deleted mail.

1 #ifndef IMAPFILTER_H
2 #define IMAPFILTER_H
3
4 #include <stdio.h>
5 #include <unistd.h>
6 #include <sys/stat.h>
7 #include <sys/types.h>
8 #include <dirent.h>
9
10 #ifndef DATA_H
11 #include "data.h"
12 #endif
13
14 /* Error codes returned by functions. */
15 #define ERROR_SIGNAL 1
16 #define ERROR_TRIVIAL 2
17 #define ERROR_FILE_OPEN 3
18 #define ERROR_LOCKFILE 4
19 #define ERROR_CONFIG_PARSE 5
20 #define ERROR_MEMORY_ALLOCATION 6
21 #define ERROR_SETUID 7
22 #define ERROR_TERMIO 8
23 #define ERROR_NETWORK 9
24 #define ERROR_SSL 10
25 #define ERROR_PASSPHRASE 11
26 #define ERROR_ENCRYPT 12
27 #define ERROR_DECRYPT 13
28 #define ERROR_FORK 14
29 #define ERROR_UNDEFINED 15
30
31 /* Flags that control the program's execution options. */
32 #define OPTION_DETAILS_QUIET 0x01
33 #define OPTION_DETAILS_NORMAL 0x02
34 #define OPTION_DETAILS_VERBOSE 0x04
35 #define OPTION_DETAILS_CLEAR 0xf8
36 #define OPTION_HEADERS 0x08
37 #define OPTION_NAMESPACE 0x10
38 #define OPTION_EXPUNGE 0x20
39 #define OPTION_PASSWORD_EDITOR 0x40
40 #define OPTION_DAEMON_MODE 0x80
41
42 /* Other flags. */
43 #define FLAG_TTY_MODIFIED 0x01
44 #define FLAG_BLANK_PASSWORD 0x02
45
46 /* Capabilities of mail server. */
47 #define CAPABILITY_NONE 0x00
48 #define CAPABILITY_NAMESPACE 0x01
49
50 /* Flags for logger. */
51 #define LOG_WRITE 0
52 #define LOG_SERVER 1
53 #define LOG_USERNAME 2
54 #define LOG_MAILBOX 3
55 #define LOG_FILTER 4
56 #define LOG_ACTION 5
57 #define LOG_DESTINATION_MAILBOX 6
58
59 /* Buffer size of the IMAP command. */
60 #define SMALL_CMD 64
61 #define MEDIUM_CMD 512
62 #define BIG_CMD 32768
63
64 /* Buffer size of server's response. */
65 #define RESPONSE_BUF (4096 + 1)
66 #define RESULT_BUF 512
67
68 /* Response codes. */
69 #define RESPONSE_NONE -2
70 #define RESPONSE_BAD -1
71 #define RESPONSE_OK 0
72 #define RESPONSE_NO 1
73 #define RESPONSE_BYE 2
74 #define RESPONSE_PREAUTH 3
75 #define RESPONSE_READONLY 4
76 #define RESPONSE_TRYCREATE 5
77
78 /* Buffer size of message's headers. */
79 #define HEADERS_BUF 16384
80
81 /* Length of mailbox namespace prefix. */
82 #define NAMESPACE_PREFIX_LEN 64
83
84 /* Encryption and decryption buffers. */
85 #define ENCRYPTION_BUF 1024
86 #define DECRYPTION_BUF 4096
87
88 /* Maximum passwords the password editor can handle. */
89 #define EDITOR_PASSWORDS_MAX 64
90
91
92 #define min(A, B) ((A) < (B) ? (A) : (B))
93 #define plural(A) ((A) == 1 ? "" : "s")
94
95
96 /* Secure memory information. */
97 typedef struct secmem {
98 void *buf; /* Allocated memory buffer. */
99 size_t size; /* Size of the buffer. */
100 struct secmem *prev, *next; /* Previous/next node of doubly linked list. */
101 } secmem_t;
102
103
104 /* Namespace of IMAP mailboxes. */
105 typedef struct namesp {
106 char prefix[NAMESPACE_PREFIX_LEN];
107 char delim;
108 } namesp_t;
109
110
111 /* file.c */
112 int read_config(char *cfg);
113 int parse_config(FILE * fd);
114 void set_options(char *line, regmatch_t * match);
115
116 int read_passwords(void);
117 int parse_passwords(FILE * fd);
118 int store_passwords(account_t * accts[]);
119
120 int create_homedir(void);
121 int exists_file(char *fname);
122 int exists_dir(char *fname);
123 int create_file(char *fname, mode_t mode);
124 #ifdef CHECK_PERMISSIONS
125 int check_file_perms(char *fname, mode_t mode);
126 int check_dir_perms(char *dname, mode_t mode);
127 #endif
128
129 /* imapfilter.c */
130 void usage(void);
131
132 /* imap.c */
133 unsigned int send_command(int *sock, char *cmd);
134 #ifdef DEBUG
135 int imap_noop(int *sock);
136 #endif
137 int imap_capability(int *sock);
138 int imap_namespace(int *sock);
139 int imap_logout(int *sock);
140 int imap_login(int *sock, char *user, char *pass);
141 /* int imap_list(int *sock, char *refer, char *mbox); */
142 int imap_subscribe(int *sock, char *mbox);
143 int imap_examine(int *sock, char *mbox);
144 int imap_select(int *sock, char *mbox);
145 int imap_status(int *sock, char *mbox, char *items);
146 int imap_create(int *sock, char *mbox);
147 int imap_search(int *sock, char *search);
148 int imap_fetch(int *sock, char *mesg, char *items);
149 int imap_store(int *sock, char *mesg, char *flags);
150 int imap_copy(int *sock, char *mesg, char *mbox);
151 int imap_append(int *sock, char *mbox, unsigned int size);
152 int imap_close(int *sock);
153 int imap_expunge(int *sock);
154
155 /* lock.c */
156 void lockfile_create(void);
157 void lockfile_check(void);
158 pid_t lockfile_pid(void);
159 int lockfile_remove(void);
160 void kill_imapfilter(void);
161
162 /* log.c */
163 void info(const char *info,...);
164 void verbose(const char *info,...);
165 void error(const char *errmsg,...);
166 void fatal(unsigned int errnum, const char *fatal,...);
167 void catch_signals(void);
168 void signal_handler(int sig);
169 int open_logfile(void);
170 int create_logfile(void);
171 int close_logfile(void);
172 void log_info(int flag, void *ptr);
173 char *get_time(void);
174
175 /* memory.c */
176 void *xmalloc(size_t size);
177 void *xrealloc(void *ptr, size_t size);
178 void xfree(void *ptr);
179 char *xstrdup(const char *s);
180
181 void *smalloc(size_t size);
182 void *srealloc(void *ptr, size_t size);
183 void sfree(void *ptr);
184 char *sstrdup(const char *s);
185 void secmem_append(secmem_t * node);
186 secmem_t *secmem_find(void *ptr);
187 void secmem_remove(secmem_t * node);
188 void secmem_clear(void);
189 void secmem_lock(void);
190
191 void corefile_disable(void);
192
193 /* misc.c */
194 char *strcasestr(const char *haystack, const char *needle);
195 char *ultostr(unsigned long int num, int base);
196 char *xstrncpy(char *dest, const char *src, size_t size);
197
198 /* passwd.c */
199 void get_password(char *passwd, size_t pwlen);
200 #ifdef ENCRYPTED_PASSWORDS
201 int encrypt_passwords(FILE * fd, account_t * accts[]);
202 int decrypt_passwords(unsigned char **buf, FILE * fd);
203 void password_editor(void);
204 #endif
205
206 /* request.c */
207 int test(int *sock);
208 int check_capabilities(int *sock);
209 int check_namespace(int *sock, namesp_t * nsp);
210 int login(int *sock, char *user, char *pass);
211 int check_mailbox(int *sock, char *mbox, namesp_t * nsp);
212 int select_mailbox(int *sock, char *mbox, namesp_t * nsp);
213 int mailbox_status(int *sock, char *mbox, namesp_t * nsp);
214 int close_mailbox(int *sock);
215 int logout(int *sock);
216
217 int apply_filters(filter_t ** filters);
218 int match_filter(filter_t * filter, char **mesgs);
219
220 void empty_fifo(mask_t ** mfifo);
221 void queue_fifo(mask_t ** mfifo, mask_t * mask);
222 mask_t *dequeue_fifo(mask_t ** mfifo);
223
224 char *generate_filter_and(mask_t * mask, unsigned int masknum,
225 unsigned int masklen);
226 char *generate_filter_or(mask_t * mask, unsigned int masknum,
227 unsigned int masklen);
228
229 int apply_action(char *mesgs, unsigned int *type, account_t * raccount,
230 char *destmbox, char *args);
231 int action_delete(char *mesgs, char *args);
232 int action_copy(char *mesgs, char *destmbox, char *args);
233 int action_move(char *mesgs, char *destmbox, char *args);
234 int action_rcopy(char *mesgs, account_t * destacc, char *destmbox, char *args);
235 int action_rmove(char *mesgs, account_t * destacc, char *destmbox, char *args);
236 int action_list(char *mesgs, char *args);
237
238 unsigned int count_messages(char *mesgs);
239 char *convert_messages(char *mesgs);
240
241
242 /* response.c */
243 void receive_response(int *sock, char *buf);
244 int server_response(int *sock, unsigned int tag);
245 int greeting_response(int *sock);
246 int capability_response(int *sock, unsigned int tag);
247 int namespace_response(int *sock, unsigned int tag, namesp_t * nsp);
248 int status_response(int *sock, unsigned int tag, char *mbox);
249 int select_response(int *sock, unsigned int tag);
250 int search_response(int *sock, unsigned int tag, char **mesgs);
251 int fetch_response(int *sock, int reset, char *fetch, unsigned int tag);
252 int fetchsize_response(int *sock, unsigned int *size, unsigned int tag);
253 int append_response(int *sock, unsigned int tag);
254 int copy_response(int *sock, unsigned int tag);
255 int analyze_response(char *buf);
256 void init_vbuf(void);
257 void reset_vbuf(void);
258 void check_vbuf(size_t n);
259
260 /* socket.c */
261 int init_connection(int *sock, char *serv, unsigned short int port,
262 unsigned int protocol);
263 int ssl_init(int *sock, unsigned int protocol);
264 int close_connection(int *sock);
265 int socket_read(int *sock, char *buf);
266 int socket_write(int *sock, char *data);
267
268 /* tty.c */
269 int tty_store(void);
270 int tty_disable_echo(void);
271 int tty_restore(void);
272
273 #endif /* IMAPFILTER_H */

webmaster@linux.gr
ViewVC Help
Powered by ViewVC 1.1.26