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