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