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