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

Annotation of /imapfilter/imapfilter.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.36 - (hide annotations)
Sat Jul 13 22:33:01 2002 UTC (21 years, 8 months ago) by lefcha
Branch: MAIN
Changes since 1.35: +10 -9 lines
File MIME type: text/plain
Added variable that controls subsribing after mailbox creation.

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

webmaster@linux.gr
ViewVC Help
Powered by ViewVC 1.1.26