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