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