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