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