Fix bug 1267 - inlist/i were ignoring negation.
[exim.git] / doc / doc-txt / OptionLists.txt
0bd1a913 4This file contains complete lists of four kinds of Exim option:
6 1. Those that can appear in the run time configuration file;
7 2. Those that can be used on the command line;
8 3. Those that can appear in the build time configuration (Local/Makefile);
9 4. Those that can appear in the build time configuration for the Exim monitor
10 (Local/eximon.conf).
22380b86 12This file was last updated for Exim release 4.72.
18As Exim has developed, new options have been added at each major release. For
19the most part, backwards compatibility has been maintained, and obsolete
20options continue to be recognized. However, incompatible changes took place at
21releases 3.00, and 4.00. In both cases, several groups of options were
22amalgamated into new, extended options, and obsolete options were removed.
24The table below contains a complete list of all Exim's current options, along
25with their types, default values, and where they can be used. String options
26that are expanded before use are marked with *. Host lists, domain lists, and
27address lists are always expanded. In some cases the defaults are not fixed
28values, or not short enough to fit in the table. These are indicated by +. Some
29other default values are determined when the Exim binary is compiled; these are
30indicated by ++.
32For options that are specific to a particular driver, the fourth column
33contains the driver name, for example, appendfile. Otherwise, it contains
35 . `main' for options that appear in the main section of Exim's configuration
36 file;
38 . `authenticators' for generic options that apply to any authenticator;
40 . `routers' for generic options that apply to any router;
42 . `transports' for generic options that apply to any transport.
44The fifth column contains the version of Exim in which the option was added, or
45substantially changed. Where no number is given, the option has been in Exim
46since the very early releases. The routers were completely reorganised for
47release 4.00, and so no router options are shown as earlier than 4.00, though
48in fact some of them were inherited from earlier versions.
b1770b6e 51accept_8bitmime boolean true main 1.60 changed to true in 4.80
495ae4b0 52acl_not_smtp string* unset main 4.11
54cdb463 53acl_not_smtp_mime string* unset main 4.51 with content scan
54acl_smtp_auth string* unset main 4.00
55acl_smtp_connect string* unset main 4.11
56acl_smtp_data string* unset main 4.00
57acl_smtp_etrn string* unset main 4.00
58acl_smtp_expn string* unset main 4.00
59acl_smtp_helo string* unset main 4.20
60acl_smtp_mail string* unset main 4.11
61acl_smtp_mailauth string* unset main 4.21
54cdb463 62acl_smtp_mime string* unset main 4.50 with content scan
63acl_smtp_predata string* unset main 4.43
64acl_smtp_quit string* unset main 4.43
65acl_smtp_rcpt string* unset main 4.00
66acl_smtp_starttls string* unset main 4.11
67acl_smtp_vrfy string* unset main 4.00
68address_data string* unset routers 4.00
48c7f9e2 69address_retry_include_sender boolean true smtp 4.64
70address_test boolean true routers 4.14
71admin_groups string list unset main 3.02
72allow_domain_literals boolean false main 4.00 replacing forbid_domain_literals
73allow_commands string list* unset pipe 1.89
74allow_defer boolean false redirect 4.00
75allow_fail boolean false redirect 4.00
76allow_filter boolean false redirect 4.00
77allow_freeze boolean false redirect 4.00
78allow_fifo boolean false appendfile 3.13
79allow_localhost boolean false smtp 1.73
80allow_mx_to_ip boolean false main 3.14
81allow_symlink boolean false appendfile
82allow_utf8_domains boolean false main 4.14
83auth_advertise_hosts host list "*" main 4.00
84authenticated_sender string* unset smtp 4.14
382afc6b 85authenticated_sender_force boolean false smtp 4.61
86authenticate_hosts host list unset smtp 3.13
87auto_thaw time 0s main
54cdb463 88av_scanner string* + main 4.50 with content scan
89batch_id string unset appendfile 4.00
90 unset lmtp 4.00
91 unset pipe 4.00
92batch_max integer 100 appendfile
93 100 lmtp 3.20
94 100 pipe
95bcc string* unset autoreply
96bi_command string unset main
97body_only boolean false transports 2.05
98bounce_message_file string unset main 4.00
99bounce_message_text string unset main 4.00
100bounce_return_body boolean true main 4.23
101bounce_return_message boolean true main 4.00
102bounce_return_size_limit int 100K main 4.23 better name for return_size_limit
103bounce_sender_authentication string unset main 4.00
104callout_domain_negative_expire time 3h main 4.11
105callout_domain_positive_expire time 7d main 4.11
106callout_negative_expire time 2h main 4.11
107callout_positive_expire time 24h main 4.11
108callout_random_local_part string* + main 4.11
109cannot_route_message string* unset routers 4.11
110caseful_local_part boolean false routers 4.00
111cc string* unset autoreply
112check_ancestor boolean false redirect 4.00
113check_group boolean false appendfile
114 + redirect 4.00
115check_local_user boolean false routers 4.00
116check_log_inodes integer 0 main
117check_log_space integer 0 main
118check_owner boolean true appendfile 3.14
119 + redirect 4.00
d1e83bff 120check_rfc2047_length boolean true main 4.60
121check_secondary_mx boolean false dnslookup 4.00
122check_spool_inodes integer 0 main
123check_spool_space integer 0 main
124check_string string "From " appendfile 3.03
125 unset pipe 3.03
126check_srv string* unset dnslookup 4.31
8669f003 127client_condition string* unset authenticators 4.68
4730f942 128client_ignore_invalid_base64 boolean false plaintext 4.61
129client_name string* + cram_md5 3.10
130client_secret string* unset cram_md5 3.10
131client_send string* unset plaintext 3.10
132command string* unset lmtp 3.20
133 unset pipe
134 unset queryprogram 4.00
135command_group string unset queryprogram 4.00
136command_timeout time 5m smtp
137command_user string unset queryprogram 4.00
138condition string* unset routers 4.00
139connect_timeout time 0s smtp 1.60
140connection_max_messages integer 500 smtp 4.00 replaces batch_max
141create_directory boolean true appendfile
142create_file string "anywhere" appendfile
143current_directory string unset transports 4.00
144 unset queryprogram 4.00
145daemon_smtp_ports string unset main 1.75 pluralised in 4.21
146daemon_startup_retries int 9 main 4.52
147daemon_startup_sleep time 30s main 4.52
148data string unset redirect 4.00
149data_timeout time 5m smtp
150debug_print string* unset authenticators 4.00
151 unset routers 4.00
152 unset transports 2.00
153delay_after_cutoff boolean true smtp
154delay_warning time list 24h main
155delay_warning_condition string* + main 1.73
156deliver_drop_privilege boolean false main 4.00
157deliver_queue_load_max fixed-point unset main 1.70
158delivery_date_add boolean false transports
159delivery_date_remove boolean true main
160dkim_canon string* unset smtp 4.70
161dkim_domain string list* unset smtp 4.72
162dkim_private_key string* unset smtp 4.70
163dkim_selector string* unset smtp 4.70
164dkim_sign_headers string* (RFC4871) smtp 4.70
165dkim_strict string* unset smtp 4.70
166dkim_verify_signers string* $dkim_signers main 4.70
495ae4b0 167directory string* unset appendfile
f324b55d 168directory_file string* + appendfile
169directory_mode octal-integer 0700 appendfile
170directory_transport string* unset redirect 4.00
7e66e54d 171disable_ipv6 boolean false main 4.61
495ae4b0 172disable_logging boolean false routers 4.11
7e66e54d 173 false transports 4.11
174dns_again_means_nonexist domain list unset main 1.89
175dns_check_names_pattern string + main 2.11
176dns_csa_search_limit integer 5 main 4.60
177dns_csa_use_reverse boolean true main 4.60
178dns_ipv4_lookup boolean false main 3.20
179dns_qualify_single boolean true smtp
180dns_retrans time 0s main 1.60
181dns_retry integer 0 main 1.60
182dns_search_parents boolean false smtp
1f4a55da 183dns_use_dnssec integer -1 main 4.81
bdff9439 184dns_use_edns0 integer -1 main 4.76
185domains domain list unset routers 4.00
186driver string unset authenticators
187 unset routers 4.00
188 unset transports
189drop_cr boolean false main 4.00 became a no-op in 4.21
36a3ae5f 190dscp string unset smtp 4.81
f89d2485 191dsn_from string* + main 4.67
192envelope_to_add boolean false transports
193envelope_to_remove boolean true main
194environment string* unset pipe 2.95
195errors_copy string list* unset main
196errors_reply_to string unset main
197errors_to string* unset routers 4.00
198escape_string string ">From " appendfile 3.03
199 unset pipe 3.03
200exim_group string ++ main
201exim_path string ++ main
202exim_user string ++ main
203expn boolean true routers
204extra_local_interfaces string unset main 4.21
205extract_addresses_remove_arguments boolean true main 1.92
206fail_verify boolean false routers
207fail_verify_recipient boolean false routers 4.00
208fail_verify_sender boolean false routers 4.00
209fallback_hosts string list unset routers 4.00
210 unset smtp
211file string* unset appendfile
212 unset autoreply
213 unset redirect 4.00
214file_expand boolean false autoreply
215file_format string unset appendfile 3.03
216file_must_exist boolean false appendfile
217file_optional boolean false autoreply
218file_transport string* unset redirect 4.00
4608d683 219filter_prepend_home boolean true redirect 4.63
220final_timeout time 10m smtp
221finduser_retries integer 0 main
222forbid_blackhole boolean false redirect 4.00
23c7ff99 223forbid_exim_filter boolean false redirect 4.44
224forbid_fail boolean false redirect 4.00
225forbid_file boolean false redirect 4.00
226forbid_filter_existstest boolean false redirect 4.00
227forbid_filter_logwrite boolean false redirect 4.00
228forbid_filter_lookup boolean false redirect 4.00
229forbid_filter_perl boolean false redirect 4.00
230forbid_filter_readfile boolean false redirect 4.00
231forbid_filter_readsocket boolean false redirect 4.11
232forbid_filter_reply boolean false redirect 4.00
233forbid_filter_run boolean false redirect 4.00
234forbid_include boolean false redirect 4.00
235forbid_pipe boolean false redirect 4.00
23c7ff99 236forbid_sieve_filter boolean false redirect 4.44
5abeaa6e 237forbid_smtp_code boolean false redirect 4.63
495ae4b0 238freeze_exec_fail boolean false pipe 1.89
2799857c 239freeze_signal boolean false pipe 4.75
240freeze_tell boolean false main 4.00 replaces freeze_tell_mailmaster
241from string* unset autoreply
242gecos_name string* unset main
243gecos_pattern string unset main
244gethostbyname boolean false smtp
22380b86 245gnutls_compat_mode boolean unset main 4.70
a5f239e4 246gnutls_enable_pkcs11 boolean false main 4.81
247gnutls_require_kx string* unset main 4.67 deprecated, warns
248 string* unset smtp 4.67 deprecated, warns
249gnutls_require_mac string* unset main 4.67 deprecated, warns
250 string* unset smtp 4.67 deprecated, warns
251gnutls_require_protocols string* unset main 4.67 deprecated, warns
252 string* unset smtp 4.67 deprecated, warns
253group string + routers 4.00
254 unset transports 4.00 replaces local option in some transports
255header_line_maxsize integer 0 (unset) main 4.14
256header_maxsize integer 1M main 4.14
257headers string* unset autoreply
258headers_add string* unset routers 4.00
259 unset transports
260headers_charset string ++ main 4.21
261headers_only boolean false transports 2.05
262headers_remove string* unset routers 4.00
263 unset transports
264headers_rewrite string unset transports 3.20
265helo_accept_junk_hosts host list unset main 3.00
266helo_allow_chars string "" main 4.02
267helo_lookup_domains domain list unset main 4.00
268helo_data string* "$primary_hostname" smtp 3.21
269helo_try_verify_hosts host list unset main 4.00
270helo_verify_hosts host list unset main 1.73
271hide_child_in_errmsg false redirect 4.00
272hold_domains domain list unset main 1.70
273home_directory string* unset transports 4.00 replaces individual options
c456d9bb 274host_all_ignored string "defer" manualroute 4.67
275host_find_failed string "freeze" manualroute 4.00
276host_lookup host list unset main 3.00
277host_lookup_order string list "bydns:byaddr" main 4.30
278host_reject_connection host list unset main 4.00
279hosts string unset iplookup 4.00
280 string list* unset smtp
281hosts_avoid_esmtp host list unset smtp 4.21
c51b8e75 282hosts_avoid_pipelining host list unset smtp 4.67
283hosts_avoid_tls host list unset smtp 3.20
284hosts_connection_nolog host list unset main 4.43
285hosts_max_try integer 5 smtp 3.20
533244af 286hosts_max_try_hardlimit integer 50 smtp 4.50
287hosts_nopass_tls host list unset smtp 4.00
288hosts_override boolean false smtp 2.11
289hosts_randomize boolean false manualroute 4.00
290 false smtp 3.14
291hosts_require_auth host list unset smtp 4.00
292hosts_require_tls host list unset smtp 3.20
293hosts_treat_as_local domain list unset main 1.95
294hosts_try_auth host list unset smtp 4.00
595028e4 295ibase_servers string unset main 4.23
296ignore_bounce_errors_after time 0s main 4.00
297ignore_eacces boolean false redirect 4.00
298ignore_enotdir boolean false redirect 4.00
299ignore_fromline_hosts host list unset main
300ignore_fromline_local boolean false main 2.05
301ignore_status boolean false pipe
302ignore_target_hosts host list unset routers 4.00
303include_directory string unset redirect 4.00
304initgroups false routers 4.00
305interface string list unset smtp 1.70
306keep_malformed time 4d main
307keepalive boolean true smtp 2.05
308ldap_default_servers string list unset main 3.02
309ldap_version int 2 or 3 main 4.14
310local_from_check boolean true main 3.14
311local_from_prefix string unset main 3.14
312local_from_suffix string unset main 3.14
313local_interfaces string list unset main 1.60
314local_part_prefix string unset routers 4.00 replaces prefix
315local_part_prefix_optional boolean unset routers 4.00 replaces prefix_optional
316local_part_suffix string unset routers 4.00 replaces suffix
317local_part_suffix_optional boolean unset routers 4.00 replaces suffix_optional
318local_parts string list* unset routers 4.00
319local_scan_timeout time 5m main 4.03
320local_sender_retain boolean false main 4.00
321localhost_number string unset main
322lock_fcntl_timeout time 0s appendfile 3.14
323lock_flock_timeout time 0s appendfile 4.11
324lock_interval time 3s appendfile
325lock_retries integer 10 appendfile
326lockfile_mode octal-integer 0600 appendfile
327lockfile_timeout time 30m appendfile
328log string* unset autoreply
329log_as_local boolean + routers 4.00
330log_file_path string list ++ main
331log_defer_output boolean false pipe 1.89
332log_fail_output boolean false pipe 1.60
333log_output boolean false pipe 1.60
334log_selector string unset main 4.00
335log_timezone boolean false main 4.11
336lookup_open_max integer 25 main 2.05
337mailbox_filecount string* unset appendfile 4.43
338mailbox_size string* unset appendfile 4.43
339maildir_format boolean false appendfile 1.70
340maildir_retries integer 10 appendfile 1.70
341maildir_tag string* unset appendfile 1.92
76ba6b0a 342maildir_use_size_file boolean* false appendfile 4.30 expanded in 4.77
d6629cdc 343maildirfolder_create_regex string unset appendfile 4.62
344mailstore_format boolean false appendfile 2.00
345mailstore_prefix string* unset appendfile 2.00
346mailstore_suffix string* unset appendfile 2.00
347match_directory string* unset localuser
348max_output integer 20K pipe
349max_rcpt integer 100 smtp 1.60
350max_user_name_length integer 0 main
351mbx_format boolean false appendfile 2.10
ddea74fa 352message_body_newlines boolean false main 4.68
353message_body_visible integer 500 main
354message_id_header_domain string* unset main 4.11
355message_id_header_text string* unset main
356message_logs boolean true main 4.10
357message_prefix string* + appendfile 4.00 replaces prefix
358 string* unset pipe 4.00 replaces prefix
1c098beb 359message_size_limit integer 50M main
360 0 transports 2.05
361message_suffix string* + appendfile 4.00 replaces suffix
362 string* unset pipe 4.00 replaces suffix
363mode octal-integer 0600 appendfile
364 0600 autoreply
365mode_fail_narrower boolean true appendfile 1.70
366modemask octal-integer 022 redirect 4.00
367more boolean true routers 4.00
368move_frozen_messages boolean false main 3.09
369multi_domain boolean true smtp
370mx_domains domain list unset dnslookup 4.00
371mx_fail_domains domain list unset dnslookup 4.43
372mysql_servers string list unset main 3.03
373never_users string list unset main
374notify_comsat boolean false appendfile
375once string* unset autoreply
376once_file_size integer 0 autoreply 3.20
377once_repeat time 0s autoreply 2.95
378one_time boolean false redirect 4.00
3ecab157 379openssl_options string +no_sslv2 main 4.73 default changed in 4.80
380optional boolean false iplookup 4.00
381oracle_servers string unset main 4.00
382owners string list unset redirect 4.00
383owngroups string list unset redirect 4.00
384pass_on_timeout boolean false routers 4.00
385pass_router string unset routers 4.00
386path string "/usr/bin" pipe
387percent_hack_domains domain list unset main
388perl_at_start boolean false main 2.10
389perl_startup string unset main 2.10
22380b86 390permit_coredump boolean false pipe 4.73
391pgsql_servers string list unset main 3.14
392pid_file_path string ++ main
393pipe_as_creator boolean false pipe
394pipe_transport string* unset redirect 4.00
395pipelining_advertise_hosts host list "*" main 4.14
396port integer 0 iplookup 4.00
397 string "smtp" smtp
398preserve_message_logs boolean false main
399primary_hostname string + main
400print_topbitchars boolean false main 1.89
401process_log_path string unset main 4.21
402prod_requires_admin boolean true main 1.70
403protocol string "udp" iplookup 4.00
404 string "smtp" smtp 3.20
405public_name string unset authenticators 3.10
406qualify_domain string + main
407 string* unset redirect 4.31
408qualify_preserve_domain boolean false redirect 4.00
409qualify_recipient string + main
410qualify_single boolean true dnslookup 4.00
411query string* + iplookup 4.00
412queue_domains domain list unset main 4.00
413queue_list_requires_admin boolean true main 1.95
414queue_only boolean false main
415queue_only_file string unset main 2.05
416queue_only_load fixed-point unset main
8669f003 417queue_only_load_latch boolean true main 4.68
418queue_only_override boolean true main 4.21
419queue_run_in_order boolean false main 1.70
420queue_run_max integer 5 main
421queue_smtp_domains domain list unset main
422quota string* unset appendfile 1.60
423quota_directory string* unset appendfile 4.11
424quota_filecount integer 0 appendfile 2.05
425quota_is_inclusive boolean true appendfile 3.20
426quota_size_regex string unset appendfile 3.14
427quota_warn_message string* + appendfile 2.10
428quota_warn_threshold string* 0 appendfile 2.10
429rcpt_include_affixes boolean false transports 4.21
430receive_timeout time 0s main 4.00 replacing accept_timeout
431received_header_text string* + main
432received_headers_max integer 30 main
433recipient_unqualified_hosts host list unset main 4.00 replacing receiver_unqualified_hosts
434recipients_max integer 0 main 1.60
435recipients_max_reject boolean false main 1.70
436redirect_router string unset routers 4.00
437remote_max_parallel integer 1 main
438remote_sort_domains domain list unset main 4.00 replacing remote_sort
439repeat_use boolean true redirect 4.00
440reply_to string* unset autoreply 2.05
441reply_transport string* unset redirect 4.00
442require_files string list* unset routers 4.00
443reroute string* unset iplookup 4.00
444response_pattern string unset iplookup 4.00
445restrict_to_path boolean false pipe
446retry_data_expire time 7d main 3.03
447retry_include_ip_address boolean true smtp 1.92
448retry_interval_max time 24h main
449retry_use_local_part boolean + routers 4.00
450 + transports 4.00 replacing individual options
451return_fail_output boolean false pipe 1.60
452return_message boolean false autoreply
453return_output boolean false pipe
454return_path string* unset transports 2.05
455return_path_add boolean false transports
456return_path_remove boolean true main
457return_size_limit integer 100K main renamed bounce_return_size_limit in 4.23
458rewrite boolean true redirect 4.00
459rewrite_headers boolean true dnslookup 4.00
460rfc1413_hosts host list * main
8def5aaf 461rfc1413_query_timeout time 5s main
462router_home_directory string* unset routers 4.11
463route_data string* unset manualroute 4.00
464route_list string list unset manualroute 4.00
465same_domain_copy_routing boolean false dnslookup 4.00
466search_parents boolean false dnslookup 4.00
467self string "freeze" routers 4.00
468sender_unqualified_hosts host list unset main
469senders address list unset routers 4.00
470serialize_hosts host list unset smtp 1.60
471server_advertise_condition string* unset authenticators 4.14
b1770b6e 472server_channelbinding bool false gsasl 4.80
16ff981e 473server_condition string* unset authenticators 3.10 (plaintext) 4.64 (others)
474server_hostname string* "$primary_hostname" cyrus_sasl,gsasl,heimdal_gssapi (cyrus-only) 4.80 (others)
475server_keytab string* unset heimdal_gssapi 4.80
495ae4b0 476server_mail_auth_condition string* unset authenticators 3.22
477server_mech string public_name cyrus_sasl,gsasl 4.43 (cyrus-only) 4.80 (others)
478server_password string unset gsasl 4.80
495ae4b0 479server_prompts string* unset plaintext 3.10
480server_realm string unset cyrus_sasl,gsasl 4.43 (cyrus-only) 4.80 (others)
481server_scram_iter string* unset gsasl 4.80
482server_scram_salt string* unset gsasl 4.80
495ae4b0 483server_secret string* unset cram_md5 3.10
b1770b6e 484server_service string "smtp" cyrus_sasl,gsasl,heimdal_gssapi (cyrus-only) 4.80 (others)
485server_set_id string* unset authenticators 3.10
486shadow_condition string* unset transports
487shadow_transport string unset transports
488size_addition integer 1024 smtp 1.91
489skip_syntax_errors boolean false redirect 4.00
490smtp_accept_keepalive boolean true main
491smtp_accept_max integer 20 main
492smtp_accept_max_nonmail integer 10 main 4.11
493smtp_accept_max_nonmail_hosts host list * main 4.14
494smtp_accept_max_per_connection integer 1000 main 4.00
495smtp_accept_max_per_host integer 0 main 2.05
496smtp_accept_queue integer 0 main
497smtp_accept_queue_per_connection integer 10 main 2.03
498smtp_accept_reserve integer 0 main
499smtp_active_hostname string* unset main 4.33
500smtp_banner string* + main
501smtp_check_spool_space boolean true main 2.10
502smtp_connect_backlog integer 5 main
503smtp_enforce_sync boolean true main 4.00
504smtp_etrn_command string* unset main 1.92
505smtp_etrn_serialize boolean true main 1.89
506smtp_load_reserve fixed-point unset main
507smtp_max_synprot_errors integer 3 main 4.30
508smtp_max_unknown_commands integer 3 main 4.14
509smtp_ratelimit_hosts host list unset main 4.00
510smtp_ratelimit_mail string unset main 4.00
511smtp_ratelimit_rcpt string unset main 4.00
512smtp_receive_timeout time 5m main
513smtp_reserve_hosts host list unset main
514smtp_return_error_details boolean false main 4.11
515socket string* unset lmtp 4.11
22380b86 516spamd_address string* + main 4.50 with content scan
517split_spool_directory boolean false main 1.70
518spool_directory string ++ main
31480e42 519sqlite_lock_timeout time 5s main 4.53
38a0a95f 520strict_acl_vars boolean false main 4.64
521srv_fail_domains domain list unset dnslookup 4.43
522strip_excess_angle_brackets boolean false main
523strip_trailing_dot boolean false main
524subject string* unset autoreply
525syntax_errors_text string* unset redirect 4.00
526syntax_errors_to string unset redirect 4.00
527syslog_duplication boolean true main 4.21
528syslog_facility string unset main 4.20
529syslog_processname string "exim" main 4.20
530syslog_timestamp boolean true main 4.00
531system_filter string unset main 4.00 replacing message_filter
532system_filter_directory_transport string unset main 4.00 replacing message_filter
533system_filter_file_transport string unset main 4.00 replacing message_filter
534system_filter_group string unset main 4.00 replacing message_filter
535system_filter_pipe_transport string unset main 4.00 replacing message_filter
536system_filter_reply_transport string unset main 4.00 replacing message_filter
537system_filter_user string unset main 4.00 replacing message_filter
538tcp_nodelay boolean true main 4.23
539 true smtp 4.23
5dc43717 540tcp_wrappers_daemon_name string* ++ main 4.73
541temp_errors string list + pipe 1.95
542text string* unset autoreply
543timeout time 5m lmtp 3.20
544 1h pipe
545 1h queryprogram 4.00
546 5s iplookup 4.00
2e2a30b4 547timeout_defer boolean false pipe 4.51
548timeout_frozen_after time 0s main 3.20
549timezone string + main 3.15
550tls_advertise_hosts host list * main 3.20
551tls_certificate string* unset main 3.20
552 unset smtp 3.20
e11808ae 553tls_dh_max_bits integer 2236 main 4.80
54c90be1 554tls_dh_min_bits integer 1024 smtp 4.81
555tls_dhparam string* unset main 3.20
556tls_on_connect_ports string unset main 4.43
557tls_privatekey string* unset main 3.20
558 unset smtp 3.20
559tls_remember_emstp boolean false main 4.21
560tls_require_ciphers string* unset smtp 4.00 replaces tls_verify_ciphers
561 string* unset main 4.33
b1770b6e 562tls_sni string* unset main 4.80
563tls_tempfail_tryclear boolean true smtp 4.05
564tls_try_verify_hosts host list unset main 4.00
565tls_verify_certificates string* unset main 3.20
566 unset smtp 3.20
567tls_verify_hosts host list unset main 3.20
568to string* unset autoreply
569translate_ip_address string unset routers 4.00
570transport string* unset routers 4.00
571transport_current_directory string unset routers 4.00
572transport_home_directory string unset routers 4.00
573transport_filter string unset transports
574transport_filter_timeout time 5m transports 4.30
575trusted_groups string list unset main
576trusted_users string list unset main
577umask octal-integer 022 pipe
578unknown_login string unset main
579unknown_username string unset main
580unseen boolean false routers 4.00
581untrusted_set_sender boolean false main 3.20
582use_bsmtp boolean false appendfile 4.00
583 false pipe 4.00
584use_crlf boolean false appendfile 1.89
585 false pipe 1.89
586use_fcntl_lock boolean + appendfile 1.70
587use_flock_lock boolean + appendfile 4.11
588use_lockfile boolean + appendfile
589use_mbx_lock boolean + appendfile 2.10
590use_shell boolean false pipe 1.70
591user string + routers 4.00
592 unset transports 4.00 replaces individual options
593uucp_from_pattern string + main 1.75
594uucp_from_sender string* "$1" main 1.75
595verify boolean true routers 4.00
596verify_only boolean false routers 4.00
597verify_recipient boolean true routers 4.00
598verify_sender boolean true routers 4.00
599warn_message_file string unset main 4.00
600widen_domains string list unset dnslookup 4.00
601write_rejectlog boolean true main 4.31
608The table below contains a complete list of all Exim's command line options.
609Those marked with # are available only to trusted users, those marked with +
610are available only to admin users, and those marked with * exist only to
611provide compatibility with Sendmail.
613-- Terminate options
614--help Give a little help (not a lot)
4b2241d2 615--version Give version information (alias for -bV)
616-B * Ignored
617-bd + Start daemon
618-bdf + Start daemon and run it in the foreground
619-be Test string expansion
328895cc 620-bem Test string expansion, read test message first
621-bF Test system filter file
622-bf Test user filter file
623-bfd Set domain for filter testing
624-bfl Set local part for filter testing
625-bfp Set local part prefix for filter testing
626-bfs Set local part suffix for filter testing
627-bh Test incoming SMTP call, omitting callouts
628-bhc Test incoming SMTP call, with callouts
629-bi * Run <command>bi_command</command>
54c90be1 630-bI:help Show list of accepted -bI:<tag> options
495ae4b0 631-bm Accept message on standard input
22380b86 632-bmalware + Invoke configured malware scanning against supplied filename
633-bnq Don't qualify addresses in locally submitted messages
634-bP Show configuration option settings
635-bp + List the queue
636-bpa + ... with generated addresses as well
637-bpc + ... but just show a count of messages
638-bpr + ... do not sort
639-bpra + ... with generated addresses, unsorted
640-bpru + ... only undelivered addresses, unsorted
641-bpu + ... only undelivered addresses
642-brt Test retry rules
643-brw Test rewriting rules
644-bS Read batch SMTP on standard input
645-bs Run SMTP on standard input and output
646-bt Test address directing and routing
647-bV Verify version number
648-bv Test recipient address verification
649-bvs Test sender address verification
9ee44efb 650-bw + Inetd wait mode
651-C + Use alternate configuration file
652-D + Define macro for configuration file
653-d + Turn on debugging output
654-dd + Ditto, but if a daemon, not for subprocesses
655-dropcr Remove CR character in input: became a no-op in 4.21
656-E Internal use only
657-ex * Synonym for -oex (for several different x)
658-F Set calling user name
659-f # Set calling user address
660-G * Ignored
661-h * Ignored
662-i Dot does not terminate message
663-M + Force deliver specific message
664-Mar + Add recipient to message
665-MC Internal use only
666-MCA Internal use only
667-MCP Internal use only
668-MCQ Internal use only
669-MCS Internal use only
670-MCT Internal use only
671-Mc + Deliver specific message
672-Mes + Edit message sender
673-Mf + Freeze message(s)
674-Mg + Give up (bounce) message(s)
675-Mmad + Mark all recipients delivered
676-Mmd + Mark one recipient delivered
677-Mrm + Remove message(s) (no bounce)
328895cc 678-Mset + Load message's variables when testing with -be
679-Mt + Thaw message(s)
680-Mvb + View message body
22380b86 681-Mvc + View entire message in RFC 2822 format
682-Mvh + View message header
683-Mvl + View message log
684-m * Ignored
685-N + Deliver without transporting
686-n * Ignored
687-O * Ignored
688-oA * Supply argument for <option>-bi</option>
689-oB Set max messages down one connection
690-odb Background delivery
691-odf Foreground delivery
692-odi Foreground delivery
693-odq Queue message; do not deliver
694-odqs ... do not do SMTP deliveries
695-oee Error sent by mail; zero return code
696-oem Error sent by mail; non-zero return code
697-oep Error written to standard error stream
698-oeq * Error written to standard error stream
699-oew * Error sent by mail; non-zero return code
700-oi Dot does not terminate message
701-oitrue * Dot does not terminate message
702-oMa # Supply host address
703-oMaa # Supply authenticator name
704-oMai # Supply authenticated id
705-oMas # Supply authenticated sender
706-oMi # Supply interface address
707-oMr # Supply protocol name
708-oMs # Supply host name
709-oMt # Supply ident string
710-om * Ignored
711-oo * Ignored
712-oP * Specify path for daemon's pid file
713-or Timeout non-SMTP messages
714-os Timeout for SMTP messages
715-ov * Verbose; same as -v
716-oX Alternative port for daemon
717-pd Delay Perl interpreter start
718-ps Do not delay Perl interpreter start
719-p<r>:<s> * Same as -oMr <r> -oMs <s>
720-q + Run the queue )
721-qf + ... force delivery ) Other combinations are
722-qff + ... and include frozen messages ) possible. The syntax is
723-qi + ... initial deliveries only )
724-ql + ... local deliveries only ) -q[q][f][f][i|l][time]
725-qq + Two-stage queue run )
726-qR * Same as -R
727-qS * Same as -S
728-R Select by recipient in queue run
729-Rf ... with forcing
730-Rff ... and frozen messages
731-Rr ... using regular expression
732-Rrf ... with forcing
733-Rrff ... and frozen messages
734-r * Synonym for -f
735-S Select by sender in queue run
736-Sf ... with forcing
737-Sff ... and frozen messages
738-Sr ... using regular expression
739-Srf ... with forcing
740-Srff ... and frozen messages
741-Tqt * Used by Exim test suite; not recognized in normal use
742-t Take recipients from header lines
743-ti * Same as -t -i
744-tls-on-connect Do TLS on startup (for legacy clients)
745-U * Ignored
746-v Verbose - shows SMTP dialogue and other delivery info
747-x Ignored (AIX compatibility)
753The table below contains a "mostly" complete list of options that can be
754set in Local/Makefile when building Exim. The only items not included are
755those whose names can be trivially derived from rules stated below.
757More information about individual options can be found in src/EDITME and
760The second column below gives the type of option:
762 . `system' means the option is concerned with the operating system;
764 . `driver' means the option selects a driver to be included in the binary;
766 . `lookup' means the option selects a lookuptype to be included in the binary;
768 . `mandatory' means the option is required to be supplied;
770 . `recommended' means the option is recommended to be supplied;
772 . `optional' means what it says;
774Those marked with * are specialized and are unlikely to be required in most
775installations. Those that are marked with ** are commonly set in OS-specific
776Makefiles. If you use any of these in your Local/Makefile, you may need to
777reproduce some of the OS-specific settings. For example, in the Makefile for
778Solaris (which is actually called OS/Makefile-SunOS5), there is
780 LIBS=-lsocket -lnsl -lkstat
782If you use LIBS to add extra libraries, you must also include the OS ones in
783your setting. It is better, in this particular case, to use EXTRALIBS, which is
784empty by default, and is provided for just this reason. Of course, if you do
785actually want to modify a setting from the OS-specific file, there is nothing
786to stop you overriding it in your Local/Makefile.
788When building Exim with dynamically loaded lookup support, for "LOOKUP_FOO",
789you can define "LOOKUP_FOO_INCLUDE" and "LOOKUP_FOO_LIBS", for includes and
790libraries specific only to that module. These rules are only used where the
791relevant lookup is a module. These options are not explicitly listed below.
793Variables with names endined `_PC' are used for pkg-config integration; setting
794the value to the name of a pkg-config package will cause Exim's build system to
795query the --cflags and --libs for the given name, when building anything
796dependent upon the component associated with the `_PC' variable. For lookups,
797if the lookup is dynamically loaded, then this *replaces* the use of the
798corresponding _INCLUDE and _LIBS options, which will be ignored. If the lookup
799is statically loaded into Exim, the results will be inserted into the
800"LOOKUP_INCLUDE" and "LOOKUP_LIBS" options. For authenticator, the results
801will be inserted into the "CFLAGS" and "AUTH_LIBS" options. These options are
802only listed below for the TLS implementation cases.
805Option Type Description
808ALT_CONFIG_PREFIX optional restricts location of -C files
809APPENDFILE_MODE optional*
812AR system command to build a library
813AUTH_CRAM_MD5 driver include cram_md5 authenticator
068aaea8 814AUTH_CYRUS_SASL driver include Cyrus SASL authenticator
815AUTH_GSASL driver include GNU SASL authenticator
816AUTH_HEIMDAL_GSSAPI driver include Heimdal GSSAPI authenticator
817AUTH_LIBS system library linkage for authenticators
818AUTH_PLAINTEXT driver include plaintext authenticator
819AUTH_SPA driver include SPA (NTLM) authenticator
f78eb7c6 820AUTH_VARS=3 optional* number of $auth variables
821BASENAME_COMMAND system** path to basename
822BASE_62=62 optional* not normally changed for Unix
823BIN_DIRECTORY mandatory Exim binary directory
824CC system** C compiler
825CFLAGS system** flags for C compiler
35110e70 826CFLAGS_DYNAMIC system** extra flags needed for .so modules
827CHGRP_COMMAND system** path to chgrp
828CHOWN_COMMAND system** path to chown
829COMPRESS_COMMAND system path to a compress command
830COMPRESS_SUFFIX system suffix added to compressed files
831CONFIGURE_FILE mandatory Exim runtime configuration file
35edf2ff 834CONFIGURE_GROUP optional* alternate group for configuration file
835CONFIGURE_OWNER optional* alternate owner for configuration file
836CYRUS_PWCHECK_SOCKET optional socket for pwcheck daemon
837DBMLIB optional** location of DBM library
838DB_DIRECTORY_MODE optional* mode for hints directory
839DB_LOCKFILE_MODE optional* mode for hints lock files
840DB_LOCK_TIMEOUT optional* timeout for hints lock files
841DB_MODE optional* mode for hints files
96c065cb 842DEFAULT_CRYPT optional default crypt() function
22380b86 845DISABLE_DKIM optional disables DKIM support
1f4a55da 846DISABLE_DNSSEC optional disables attempts to use DNSSEC
847DISABLE_D_OPTION optional disables -D option
848ERRNO_QUOTA optional* error code for system quota failures
849EXICYCLOG_MAX optional number of old log files to keep
850EXIMDB_DIRECTORY_MODE optional* for hints database directory
851EXIMDB_LOCKFILE_MODE optional* for hints lock files
852EXIMDB_MODE optional* mode for hints files
853EXIMON_TEXTPOP system**
854EXIM_CHMOD optional*
855EXIM_GROUP mandatory group to use for Exim
856EXIM_MONITOR optional set to eximon.bin to compile
857EXIM_PERL optional
858EXIM_USER mandatory user to use for Exim
859EXIWHAT_EGREP_ARG system** to find Exim processes from ps
860EXIWHAT_KILL_SIGNAL system** -SIGUSER1 or numerical equivalent
863EXIWHAT_PS_ARG system** to list all processes
864EXIWHAT_PS_CMD system** path to ps command
39257585 865EXPAND_LISTMATCH_RHS optional* restore pre-4.77 match_*{}{} behaviour
866EXTRALIBS system additional libraries
867EXTRALIBS_EXIM system additional libraries for Exim only
868EXTRALIBS_EXIMON system additional libraries for the monitor
869FIXED_NEVER_USERS optional can't override at runtime
870HAVE_ICONV system the iconv() function is available
871HAVE_IPV6 system include IPv6 support
872HEADERS_CHARSET optional charset for decoded header lines
873HEADER_ADD_BUFFER_SIZE optional* buffer for header_add()
874HEADER_MAXSIZE optional* max memory for message header
875HOSTNAME_COMMAND system** path to hostname command
876INCLUDE system path to include files
877INFO_DIRECTORY optional directory for Info documentation
878INPUT_DIRECTORY_MODE optional mode for input directory
879IPV6_INCLUDE system additional includes for IPv6
880IPV6_LIBS system additional libraries for IPv6
881LDAP_LIB_TYPE optional type of LDAP library
882LFLAGS system** link editor flags
883LIBIDENTCFLAGS system C flags when compiling libident
884LIBIDENTNAME system name for libident library
885LIBRESOLV system** library for DNS resolver
886LIBS system** additional libraries
887LIBS_EXIM system** additional libraries for Exim ony
888LIBS_EXIMON system** additional libraries for monitor
889LOCAL_SCAN_SOURCE optional location of local_scan() source
890LOG_DIRECTORY_MODE optional mode for log directory
891LOG_FILE_PATH optional path to log files
892LOG_MODE optional mode for log files
893LOOKUP_CDB lookup include cdb lookup
894LOOKUP_DBM lookup include dbm lookup
895LOOKUP_DNSDB lookup include dnsdb lookup
896LOOKUP_DSEARCH lookup include dsearch lookup
897LOOKUP_INCLUDE lookup include files for lookups
898LOOKUP_LDAP lookup include ldap lookup
899LOOKUP_LIBS lookup include libraries for lookups
900LOOKUP_LSEARCH lookup include all lsearch lookups
35110e70 901LOOKUP_MODULE_DIR optional* where dynamic lookup modules live
902LOOKUP_MYSQL lookup include mysql lookup
903LOOKUP_NIS lookup include nis lookup
904LOOKUP_NISPLUS lookup include nisplus lookup
905LOOKUP_ORACLE lookup include oracle lookup
906LOOKUP_PGSQL lookup include pgsql lookup
907LOOKUP_TESTDB lookup*
908LOOKUP_WHOSON lookup include whoson lookup
909LOOKUP_*_INCLUDE optional* include files for dynamic module
910LOOKUP_*_LIBS optional* libraries for dynamic module
911MAKE_SHELL optional* shell to use for make
912MAX_FILTER_SIZE optional* max file size for filter files
913MAX_INCLUDE_SIZE optional* max file size for :include: files
914MAX_LOCALHOST_NUMBER=256 optional* for when localhost_number is set
915MAX_NAMED_LIST optional* max named lists of a given type
916MAX_INTERFACES system maximum network interfaces
917MSGLOG_DIRECTORY_MODE optional* mode for message log directory
918MV_COMMAND system path to mv command
919NO_SYMLINK optional install doesn't make 'exim" symlink
920PCRE_CONFIG system* use pcre-config for PCRE support
921PCRE_LIBS system* library for using PCRE
922PERL_CC system* compiler for Perl interface code
923PERL_CCOPTS system* flags for same
924PERL_COMMAND system path to Perl
925PERL_LIBS system* library for compiling Perl interface
926PID_FILE_PATH optional path to daemon's pid file
927RADIUS_CONFIG_FILE optional path to Radius config file
928RADIUS_LIB_TYPE optional type of RADIUS library
929RANLIB system** path to ranlib command
930RM_COMMAND system path to rm command
931ROUTER_ACCEPT driver include accept router
932ROUTER_DNSLOOKUP driver include dnslookup router
933ROUTER_MANUALROUTE driver include manualroute router
934ROUTER_IPLITERAL driver include ipliteral router
935ROUTER_IPLOOKUP driver include iplookup router
936ROUTER_REDIRECT driver include redirect router
937ROUTER_QUERYPROGRAM driver include queryprogram router
938SPOOL_DIRECTORY recommended path to spool directory
939SPOOL_DIRECTORY_MODE optional mode of spool directory
940SPOOL_MODE optional mode of spool files
941STRING_SPRINTF_BUFFER_SIZE optional* buffer for string_sprintf()
942STRIP_COMMAND optional* can be used to strp binaries
943SUPPORT_A6 optional* support A6 DNS records
944SUPPORT_CRYPTEQ optional support crypteq (if no auths)
945SUPPORT_MAILDIR optional support for maildir delivery
946SUPPORT_MAILSTORE optional support for mailstore delivery
947SUPPORT_MBX optional support for MBX delivery
948SUPPORT_MOVE_FROZEN_MESSAGES optional* support for frozen message moving
949SUPPORT_PAM optional support for PAM authentication
950SUPPORT_TLS optional support for TLS encryption over SMTP
951SUPPORT_TRANSLATE_IP_ADDRESS optional* support for address translation
952SYSLOG_LOG_PID optional add pid to syslog lines
953SYSLOG_LONG_LINES optional do not split long syslog lines
954SYSTEM_ALIASES_FILE optional defaults to /etc/aliases
35110e70 955TCP_WRAPPERS_DAEMON_NAME system* daemon name used by tcpwrappers library
956TIMEZONE_DEFAULT optional default for timezone option
957TLS_INCLUDE optional path to include files for TLS
958TLS_LIBS optional additional libraries for TLS
959TMPDIR system value for TMPDIR environment variable
960TRANSPORT_APPENDFILE driver include appendfile transport
961TRANSPORT_AUTOREPLY driver include autoreply transport
962TRANSPORT_LMTP driver include lmtp transport
963TRANSPORT_PIPE driver include pipe transport
964TRANSPORT_SMTP driver include smtp transport
35110e70 965TRUSTED_CONFIG_LIST optional config files safe to retain privileges
966USE_DB system** use native DB interface
967USE_GNUTLS optional use GnuTLS instead of OpenSSL
968USE_GNUTLS_PC optional probably "gnutls"
969USE_OPENSSL_PC optional probably "openssl"
970USE_READLINE optional try to load libreadline for -be
971USE_TCP_WRAPPERS system link with tcpwrappers
972USE_TDB optional use the tdb DB interface
35110e70 973WHITELIST_D_MACROS optional -Dmacros safe to retain privileges with
22380b86 974WITH_OLD_CLAMAV_STREAM optional* use ClamAV API from before ClamAV 0.95
975X11 system** X11 base directory
976X11_LD_LIB system** X11 link library
977XINCLUDE system** X11 include directory
978XLFLAGS system** X11 link time flags
979ZCAT_COMMAND system path to zcat command
985The table below contains a complete list of options that can be set in
986Local/eximon.conf when building the Exim monitor. Where the default is shown as
987** it means that the text string is too long to fit in the table and is instead
988given below. A blank default means that there is no default value.
990ACTION_OUTPUT=no show output for every action
991ACTION_QUEUE_UPDATE=yes update queue display after actions
992BODY_MAX=20000 maximum body display
993DOMAIN= domain to strip from window title
994LOG_BUFFER=20K buffer for log tail
995LOG_DEPTH=300 depth of log subwindow
996LOG_FONT=** font for log display
997LOG_STRIPCHARTS=** patterns for stripcharts
998LOG_WIDTH=950 width of log subwindow
999MENU_EVENT='Shift<Btn1Down>' keypress for menu
1000MIN_HEIGHT=162 minimum window height
1001MIN_WIDTH=103 minimum window width
1002QUALIFY_DOMAIN= local domain to strip from addresses
1003QUEUE_DEPTH=200 depth of queue subwindow
1004QUEUE_FONT=$LOG_FONT font for queue display
1005QUEUE_INTERVAL=300 queue refresh interval
1006QUEUE_MAX_ADDRESSES=10 max addresses to show in queue
1007QUEUE_STRIPCHART_NAME=queue name for queue stripchart
1008QUEUE_WIDTH=950 width of queue subwindow
1009SIZE_STRIPCHART= request partition size stripchart
1010SIZE_STRIPCHART_NAME=space name for size stripchart
1011START_SMALL=no if yes, start with small window
1012STRIPCHART_INTERVAL=60 stripchart refresh interval
1013TEXT_DEPTH=200 depth of text windows
1014WINDOW_TITLE="${hostname} eximon" window title
1016The default for LOG_FONT is
1018 LOG_FONT=-misc-fixed-medium-r-normal-*-14-140-*-*-*-*-iso8859-1
1020and the default for LOG_STRIPCHARTS is
1022 LOG_STRIPCHARTS='/ <= /in/
1023 / => /out/
1024 / => .+ R=local/local/
1025 / => .+ T=[^ ]*smtp/smtp/'
1027That is, there are four stripcharts, named in, out, local, and smtp. The first
1028counts message arrivals, the second counts all deliveries, the third counts
1029deliveries where the router's name starts with "local", and the fourth counts
1030deliveries where the transport name contains "smtp".
1032**** End of OptionLists ****