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