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