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