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

Annotation of /imapfilter/imapfilter.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.67.2.1 - (hide annotations)
Fri Aug 8 00:28:03 2003 UTC (20 years, 7 months ago) by lefcha
Branch: release-0_9-patches
Changes since 1.67: +3 -0 lines
File MIME type: text/plain
Corrected headers includes.

1 lefcha 1.9 #ifndef IMAPFILTER_H
2     #define IMAPFILTER_H
3    
4    
5 lefcha 1.67.2.1 #include <stdio.h>
6     #include <sys/types.h>
7    
8 lefcha 1.54 #include "config.h"
9 lefcha 1.65 #include "account.h"
10     #include "filter.h"
11 lefcha 1.54
12     #ifdef SSL_TLS
13     #include <openssl/ssl.h>
14     #endif
15    
16 lefcha 1.43
17 lefcha 1.11 /* Error codes returned by functions. */
18 lefcha 1.22 #define ERROR_SIGNAL 1
19     #define ERROR_TRIVIAL 2
20     #define ERROR_FILE_OPEN 3
21 lefcha 1.32 #define ERROR_LOCKFILE 4
22 lefcha 1.29 #define ERROR_CONFIG_PARSE 5
23     #define ERROR_MEMORY_ALLOCATION 6
24     #define ERROR_SETUID 7
25     #define ERROR_TERMIO 8
26     #define ERROR_NETWORK 9
27     #define ERROR_SSL 10
28     #define ERROR_PASSPHRASE 11
29     #define ERROR_ENCRYPT 12
30     #define ERROR_DECRYPT 13
31 lefcha 1.30 #define ERROR_FORK 14
32     #define ERROR_UNDEFINED 15
33 lefcha 1.9
34 lefcha 1.54 /* SSL/TLS certificate status for the server. */
35     #define SSL_CERT_OK 0
36     #define SSL_CERT_NONEXISTENT 1
37     #define SSL_CERT_MISMATCH 2
38    
39     /* Action to be applied, concerning the SSL/TLS certificate. */
40     #define SSL_CERT_ACTION_ACCEPT 0
41     #define SSL_CERT_ACTION_REJECT 1
42     #define SSL_CERT_ACTION_CONTINUE 0
43     #define SSL_CERT_ACTION_ABORT 1
44    
45 lefcha 1.30 /* Flags that control the program's execution options. */
46 lefcha 1.36 #define OPTION_DETAILS_QUIET 0x0001
47     #define OPTION_DETAILS_NORMAL 0x0002
48     #define OPTION_DETAILS_VERBOSE 0x0004
49     #define OPTION_DETAILS_CLEAR 0xfff8
50 lefcha 1.38 #define OPTION_ERRORS 0x0008
51     #define OPTION_EXPUNGE 0x0010
52     #define OPTION_HEADERS 0x0020
53     #define OPTION_NAMESPACE 0x0040
54     #define OPTION_SUBSCRIBE 0x0080
55 lefcha 1.58 #define OPTION_PASSWORD_EDITOR 0x0100
56     #define OPTION_DAEMON_MODE 0x0200
57 lefcha 1.30
58     /* Other flags. */
59 lefcha 1.54 #define FLAG_DAEMON_MODE 0x01
60     #define FLAG_TTY 0x02
61     #define FLAG_TTY_MODIFIED 0x04
62     #define FLAG_BLANK_PASSWORD 0x08
63 lefcha 1.67 #define FLAG_SIGUSR1_RECEIVED 0x10
64 lefcha 1.25
65     /* Capabilities of mail server. */
66     #define CAPABILITY_NONE 0x00
67     #define CAPABILITY_NAMESPACE 0x01
68 lefcha 1.61 #define CAPABILITY_AUTH_CRAM_MD5 0x02
69 lefcha 1.62 #define CAPABILITY_STARTTLS 0x04
70 lefcha 1.9
71 lefcha 1.12 /* Flags for logger. */
72 lefcha 1.55 #define LOG_PREAMBLE 0
73 lefcha 1.49 #define LOG_ACCOUNT 1
74     #define LOG_MAILBOX 2
75     #define LOG_FILTER 3
76     #define LOG_ACTION 4
77     #define LOG_DESTINATION_ACCOUNT 5
78 lefcha 1.12 #define LOG_DESTINATION_MAILBOX 6
79 lefcha 1.55 #define LOG_HEADER 7
80 lefcha 1.12
81 lefcha 1.35 /* Store IMAP command type may replace,add or remove flags. */
82     #define STORE_FLAG_REPLACE 1
83     #define STORE_FLAG_ADD 2
84     #define STORE_FLAG_REMOVE 3
85    
86 lefcha 1.9 /* Buffer size of server's response. */
87 lefcha 1.55 #define RESPONSE_BUF 4096
88 lefcha 1.20 #define RESULT_BUF 512
89 lefcha 1.9
90 lefcha 1.16 /* Response codes. */
91 lefcha 1.44 #define RESPONSE_NULLBODY -2
92     #define RESPONSE_NONE -1
93 lefcha 1.16 #define RESPONSE_OK 0
94     #define RESPONSE_NO 1
95 lefcha 1.44 #define RESPONSE_BAD 2
96     #define RESPONSE_BYE 3
97     #define RESPONSE_PREAUTH 4
98     #define RESPONSE_READONLY 5
99     #define RESPONSE_TRYCREATE 6
100 lefcha 1.16
101 lefcha 1.26 /* Encryption and decryption buffers. */
102     #define ENCRYPTION_BUF 1024
103     #define DECRYPTION_BUF 4096
104    
105 lefcha 1.35 /* Buffer to save flags of the store IMAP command. */
106     #define STORE_FLAGS_BUF 64
107    
108 lefcha 1.47 /* Lenght of charset for IMAP SEARCH requests. */
109     #define CHARSET_LEN 64
110    
111 lefcha 1.65 /* String lengths of master password and encrypted passwords. */
112     #define PASSPHRASE_LEN 256
113    
114     /* Length of mailbox namespace prefix. */
115     #define NAMESPACE_PREFIX_LEN 64
116    
117 lefcha 1.1
118     #define min(A, B) ((A) < (B) ? (A) : (B))
119 lefcha 1.15 #define plural(A) ((A) == 1 ? "" : "s")
120 lefcha 1.1
121    
122 lefcha 1.64 /* IMAP connection. */
123     typedef struct conn {
124     int sock; /* Socket. */
125     #ifdef SSL_TLS
126     SSL *ssl; /* SSL socket. */
127     #endif
128     unsigned int caps; /* Capabilities of the mail server. */
129 lefcha 1.65 struct { /* Namespace of the mail server's mailboxes. */
130     char prefix[NAMESPACE_PREFIX_LEN]; /* Namespace prefix. */
131     char delim; /* Namespace delimiter. */
132     } nsp;
133 lefcha 1.64 } conn_t;
134    
135    
136 lefcha 1.65 /* action.c */
137     int apply_action(char *mbox, char *mesgs, unsigned int *type, account_t * raccount, char *destmbox, unsigned int *msgflags, char *args);
138    
139 lefcha 1.61 /* auth.c */
140 lefcha 1.62 #ifdef CRAM_MD5
141 lefcha 1.65 int auth_cram_md5(conn_t * conn, char *user, char *pass);
142     #endif
143 lefcha 1.61
144 lefcha 1.65 /* cert.c */
145     #ifdef SSL_TLS
146     int get_cert(conn_t * conn);
147 lefcha 1.62 #endif
148    
149 lefcha 1.65 /* destroy.c */
150     void destroy_all(void);
151     void destroy_unneeded(void);
152 lefcha 1.63
153 lefcha 1.9 /* file.c */
154 lefcha 1.25 int create_homedir(void);
155 lefcha 1.26 int exists_file(char *fname);
156     int exists_dir(char *fname);
157 lefcha 1.25 int create_file(char *fname, mode_t mode);
158 lefcha 1.9 #ifdef CHECK_PERMISSIONS
159 lefcha 1.25 int check_file_perms(char *fname, mode_t mode);
160     int check_dir_perms(char *dname, mode_t mode);
161 lefcha 1.54 #endif
162    
163 lefcha 1.9 /* imap.c */
164     #ifdef DEBUG
165 lefcha 1.64 int imap_noop(conn_t * conn);
166 lefcha 1.9 #endif
167 lefcha 1.64 int imap_capability(conn_t * conn);
168     int imap_namespace(conn_t * conn);
169     int imap_logout(conn_t * conn);
170 lefcha 1.62 #ifdef SSL_TLS
171 lefcha 1.64 int imap_starttls(conn_t * conn);
172 lefcha 1.62 #endif
173 lefcha 1.64 int imap_authenticate(conn_t * conn, char *auth, int cont);
174     int imap_login(conn_t * conn, char *user, char *pass);
175     /* int imap_list(conn_t *conn, char *refer, char *mbox); */
176     int imap_subscribe(conn_t * conn, char *mbox);
177     /* int imap_examine(conn_t *conn, char *mbox); */
178     int imap_select(conn_t * conn, char *mbox);
179     int imap_status(conn_t * conn, char *mbox, char *items);
180     int imap_create(conn_t * conn, char *mbox);
181     int imap_search(conn_t * conn, char *charset, char *search);
182     int imap_fetch(conn_t * conn, char *mesg, char *items);
183     int imap_store(conn_t * conn, char *mesg, unsigned int mode, char *flags);
184     int imap_copy(conn_t * conn, char *mesg, char *mbox);
185     int imap_append(conn_t * conn, char *mbox, unsigned int size);
186     int imap_close(conn_t * conn);
187     int imap_expunge(conn_t * conn);
188 lefcha 1.29
189     /* lock.c */
190     void lockfile_create(void);
191     void lockfile_check(void);
192     int lockfile_remove(void);
193 lefcha 1.30 void kill_imapfilter(void);
194 lefcha 1.9
195     /* log.c */
196 lefcha 1.13 void info(const char *info,...);
197     void verbose(const char *info,...);
198     void error(const char *errmsg,...);
199     void fatal(unsigned int errnum, const char *fatal,...);
200 lefcha 1.22 void catch_signals(void);
201 lefcha 1.9 int open_logfile(void);
202     int close_logfile(void);
203 lefcha 1.12 void log_info(int flag, void *ptr);
204 lefcha 1.65
205     /* match.c */
206     int apply_filters(char *mbox, filter_t ** filters);
207 lefcha 1.9
208 lefcha 1.13 /* memory.c */
209     void *xmalloc(size_t size);
210 lefcha 1.19 void *xrealloc(void *ptr, size_t size);
211 lefcha 1.26 void xfree(void *ptr);
212 lefcha 1.13 char *xstrdup(const char *s);
213    
214 lefcha 1.27 void *smalloc(size_t size);
215     void *srealloc(void *ptr, size_t size);
216     void sfree(void *ptr);
217     char *sstrdup(const char *s);
218     void secmem_clear(void);
219 lefcha 1.49
220 lefcha 1.27 void corefile_disable(void);
221    
222 lefcha 1.16 /* misc.c */
223     char *strcasestr(const char *haystack, const char *needle);
224     char *ultostr(unsigned long int num, int base);
225 lefcha 1.24 char *xstrncpy(char *dest, const char *src, size_t size);
226 lefcha 1.16
227 lefcha 1.65 /* parse.c */
228     int read_config(char *cfg);
229     void reread_config(char *cfg);
230     int read_passwords(void);
231    
232 lefcha 1.25 /* passwd.c */
233 lefcha 1.26 void get_password(char *passwd, size_t pwlen);
234     #ifdef ENCRYPTED_PASSWORDS
235 lefcha 1.60 int encrypt_passwords(FILE * fd, account_t ** accts);
236 lefcha 1.34 int decrypt_passwords(unsigned char **buf, FILE * fd);
237 lefcha 1.26 void password_editor(void);
238     #endif
239 lefcha 1.25
240 lefcha 1.9 /* request.c */
241 lefcha 1.64 int test(conn_t * conn);
242     int check_capabilities(conn_t * conn);
243     int check_namespace(conn_t * conn);
244 lefcha 1.62 #ifdef SSL_TLS
245 lefcha 1.65 int negotiate_tls(conn_t * conn);
246 lefcha 1.62 #endif
247 lefcha 1.64 int login(conn_t * conn, char *user, char *pass);
248     int check_mailbox(conn_t * conn, char *mbox);
249     int select_mailbox(conn_t * conn, char *mbox);
250     int mailbox_status(conn_t * conn, char *mbox);
251     int close_mailbox(conn_t * conn);
252     int logout(conn_t * conn);
253 lefcha 1.9
254 lefcha 1.65 /* response.c */
255 lefcha 1.64 int server_response(conn_t * conn, unsigned int tag);
256     int greeting_response(conn_t * conn);
257     int logout_response(conn_t * conn, unsigned int tag);
258     int capability_response(conn_t * conn, unsigned int tag);
259     int authenticate_response(conn_t * conn, unsigned int tag, unsigned char **cont);
260     int namespace_response(conn_t * conn, unsigned int tag);
261     int status_response(conn_t * conn, unsigned int tag, char *mbox);
262     int select_response(conn_t * conn, unsigned int tag);
263     int search_response(conn_t * conn, unsigned int tag, char **mesgs);
264     int fetch_response(conn_t * conn, unsigned int tag, int reset, char *fetch);
265     int fetchsize_response(conn_t * conn, unsigned int *size, unsigned int tag);
266     int append_response(conn_t * conn, unsigned int tag);
267     int copy_response(conn_t * conn, unsigned int tag);
268 lefcha 1.25
269     /* socket.c */
270 lefcha 1.64 int init_connection(conn_t * conn, char *serv, unsigned short int port, unsigned int protocol);
271 lefcha 1.62 #ifdef SSL_TLS
272 lefcha 1.65 int init_secure_connection(conn_t * conn, unsigned int protocol);
273 lefcha 1.62 #endif
274 lefcha 1.64 int close_connection(conn_t * conn);
275     int socket_read(conn_t * conn, char *buf);
276     int socket_write(conn_t * conn, char *data);
277 lefcha 1.25
278     /* tty.c */
279     int tty_store(void);
280     int tty_disable_echo(void);
281     int tty_restore(void);
282 lefcha 1.65
283 lefcha 1.11
284 lefcha 1.13 #endif /* IMAPFILTER_H */

webmaster@linux.gr
ViewVC Help
Powered by ViewVC 1.1.26