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