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