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