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