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