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