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