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