497589023abd0e9110ecf71687be028abd22c255
[exim.git] / src / src / macros.h
1 /* $Cambridge: exim/src/src/macros.h,v 1.23 2006/02/14 14:55:37 ph10 Exp $ */
2
3 /*************************************************
4 * Exim - an Internet mail transport agent *
5 *************************************************/
6
7 /* Copyright (c) University of Cambridge 1995 - 2006 */
8 /* See the file NOTICE for conditions of use and distribution. */
9
10
11 /* These two macros make it possible to obtain the result of macro-expanding
12 a string as a text string. This is sometimes useful for debugging output. */
13
14 #define mac_string(s) # s
15 #define mac_expanded_string(s) mac_string(s)
16
17
18 /* The address_item structure has a word full of 1-bit flags. These macros
19 manipulate them. */
20
21 #define setflag(addr,flag) addr->flags |= (flag)
22 #define clearflag(addr,flag) addr->flags &= ~(flag)
23
24 #define testflag(addr,flag) ((addr->flags & (flag)) != 0)
25 #define testflagsall(addr,flag) ((addr->flags & (flag)) == (flag))
26
27 #define copyflag(addrnew,addrold,flag) \
28 addrnew->flags = (addrnew->flags & ~(flag)) | (addrold->flags & (flag))
29
30 #define orflag(addrnew,addrold,flag) \
31 addrnew->flags |= addrold->flags & (flag)
32
33
34 /* For almost all calls to convert things to printing characters, we want to
35 allow tabs. A macro just makes life a bit easier. */
36
37 #define string_printing(s) string_printing2((s), TRUE)
38
39
40 /* We need a special return code for "no recipients and failed to send an error
41 message". ANSI C defines only EXIT_FAILURE and EXIT_SUCCESS. On the assumption
42 that these are always 1 and 0 on Unix systems ... */
43
44 #define EXIT_NORECIPIENTS 2
45
46
47 /* Character-handling macros. It seems that the set of standard functions in
48 ctype.h aren't actually all that useful. One reason for this is that email is
49 international, so the concept of using a locale to vary what they do is not
50 helpful. Another problem is that in different operating systems, the libraries
51 yield different results, even in the default locale. For example, Linux yields
52 TRUE for iscntrl() for all characters > 127, whereas many other systems yield
53 FALSE. For these reasons we define our own set of macros for a number of
54 character testing functions. Ensure that all these tests treat their arguments
55 as unsigned. */
56
57 #define mac_iscntrl(c) \
58 ((uschar)(c) < 32 || (uschar)(c) == 127)
59
60 #define mac_iscntrl_or_special(c) \
61 ((uschar)(c) < 32 || strchr(" ()<>@,;:\\\".[]\177", (uschar)(c)) != NULL)
62
63 #define mac_isgraph(c) \
64 ((uschar)(c) > 32 && (uschar)(c) != 127)
65
66 #define mac_isprint(c) \
67 (((uschar)(c) >= 32 && (uschar)(c) <= 126) || c == '\t' || \
68 ((uschar)(c) > 127 && print_topbitchars))
69
70
71 /* When built with TLS support, the act of flushing SMTP output becomes
72 a no-op once an SSL session is in progress. */
73
74 #ifdef SUPPORT_TLS
75 #define mac_smtp_fflush() if (tls_active < 0) fflush(smtp_out);
76 #else
77 #define mac_smtp_fflush() fflush(smtp_out);
78 #endif
79
80
81 /* Define which ends of pipes are for reading and writing, as some systems
82 don't make the file descriptors two-way. */
83
84 #define pipe_read 0
85 #define pipe_write 1
86
87 /* The RFC 1413 ident port */
88
89 #define IDENT_PORT 113
90
91 /* A macro to simplify testing bits in lookup types */
92
93 #define mac_islookup(a,b) ((lookup_list[a].type & (b)) != 0)
94
95 /* Debugging control */
96
97 #define DEBUG(x) if ((debug_selector & (x)) != 0)
98 #define HDEBUG(x) if (host_checking || (debug_selector & (x)) != 0)
99
100 /* The size of the vector for saving/restoring address expansion pointers while
101 verifying. This has to be explicit because it is referenced in more than one
102 source module. */
103
104 #define ADDRESS_EXPANSIONS_COUNT 18
105
106 /* The maximum permitted number of command-line (-D) macro definitions. We
107 need a limit only to make it easier to generate argument vectors for re-exec
108 of Exim. */
109
110 #define MAX_CLMACROS 10
111
112 /* The number of integer variables available in filter files. If this is
113 changed, then the tables in expand.c for accessing them must be changed too. */
114
115 #define FILTER_VARIABLE_COUNT 10
116
117 /* The size of the vector holding delay warning times */
118
119 #define DELAY_WARNING_SIZE 12
120
121 /* The size of the buffer holding the processing information string. */
122
123 #define PROCESS_INFO_SIZE 256
124
125 /* The size of buffer to get for constructing log entries. Make it big
126 enough to hold all the headers from a normal kind of message. */
127
128 #define LOG_BUFFER_SIZE 8192
129
130 /* The initial size of a big buffer for use in various places. It gets put
131 into big_buffer_size and in some circumstances increased. It should be at least
132 as long as the maximum path length. */
133
134 #if defined PATH_MAX && PATH_MAX > 16384
135 #define BIG_BUFFER_SIZE PATH_MAX
136 #elif defined MAXPATHLEN && MAXPATHLEN > 16384
137 #define BIG_BUFFER_SIZE MAXPATHLEN
138 #else
139 #define BIG_BUFFER_SIZE 16384
140 #endif
141
142 /* This limits the length of data returned by local_scan(). Because it is
143 written on the spool, it gets read into big_buffer. */
144
145 #define LOCAL_SCAN_MAX_RETURN (BIG_BUFFER_SIZE - 24)
146
147 /* A limit to the length of an address. RFC 2821 limits the local part to 64
148 and the domain to 255, so this should be adequate, taking into account quotings
149 etc. */
150
151 #define ADDRESS_MAXLENGTH 512
152
153 /* The length of the base names of spool files, which consist of an internal
154 message id with a trailing "-H" or "-D" added. */
155
156 #define SPOOL_NAME_LENGTH (MESSAGE_ID_LENGTH+2)
157
158 /* The maximum number of message ids to store in a waiting database
159 record. */
160
161 #define WAIT_NAME_MAX 50
162
163 /* Fixed option values for all PCRE functions */
164
165 #define PCRE_COPT 0 /* compile */
166 #define PCRE_EOPT 0 /* exec */
167
168 /* Macros for trivial functions */
169
170 #define mac_ismsgid(s) \
171 (pcre_exec(regex_ismsgid,NULL,CS s,Ustrlen(s),0,PCRE_EOPT,NULL,0) >= 0)
172
173
174 /* Options for dns_next_rr */
175
176 enum { RESET_NEXT, RESET_ANSWERS, RESET_AUTHORITY, RESET_ADDITIONAL };
177
178 /* Argument values for the time-of-day function */
179
180 enum { tod_log, tod_log_bare, tod_log_zone, tod_log_datestamp,
181 tod_zone, tod_full, tod_bsdin, tod_mbx, tod_epoch, tod_zulu };
182
183 /* For identifying types of driver */
184
185 enum {
186 DTYPE_NONE,
187 DTYPE_ROUTER,
188 DTYPE_TRANSPORT
189 };
190
191 /* Error numbers for generating error messages when reading a message on the
192 standard input. */
193
194 enum {
195 ERRMESS_BADARGADDRESS, /* Bad address via argument list */
196 ERRMESS_BADADDRESS, /* Bad address read via -t */
197 ERRMESS_NOADDRESS, /* Message has no addresses */
198 ERRMESS_IGADDRESS, /* All -t addresses ignored */
199 ERRMESS_BADNOADDRESS, /* Bad address via -t, leaving none */
200 ERRMESS_IOERR, /* I/O error while reading a message */
201 ERRMESS_VLONGHEADER, /* Excessively long message header */
202 ERRMESS_VLONGHDRLINE, /* Excessively long single line in header */
203 ERRMESS_TOOBIG, /* Message too big */
204 ERRMESS_TOOMANYRECIP, /* Too many recipients */
205 ERRMESS_LOCAL_SCAN, /* Rejected by local scan */
206 ERRMESS_LOCAL_ACL /* Rejected by non-SMTP ACL */
207 };
208
209 /* Error handling styles - set by option, and apply only when receiving
210 a local message not via SMTP. */
211
212 enum {
213 ERRORS_SENDER, /* Return to sender (default) */
214 ERRORS_STDERR /* Write on stderr */
215 };
216
217 /* Exec control values when Exim execs itself via child_exec_exim. */
218
219 enum {
220 CEE_RETURN_ARGV, /* Don't exec, just build and return argv */
221 CEE_EXEC_EXIT, /* Just exit if exec fails */
222 CEE_EXEC_PANIC /* Panic-die if exec fails */
223 };
224
225 /* Bit values for filter_test */
226
227 #define FTEST_NONE 0 /* Not filter testing */
228 #define FTEST_USER 1 /* Testing user filter */
229 #define FTEST_SYSTEM 2 /* Testing system filter */
230
231 /* Returns from the routing, transport and authentication functions (not all
232 apply to all of them). Some other functions also use these convenient values,
233 and some additional values are used only by non-driver functions.
234
235 OK, FAIL, DEFER, ERROR, and FAIL_FORCED are also declared in local_scan.h for
236 use in the local_scan() function and in ${dlfunc loaded functions. Do not
237 change them unilaterally. */
238
239 #define OK 0 /* Successful match */
240 #define DEFER 1 /* Defer - some problem */
241 #define FAIL 2 /* Matching failed */
242 #define ERROR 3 /* Internal or config error */
243 #define FAIL_FORCED 4 /* "Forced" failure */
244 /***********/
245 #define DECLINE 5 /* Declined to handle the address, pass to next
246 router unless no_more is set */
247 #define PASS 6 /* Pass to next driver, or to pass_router,
248 even if no_more is set */
249 #define DISCARD 7 /* Address routed to :blackhole: or "seen finish" */
250 #define SKIP 8 /* Skip this router (used in route_address only) */
251 #define REROUTED 9 /* Address was changed and child created*/
252 #define PANIC 10 /* Hard failed with internal error */
253 #define BAD64 11 /* Bad base64 data (auth) */
254 #define UNEXPECTED 12 /* Unexpected initial auth data */
255 #define CANCELLED 13 /* Authentication cancelled */
256 #define FAIL_SEND 14 /* send() failed in authenticator */
257 #define FAIL_DROP 15 /* Fail and drop connection (used in ACL) */
258
259 /* Returns from the deliver_message() function */
260
261 #define DELIVER_ATTEMPTED_NORMAL 0 /* Tried a normal delivery */
262 #define DELIVER_MUA_SUCCEEDED 1 /* Success when mua_wrapper is set */
263 #define DELIVER_MUA_FAILED 2 /* Failure when mua_wrapper is set */
264 #define DELIVER_NOT_ATTEMPTED 3 /* Not tried (no msg or is locked */
265
266 /* Returns from DNS lookup functions. */
267
268 enum { DNS_SUCCEED, DNS_NOMATCH, DNS_NODATA, DNS_AGAIN, DNS_FAIL };
269
270 /* Ending states when reading a message. The order is important. The test
271 for having to swallow the rest of an SMTP message is whether the value is
272 >= END_NOTENDED. */
273
274 #define END_NOTSTARTED 0 /* Message not started */
275 #define END_DOT 1 /* Message ended with '.' */
276 #define END_EOF 2 /* Message ended with EOF (error for SMTP) */
277 #define END_NOTENDED 3 /* Message reading not yet ended */
278 #define END_SIZE 4 /* Reading ended because message too big */
279 #define END_WERROR 5 /* Write error while reading the message */
280
281 /* Options bits for debugging; D_v and D_local_scan are also in local_scan.h */
282
283 #define D_v 0x00000001
284 #define D_local_scan 0x00000002
285
286 #define D_acl 0x00000004
287 #define D_auth 0x00000008
288 #define D_deliver 0x00000010
289 #define D_dns 0x00000020
290 #define D_dnsbl 0x00000040
291 #define D_exec 0x00000080
292 #define D_expand 0x00000100
293 #define D_filter 0x00000200
294 #define D_hints_lookup 0x00000400
295 #define D_host_lookup 0x00000800
296 #define D_ident 0x00001000
297 #define D_interface 0x00002000
298 #define D_lists 0x00004000
299 #define D_load 0x00008000
300 #define D_lookup 0x00010000
301 #define D_memory 0x00020000
302 #define D_pid 0x00040000
303 #define D_process_info 0x00080000
304 #define D_queue_run 0x00100000
305 #define D_receive 0x00200000
306 #define D_resolver 0x00400000
307 #define D_retry 0x00800000
308 #define D_rewrite 0x01000000
309 #define D_route 0x02000000
310 #define D_timestamp 0x04000000
311 #define D_tls 0x08000000
312 #define D_transport 0x10000000
313 #define D_uid 0x20000000
314 #define D_verify 0x40000000
315
316 /* The D_all value must always have all bits set, as it is recognized specially
317 by the function that decodes debug and log selectors. This is to enable it to
318 set all the bits in a multi-word selector. Debug doesn't use this yet, but we
319 are getting close. In fact, we want to omit "memory" for -d+all, but can't
320 handle this here. It is fudged externally. */
321
322 #define D_all 0xffffffff
323
324 #define D_any (D_all & \
325 ~(D_v | \
326 D_pid | \
327 D_timestamp) )
328
329 #define D_default (0xffffffff & \
330 ~(D_expand | \
331 D_filter | \
332 D_interface | \
333 D_load | \
334 D_local_scan | \
335 D_memory | \
336 D_pid | \
337 D_timestamp | \
338 D_resolver))
339
340 /* Options bits for logging. Those that will end up in log_write_selector have
341 values < 0x80000000. They can be used in calls to log_write(). The others have
342 values > 0x80000000 and are put into log_extra_selector (without the top bit).
343 These are only ever tested independently. "All" is a magic value that is used
344 only in the name table to set all options in both bit maps. */
345
346 /* The L_all value must always have all bits set, as it is recognized specially
347 by the function that decodes debug and log selectors. This is to enable it to
348 set all the bits in a multi-word selector. */
349
350 #define L_all 0xffffffff
351
352 #define L_address_rewrite 0x00000001
353 #define L_all_parents 0x00000002
354 #define L_connection_reject 0x00000004
355 #define L_delay_delivery 0x00000008
356 #define L_dnslist_defer 0x00000010
357 #define L_etrn 0x00000020
358 #define L_host_lookup_failed 0x00000040
359 #define L_lost_incoming_connection 0x00000080
360 #define L_queue_run 0x00000100
361 #define L_retry_defer 0x00000200
362 #define L_size_reject 0x00000400
363 #define L_skip_delivery 0x00000800
364 #define L_smtp_connection 0x00001000
365 #define L_smtp_incomplete_transaction 0x00002000
366 #define L_smtp_protocol_error 0x00004000
367 #define L_smtp_syntax_error 0x00008000
368
369 #define LX_acl_warn_skipped 0x80000001
370 #define LX_arguments 0x80000002
371 #define LX_deliver_time 0x80000004
372 #define LX_delivery_size 0x80000008
373 #define LX_ident_timeout 0x80000010
374 #define LX_incoming_interface 0x80000020
375 #define LX_incoming_port 0x80000040
376 #define LX_outgoing_port 0x80000080
377 #define LX_queue_time 0x80000100
378 #define LX_queue_time_overall 0x80000200
379 #define LX_received_sender 0x80000400
380 #define LX_received_recipients 0x80000800
381 #define LX_rejected_header 0x80001000
382 #define LX_return_path_on_delivery 0x80002000
383 #define LX_sender_on_delivery 0x80004000
384 #define LX_sender_verify_fail 0x80008000
385 #define LX_smtp_confirmation 0x80010000
386 #define LX_subject 0x80020000
387 #define LX_tls_certificate_verified 0x80040000
388 #define LX_tls_cipher 0x80080000
389 #define LX_tls_peerdn 0x80100000
390 #define LX_unknown_in_list 0x80200000
391
392 #define L_default (L_connection_reject | \
393 L_delay_delivery | \
394 L_dnslist_defer | \
395 L_etrn | \
396 L_host_lookup_failed | \
397 L_lost_incoming_connection | \
398 L_queue_run | \
399 L_retry_defer | \
400 L_size_reject | \
401 L_skip_delivery)
402
403 #define LX_default ((LX_acl_warn_skipped | \
404 LX_rejected_header | \
405 LX_sender_verify_fail | \
406 LX_tls_cipher) & 0x7fffffff)
407
408 /* Private error numbers for delivery failures, set negative so as not
409 to conflict with system errno values. */
410
411 #define ERRNO_UNKNOWNERROR (-1)
412 #define ERRNO_USERSLASH (-2)
413 #define ERRNO_EXISTRACE (-3)
414 #define ERRNO_NOTREGULAR (-4)
415 #define ERRNO_NOTDIRECTORY (-5)
416 #define ERRNO_BADUGID (-6)
417 #define ERRNO_BADMODE (-7)
418 #define ERRNO_INODECHANGED (-8)
419 #define ERRNO_LOCKFAILED (-9)
420 #define ERRNO_BADADDRESS2 (-10)
421 #define ERRNO_FORBIDPIPE (-11)
422 #define ERRNO_FORBIDFILE (-12)
423 #define ERRNO_FORBIDREPLY (-13)
424 #define ERRNO_MISSINGPIPE (-14)
425 #define ERRNO_MISSINGFILE (-15)
426 #define ERRNO_MISSINGREPLY (-16)
427 #define ERRNO_BADREDIRECT (-17)
428 #define ERRNO_SMTPCLOSED (-18)
429 #define ERRNO_SMTPFORMAT (-19)
430 #define ERRNO_SPOOLFORMAT (-20)
431 #define ERRNO_NOTABSOLUTE (-21)
432 #define ERRNO_EXIMQUOTA (-22) /* Exim-imposed quota */
433 #define ERRNO_HELD (-23)
434 #define ERRNO_FILTER_FAIL (-24) /* Delivery filter process failure */
435 #define ERRNO_CHHEADER_FAIL (-25) /* Delivery add/remove header failure */
436 #define ERRNO_WRITEINCOMPLETE (-26) /* Delivery write incomplete error */
437 #define ERRNO_EXPANDFAIL (-27) /* Some expansion failed */
438 #define ERRNO_GIDFAIL (-28) /* Failed to get gid */
439 #define ERRNO_UIDFAIL (-29) /* Failed to get uid */
440 #define ERRNO_BADTRANSPORT (-30) /* Unset or non-existent transport */
441 #define ERRNO_MBXLENGTH (-31) /* MBX length mismatch */
442 #define ERRNO_UNKNOWNHOST (-32) /* Lookup failed in smtp transport */
443 #define ERRNO_FORMATUNKNOWN (-33) /* Can't match format in appendfile */
444 #define ERRNO_BADCREATE (-34) /* Creation outside home in appendfile */
445 #define ERRNO_LISTDEFER (-35) /* Can't check a list; lookup defer */
446 #define ERRNO_DNSDEFER (-36) /* DNS lookup defer */
447 #define ERRNO_TLSFAILURE (-37) /* Failed to start TLS session */
448 #define ERRNO_TLSREQUIRED (-38) /* Mandatory TLS session not started */
449 #define ERRNO_CHOWNFAIL (-39) /* Failed to chown a file */
450 #define ERRNO_PIPEFAIL (-40) /* Failed to create a pipe */
451 #define ERRNO_CALLOUTDEFER (-41) /* When verifying */
452 #define ERRNO_AUTHFAIL (-42) /* When required by client */
453 #define ERRNO_CONNECTTIMEOUT (-43) /* Used internally in smtp transport */
454 #define ERRNO_RCPT4XX (-44) /* RCPT gave 4xx error */
455
456 /* These must be last, so all retry deferments can easily be identified */
457
458 #define ERRNO_RETRY_BASE (-51) /* Base to test against */
459 #define ERRNO_RRETRY (-51) /* Not time for routing */
460 #define ERRNO_LRETRY (-52) /* Not time for local delivery */
461 #define ERRNO_HRETRY (-53) /* Not time for any remote host */
462 #define ERRNO_LOCAL_ONLY (-54) /* Local-only delivery */
463 #define ERRNO_QUEUE_DOMAIN (-55) /* Domain in queue_domains */
464
465 /* Special actions to take after failure or deferment. */
466
467 enum {
468 SPECIAL_NONE, /* No special action */
469 SPECIAL_FREEZE, /* Freeze message */
470 SPECIAL_FAIL, /* Fail the delivery */
471 SPECIAL_WARN /* Send a warning message */
472 };
473
474 /* Flags that get ORed into the more_errno field of an address to give more
475 information about errors for retry purposes. They are greater than 256, because
476 the bottom byte contains 'A' or 'M' for remote addresses, to indicate whether
477 the name was looked up only via an address record or whether MX records were
478 used, respectively. */
479
480 #define RTEF_CTOUT 0x0100 /* Connection timed out */
481
482 /* Permission and other options for parse_extract_addresses(),
483 filter_interpret(), and rda_interpret(), i.e. what special things are allowed
484 in redirection operations. Not all apply to all cases. Some of the bits allow
485 and some forbid, reflecting the "allow" and "forbid" options in the redirect
486 router, which were chosen to represent the standard situation for users'
487 .forward files. */
488
489 #define RDO_BLACKHOLE 0x00000001 /* Forbid :blackhole: */
490 #define RDO_DEFER 0x00000002 /* Allow :defer: or "defer" */
491 #define RDO_EACCES 0x00000004 /* Ignore EACCES */
492 #define RDO_ENOTDIR 0x00000008 /* Ignore ENOTDIR */
493 #define RDO_EXISTS 0x00000010 /* Forbid "exists" in expansion in filter */
494 #define RDO_FAIL 0x00000020 /* Allow :fail: or "fail" */
495 #define RDO_FILTER 0x00000040 /* Allow a filter script */
496 #define RDO_FREEZE 0x00000080 /* Allow "freeze" */
497 #define RDO_INCLUDE 0x00000100 /* Forbid :include: */
498 #define RDO_LOG 0x00000200 /* Forbid "log" */
499 #define RDO_LOOKUP 0x00000400 /* Forbid "lookup" in expansion in filter */
500 #define RDO_PERL 0x00000800 /* Forbid "perl" in expansion in filter */
501 #define RDO_READFILE 0x00001000 /* Forbid "readfile" in exp in filter */
502 #define RDO_READSOCK 0x00002000 /* Forbid "readsocket" in exp in filter */
503 #define RDO_RUN 0x00004000 /* Forbid "run" in expansion in filter */
504 #define RDO_DLFUNC 0x00008000 /* Forbid "dlfunc" in expansion in filter */
505 #define RDO_REALLOG 0x00010000 /* Really do log (not testing/verifying) */
506 #define RDO_REWRITE 0x00020000 /* Rewrite generated addresses */
507 #define RDO_EXIM_FILTER 0x00040000 /* Forbid Exim filters */
508 #define RDO_SIEVE_FILTER 0x00080000 /* Forbid Sieve filters */
509
510 /* This is the set that apply to expansions in filters */
511
512 #define RDO_FILTER_EXPANSIONS \
513 (RDO_EXISTS|RDO_LOOKUP|RDO_PERL|RDO_READFILE|RDO_READSOCK|RDO_RUN|RDO_DLFUNC)
514
515 /* As well as the RDO bits themselves, we need the bit numbers in order to
516 access (most of) the individual bits as separate options. This could be
517 automated, but I haven't bothered. Keep this list in step with the above! */
518
519 enum { RDON_BLACKHOLE, RDON_DEFER, RDON_EACCES, RDON_ENOTDIR, RDON_EXISTS,
520 RDON_FAIL, RDON_FILTER, RDON_FREEZE, RDON_INCLUDE, RDON_LOG, RDON_LOOKUP,
521 RDON_PERL, RDON_READFILE, RDON_READSOCK, RDON_RUN, RDON_DLFUNC, RDON_REALLOG,
522 RDON_REWRITE, RDON_EXIM_FILTER, RDON_SIEVE_FILTER };
523
524 /* Results of filter or forward file processing. Some are only from a filter;
525 some are only from a forward file. */
526
527 enum {
528 FF_DELIVERED, /* Success, took significant action */
529 FF_NOTDELIVERED, /* Success, didn't take significant action */
530 FF_BLACKHOLE, /* Blackholing requested */
531 FF_DEFER, /* Defer requested */
532 FF_FAIL, /* Fail requested */
533 FF_INCLUDEFAIL, /* :include: failed */
534 FF_NONEXIST, /* Forward file does not exist */
535 FF_FREEZE, /* Freeze requested */
536 FF_ERROR /* We have a problem */
537 };
538
539 /* Values for identifying particular headers; printing characters are used, so
540 they can be read in the spool file for those headers that are permanently
541 marked. The lower case values don't get onto the spool; they are used only as
542 return values from header_checkname(). */
543
544 #define htype_other ' ' /* Unspecified header */
545 #define htype_from 'F'
546 #define htype_to 'T'
547 #define htype_cc 'C'
548 #define htype_bcc 'B'
549 #define htype_id 'I' /* for message-id */
550 #define htype_reply_to 'R'
551 #define htype_received 'P' /* P for Postmark */
552 #define htype_sender 'S'
553 #define htype_old '*' /* Replaced header */
554
555 #define htype_date 'd'
556 #define htype_return_path 'p'
557 #define htype_delivery_date 'x'
558 #define htype_envelope_to 'e'
559 #define htype_subject 's'
560
561 /* These values are used only when adding new headers from an ACL; they too
562 never get onto the spool. The type of the added header is set by reference
563 to the header name, by calling header_checkname(). */
564
565 #define htype_add_top 'a'
566 #define htype_add_rec 'r'
567 #define htype_add_bot 'z'
568 #define htype_add_rfc 'f'
569
570 /* Types of item in options lists. These are the bottom 8 bits of the "type"
571 field, which is an int. The opt_void value is used for entries in tables that
572 point to special types of value that are accessed only indirectly (e.g. the
573 rewrite data that is built out of a string option.) We need to have some values
574 visible in local_scan, so the following are declared there:
575
576 opt_stringptr, opt_int, opt_octint, opt_mkint, opt_Kint, opt_fixed, opt_time,
577 opt_bool
578
579 To make sure we don't conflict, the local_scan.h values start from zero, and
580 those defined here start from 32. The boolean ones must all be together so they
581 can be easily tested as a group. That is the only use of opt_bool_last. */
582
583 enum { opt_bit = 32, opt_bool_verify, opt_bool_set, opt_expand_bool,
584 opt_bool_last,
585 opt_rewrite, opt_timelist, opt_uid, opt_gid, opt_uidlist, opt_gidlist,
586 opt_expand_uid, opt_expand_gid, opt_void };
587
588 /* There's a high-ish bit which is used to flag duplicate options, kept
589 for compatibility, which shouldn't be output. Also used for hidden options
590 that are automatically maintained from others. Another high bit is used to
591 flag driver options that although private (so as to be settable only on some
592 drivers), are stored in the instance block so as to be accessible from outside.
593 A third high bit is set when an option is read, so as to be able to give an
594 error if any option is set twice. Finally, there's a bit which is set when an
595 option is set with the "hide" prefix, to prevent -bP from showing it to
596 non-admin callers. The next byte up in the int is used to keep the bit number
597 for booleans that are kept in one bit. */
598
599 #define opt_hidden 0x100 /* Private to Exim */
600 #define opt_public 0x200 /* Stored in the main instance block */
601 #define opt_set 0x400 /* Option is set */
602 #define opt_secure 0x800 /* "hide" prefix used */
603 #define opt_mask 0x0ff
604
605 /* Verify types when directing and routing */
606
607 enum { v_none, v_sender, v_recipient, v_expn };
608
609 /* Option flags for verify_address() */
610
611 #define vopt_fake_sender 0x0001 /* for verify=sender=<address> */
612 #define vopt_is_recipient 0x0002
613 #define vopt_qualify 0x0004
614 #define vopt_expn 0x0008
615 #define vopt_callout_fullpm 0x0010 /* full postmaster during callout */
616 #define vopt_callout_random 0x0020 /* during callout */
617 #define vopt_callout_no_cache 0x0040 /* disable callout cache */
618 #define vopt_callout_recipsender 0x0080 /* use real sender to verify recip */
619 #define vopt_callout_recippmaster 0x0100 /* use postmaster to verify recip */
620 #define vopt_success_on_redirect 0x0200
621
622 /* Values for fields in callout cache records */
623
624 #define ccache_unknown 0 /* test hasn't been done */
625 #define ccache_accept 1
626 #define ccache_reject 2
627
628 /* Options for lookup functions */
629
630 #define lookup_querystyle 1 /* query-style lookup */
631 #define lookup_absfile 2 /* requires absolute file name */
632 #define lookup_absfilequery 4 /* query-style starts with file name */
633
634 /* Status values for host_item blocks. Require hstatus_unusable and
635 hstatus_unusable_expired to be last. */
636
637 enum { hstatus_unknown, hstatus_usable, hstatus_unusable,
638 hstatus_unusable_expired };
639
640 /* Reasons why a host is unusable (for clearer log messages) */
641
642 enum { hwhy_unknown, hwhy_retry, hwhy_failed, hwhy_deferred, hwhy_ignored };
643
644 /* Domain lookup types for routers */
645
646 enum { lk_default, lk_byname, lk_bydns };
647
648 /* Values for the self_code fields */
649
650 enum { self_freeze, self_defer, self_send, self_reroute, self_pass, self_fail };
651
652 /* Flags for rewrite rules */
653
654 #define rewrite_sender 0x0001
655 #define rewrite_from 0x0002
656 #define rewrite_to 0x0004
657 #define rewrite_cc 0x0008
658 #define rewrite_bcc 0x0010
659 #define rewrite_replyto 0x0020
660 #define rewrite_all_headers 0x003F /* all header flags */
661
662 #define rewrite_envfrom 0x0040
663 #define rewrite_envto 0x0080
664 #define rewrite_all_envelope 0x00C0 /* all envelope flags */
665
666 #define rewrite_all (rewrite_all_headers | rewrite_all_envelope)
667
668 #define rewrite_smtp 0x0100 /* rewrite at SMTP time */
669 #define rewrite_smtp_sender 0x0200 /* SMTP sender rewrite (allows <>) */
670 #define rewrite_qualify 0x0400 /* qualify if necessary */
671 #define rewrite_repeat 0x0800 /* repeat rewrite rule */
672
673 #define rewrite_whole 0x1000 /* option bit for headers */
674 #define rewrite_quit 0x2000 /* "no more" option */
675
676 /* Flags for log_write(); LOG_MAIN, LOG_PANIC, and LOG_REJECT are also in
677 local_scan.h */
678
679 #define LOG_MAIN 1 /* Write to the main log */
680 #define LOG_PANIC 2 /* Write to the panic log */
681 #define LOG_PANIC_DIE 6 /* Write to the panic log and then die */
682 #define LOG_PROCESS 8 /* Write to the process log */
683 #define LOG_REJECT 16 /* Write to the reject log, with headers */
684 #define LOG_SENDER 32 /* Add raw sender to the message */
685 #define LOG_RECIPIENTS 64 /* Add raw recipients to the message */
686 #define LOG_CONFIG 128 /* Add "Exim configuration error" */
687 #define LOG_CONFIG_FOR (256+128) /* Add " for" instead of ":\n" */
688 #define LOG_CONFIG_IN (512+128) /* Add " in line x[ of file y]" */
689
690 /* Returns from host_find_by{name,dns}() */
691
692 enum {
693 HOST_FIND_FAILED, /* failed to find the host */
694 HOST_FIND_AGAIN, /* could not resolve at this time */
695 HOST_FOUND, /* found host */
696 HOST_FOUND_LOCAL, /* found, but MX points to local host */
697 HOST_IGNORED /* found but ignored - used internally only */
698 };
699
700 /* Flags for host_find_bydns() */
701
702 #define HOST_FIND_BY_SRV 0x0001
703 #define HOST_FIND_BY_MX 0x0002
704 #define HOST_FIND_BY_A 0x0004
705 #define HOST_FIND_QUALIFY_SINGLE 0x0008
706 #define HOST_FIND_SEARCH_PARENTS 0x0010
707
708 /* Actions applied to specific messages. */
709
710 enum { MSG_DELIVER, MSG_FREEZE, MSG_REMOVE, MSG_THAW, MSG_ADD_RECIPIENT,
711 MSG_MARK_ALL_DELIVERED, MSG_MARK_DELIVERED, MSG_EDIT_SENDER,
712 MSG_SHOW_BODY, MSG_SHOW_HEADER, MSG_SHOW_LOG };
713
714 /* Returns from the spool_read_header() function */
715
716 enum {
717 spool_read_OK, /* success */
718 spool_read_notopen, /* open failed */
719 spool_read_enverror, /* error in the envelope */
720 spool_read_hdrerror /* error in the headers */
721 };
722
723 /* Options for transport_write_message */
724
725 #define topt_add_return_path 0x001
726 #define topt_add_delivery_date 0x002
727 #define topt_add_envelope_to 0x004
728 #define topt_use_crlf 0x008 /* Terminate lines with CRLF */
729 #define topt_end_dot 0x010 /* Send terminting dot line */
730 #define topt_no_headers 0x020 /* Omit headers */
731 #define topt_no_body 0x040 /* Omit body */
732 #define topt_escape_headers 0x080 /* Apply escape check to headers */
733
734 /* Codes for the host_find_failed option. */
735
736 #define hff_freeze 0
737 #define hff_defer 1
738 #define hff_pass 2
739 #define hff_decline 3
740 #define hff_fail 4
741
742 /* Router information flags */
743
744 #define ri_yestransport 0x0001 /* Must have a transport */
745 #define ri_notransport 0x0002 /* Must not have a transport */
746
747 /* Codes for match types in match_check_list; to any of them, MCL_NOEXPAND may
748 be added */
749
750 #define MCL_NOEXPAND 16
751
752 enum { MCL_STRING, MCL_DOMAIN, MCL_HOST, MCL_ADDRESS, MCL_LOCALPART };
753
754 /* Codes for the places from which ACLs can be called. These are cunningly
755 ordered to make it easy to implement tests for certain ACLs when processing
756 "control" modifiers, by means of a maximum "where" value. Do not modify this
757 order without checking carefully!
758
759 **** IMPORTANT***
760 **** Furthermore, remember to keep these in step with the tables
761 **** of names and response codes in globals.c.
762 **** IMPORTANT ****
763 */
764
765 enum { ACL_WHERE_RCPT, /* Some controls are for RCPT only */
766 ACL_WHERE_MAIL, /* ) */
767 ACL_WHERE_PREDATA, /* ) There are several tests for "in message", */
768 ACL_WHERE_MIME, /* ) implemented by <= WHERE_NOTSMTP */
769 ACL_WHERE_DATA, /* ) */
770 ACL_WHERE_NOTSMTP, /* ) */
771
772 ACL_WHERE_AUTH, /* These remaining ones are not currently */
773 ACL_WHERE_CONNECT, /* required to be in a special order so they */
774 ACL_WHERE_ETRN, /* are just alphabetical. */
775 ACL_WHERE_EXPN,
776 ACL_WHERE_HELO,
777 ACL_WHERE_MAILAUTH,
778 ACL_WHERE_QUIT,
779 ACL_WHERE_STARTTLS,
780 ACL_WHERE_VRFY
781 };
782
783 /* Situations for spool_write_header() */
784
785 enum { SW_RECEIVING, SW_DELIVERING, SW_MODIFYING };
786
787 /* MX fields for hosts not obtained from MX records are always negative.
788 MX_NONE is the default case; lesser values are used when the hosts are
789 randomized in batches. */
790
791 #define MX_NONE (-1)
792
793 /* host_item.port defaults to PORT_NONE; the only current case where this
794 is changed before running the transport is when an dnslookup router sets an
795 explicit port number. */
796
797 #define PORT_NONE (-1)
798
799 /* Flags for single-key search defaults */
800
801 #define SEARCH_STAR 0x01
802 #define SEARCH_STARAT 0x02
803
804 /* Filter types */
805
806 enum { FILTER_UNSET, FILTER_FORWARD, FILTER_EXIM, FILTER_SIEVE };
807
808 /* End of macros.h */