1 $Cambridge: exim/doc/doc-txt/OptionLists.txt,v 1.36 2010/06/05 21:42:53 pdp Exp $
6 This file contains complete lists of four kinds of Exim option:
8 1. Those that can appear in the run time configuration file;
9 2. Those that can be used on the command line;
10 3. Those that can appear in the build time configuration (Local/Makefile);
11 4. Those that can appear in the build time configuration for the Exim monitor
14 This file was last updated for Exim release 4.72.
20 As Exim has developed, new options have been added at each major release. For
21 the most part, backwards compatibility has been maintained, and obsolete
22 options continue to be recognized. However, incompatible changes took place at
23 releases 3.00, and 4.00. In both cases, several groups of options were
24 amalgamated into new, extended options, and obsolete options were removed.
26 The table below contains a complete list of all Exim's current options, along
27 with their types, default values, and where they can be used. String options
28 that are expanded before use are marked with *. Host lists, domain lists, and
29 address lists are always expanded. In some cases the defaults are not fixed
30 values, or not short enough to fit in the table. These are indicated by +. Some
31 other default values are determined when the Exim binary is compiled; these are
34 For options that are specific to a particular driver, the fourth column
35 contains the driver name, for example, appendfile. Otherwise, it contains
37 . `main' for options that appear in the main section of Exim's configuration
40 . `authenticators' for generic options that apply to any authenticator;
42 . `routers' for generic options that apply to any router;
44 . `transports' for generic options that apply to any transport.
46 The fifth column contains the version of Exim in which the option was added, or
47 substantially changed. Where no number is given, the option has been in Exim
48 since the very early releases. The routers were completely reorganised for
49 release 4.00, and so no router options are shown as earlier than 4.00, though
50 in fact some of them were inherited from earlier versions.
52 -----------------------------------------------------------------------------------------
53 accept_8bitmime boolean false main 1.60
54 acl_not_smtp string* unset main 4.11
55 acl_not_smtp_mime string* unset main 4.51 with content scan
56 acl_smtp_auth string* unset main 4.00
57 acl_smtp_connect string* unset main 4.11
58 acl_smtp_data string* unset main 4.00
59 acl_smtp_etrn string* unset main 4.00
60 acl_smtp_expn string* unset main 4.00
61 acl_smtp_helo string* unset main 4.20
62 acl_smtp_mail string* unset main 4.11
63 acl_smtp_mailauth string* unset main 4.21
64 acl_smtp_mime string* unset main 4.50 with content scan
65 acl_smtp_predata string* unset main 4.43
66 acl_smtp_quit string* unset main 4.43
67 acl_smtp_rcpt string* unset main 4.00
68 acl_smtp_starttls string* unset main 4.11
69 acl_smtp_vrfy string* unset main 4.00
70 address_data string* unset routers 4.00
71 address_retry_include_sender boolean true smtp 4.64
72 address_test boolean true routers 4.14
73 admin_groups string list unset main 3.02
74 allow_domain_literals boolean false main 4.00 replacing forbid_domain_literals
75 allow_commands string list* unset pipe 1.89
76 allow_defer boolean false redirect 4.00
77 allow_fail boolean false redirect 4.00
78 allow_filter boolean false redirect 4.00
79 allow_freeze boolean false redirect 4.00
80 allow_fifo boolean false appendfile 3.13
81 allow_localhost boolean false smtp 1.73
82 allow_mx_to_ip boolean false main 3.14
83 allow_symlink boolean false appendfile
84 allow_utf8_domains boolean false main 4.14
85 auth_advertise_hosts host list "*" main 4.00
86 authenticated_sender string* unset smtp 4.14
87 authenticated_sender_force boolean false smtp 4.61
88 authenticate_hosts host list unset smtp 3.13
89 auto_thaw time 0s main
90 av_scanner string* + main 4.50 with content scan
91 batch_id string unset appendfile 4.00
94 batch_max integer 100 appendfile
97 bcc string* unset autoreply
98 bi_command string unset main
99 body_only boolean false transports 2.05
100 bounce_message_file string unset main 4.00
101 bounce_message_text string unset main 4.00
102 bounce_return_body boolean true main 4.23
103 bounce_return_message boolean true main 4.00
104 bounce_return_size_limit int 100K main 4.23 better name for return_size_limit
105 bounce_sender_authentication string unset main 4.00
106 callout_domain_negative_expire time 3h main 4.11
107 callout_domain_positive_expire time 7d main 4.11
108 callout_negative_expire time 2h main 4.11
109 callout_positive_expire time 24h main 4.11
110 callout_random_local_part string* + main 4.11
111 cannot_route_message string* unset routers 4.11
112 caseful_local_part boolean false routers 4.00
113 cc string* unset autoreply
114 check_ancestor boolean false redirect 4.00
115 check_group boolean false appendfile
117 check_local_user boolean false routers 4.00
118 check_log_inodes integer 0 main
119 check_log_space integer 0 main
120 check_owner boolean true appendfile 3.14
122 check_rfc2047_length boolean true main 4.60
123 check_secondary_mx boolean false dnslookup 4.00
124 check_spool_inodes integer 0 main
125 check_spool_space integer 0 main
126 check_string string "From " appendfile 3.03
128 check_srv string* unset dnslookup 4.31
129 client_condition string* unset authenticators 4.68
130 client_ignore_invalid_base64 boolean false plaintext 4.61
131 client_name string* + cram_md5 3.10
132 client_secret string* unset cram_md5 3.10
133 client_send string* unset plaintext 3.10
134 command string* unset lmtp 3.20
136 unset queryprogram 4.00
137 command_group string unset queryprogram 4.00
138 command_timeout time 5m smtp
139 command_user string unset queryprogram 4.00
140 condition string* unset routers 4.00
141 connect_timeout time 0s smtp 1.60
142 connection_max_messages integer 500 smtp 4.00 replaces batch_max
143 create_directory boolean true appendfile
144 create_file string "anywhere" appendfile
145 current_directory string unset transports 4.00
146 unset queryprogram 4.00
147 daemon_smtp_ports string unset main 1.75 pluralised in 4.21
148 daemon_startup_retries int 9 main 4.52
149 daemon_startup_sleep time 30s main 4.52
150 data string unset redirect 4.00
151 data_timeout time 5m smtp
152 debug_print string* unset authenticators 4.00
154 unset transports 2.00
155 delay_after_cutoff boolean true smtp
156 delay_warning time list 24h main
157 delay_warning_condition string* + main 1.73
158 deliver_drop_privilege boolean false main 4.00
159 deliver_queue_load_max fixed-point unset main 1.70
160 delivery_date_add boolean false transports
161 delivery_date_remove boolean true main
162 dkim_canon string* unset smtp 4.70
163 dkim_domain string list* unset smtp 4.72
164 dkim_private_key string* unset smtp 4.70
165 dkim_selector string* unset smtp 4.70
166 dkim_sign_headers string* (RFC4871) smtp 4.70
167 dkim_strict string* unset smtp 4.70
168 dkim_verify_signers string* $dkim_signers main 4.70
169 directory string* unset appendfile
170 directory_file string* + appendfile
171 directory_mode octal-integer 0700 appendfile
172 directory_transport string* unset redirect 4.00
173 disable_ipv6 boolean false main 4.61
174 disable_logging boolean false routers 4.11
175 false transports 4.11
176 dns_again_means_nonexist domain list unset main 1.89
177 dns_check_names_pattern string + main 2.11
178 dns_csa_search_limit integer 5 main 4.60
179 dns_csa_use_reverse boolean true main 4.60
180 dns_ipv4_lookup boolean false main 3.20
181 dns_qualify_single boolean true smtp
182 dns_retrans time 0s main 1.60
183 dns_retry integer 0 main 1.60
184 dns_search_parents boolean false smtp
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_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
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_condition string* unset authenticators 3.10 (plaintext) 4.64 (others)
470 server_hostname string* "$primary_hostname" cyrus_sasl 4.43
471 server_mail_auth_condition string* unset authenticators 3.22
472 server_mech string public_name cyrus_sasl 4.43
473 server_prompts string* unset plaintext 3.10
474 server_realm string unset cyrus_sasl 4.43
475 server_secret string* unset cram_md5 3.10
476 server_service string "smtp" cyrus_sasl 4.43
477 server_set_id string* unset authenticators 3.10
478 shadow_condition string* unset transports
479 shadow_transport string unset transports
480 size_addition integer 1024 smtp 1.91
481 skip_syntax_errors boolean false redirect 4.00
482 smtp_accept_keepalive boolean true main
483 smtp_accept_max integer 20 main
484 smtp_accept_max_nonmail integer 10 main 4.11
485 smtp_accept_max_nonmail_hosts host list * main 4.14
486 smtp_accept_max_per_connection integer 1000 main 4.00
487 smtp_accept_max_per_host integer 0 main 2.05
488 smtp_accept_queue integer 0 main
489 smtp_accept_queue_per_connection integer 10 main 2.03
490 smtp_accept_reserve integer 0 main
491 smtp_active_hostname string* unset main 4.33
492 smtp_banner string* + main
493 smtp_check_spool_space boolean true main 2.10
494 smtp_connect_backlog integer 5 main
495 smtp_enforce_sync boolean true main 4.00
496 smtp_etrn_command string* unset main 1.92
497 smtp_etrn_serialize boolean true main 1.89
498 smtp_load_reserve fixed-point unset main
499 smtp_max_synprot_errors integer 3 main 4.30
500 smtp_max_unknown_commands integer 3 main 4.14
501 smtp_ratelimit_hosts host list unset main 4.00
502 smtp_ratelimit_mail string unset main 4.00
503 smtp_ratelimit_rcpt string unset main 4.00
504 smtp_receive_timeout time 5m main
505 smtp_reserve_hosts host list unset main
506 smtp_return_error_details boolean false main 4.11
507 socket string* unset lmtp 4.11
508 spamd_address string* + main 4.50 with content scan
509 split_spool_directory boolean false main 1.70
510 spool_directory string ++ main
511 sqlite_lock_timeout time 5s main 4.53
512 strict_acl_vars boolean false main 4.64
513 srv_fail_domains domain list unset dnslookup 4.43
514 strip_excess_angle_brackets boolean false main
515 strip_trailing_dot boolean false main
516 subject string* unset autoreply
517 syntax_errors_text string* unset redirect 4.00
518 syntax_errors_to string unset redirect 4.00
519 syslog_duplication boolean true main 4.21
520 syslog_facility string unset main 4.20
521 syslog_processname string "exim" main 4.20
522 syslog_timestamp boolean true main 4.00
523 system_filter string unset main 4.00 replacing message_filter
524 system_filter_directory_transport string unset main 4.00 replacing message_filter
525 system_filter_file_transport string unset main 4.00 replacing message_filter
526 system_filter_group string unset main 4.00 replacing message_filter
527 system_filter_pipe_transport string unset main 4.00 replacing message_filter
528 system_filter_reply_transport string unset main 4.00 replacing message_filter
529 system_filter_user string unset main 4.00 replacing message_filter
530 tcp_nodelay boolean true main 4.23
532 temp_errors string list + pipe 1.95
533 text string* unset autoreply
534 timeout time 5m lmtp 3.20
538 timeout_defer boolean false pipe 4.51
539 timeout_frozen_after time 0s main 3.20
540 timezone string + main 3.15
541 tls_advertise_hosts host list * main 3.20
542 tls_certificate string* unset main 3.20
544 tls_dhparam string* unset main 3.20
545 tls_on_connect_ports string unset main 4.43
546 tls_privatekey string* unset main 3.20
548 tls_remember_emstp boolean false main 4.21
549 tls_require_ciphers string* unset smtp 4.00 replaces tls_verify_ciphers
550 string* unset main 4.33
551 tls_tempfail_tryclear boolean true smtp 4.05
552 tls_try_verify_hosts host list unset main 4.00
553 tls_verify_certificates string* unset main 3.20
555 tls_verify_hosts host list unset main 3.20
556 to string* unset autoreply
557 translate_ip_address string unset routers 4.00
558 transport string* unset routers 4.00
559 transport_current_directory string unset routers 4.00
560 transport_home_directory string unset routers 4.00
561 transport_filter string unset transports
562 transport_filter_timeout time 5m transports 4.30
563 trusted_groups string list unset main
564 trusted_users string list unset main
565 umask octal-integer 022 pipe
566 unknown_login string unset main
567 unknown_username string unset main
568 unseen boolean false routers 4.00
569 untrusted_set_sender boolean false main 3.20
570 use_bsmtp boolean false appendfile 4.00
572 use_crlf boolean false appendfile 1.89
574 use_fcntl_lock boolean + appendfile 1.70
575 use_flock_lock boolean + appendfile 4.11
576 use_lockfile boolean + appendfile
577 use_mbx_lock boolean + appendfile 2.10
578 use_shell boolean false pipe 1.70
579 user string + routers 4.00
580 unset transports 4.00 replaces individual options
581 uucp_from_pattern string + main 1.75
582 uucp_from_sender string* "$1" main 1.75
583 verify boolean true routers 4.00
584 verify_only boolean false routers 4.00
585 verify_recipient boolean true routers 4.00
586 verify_sender boolean true routers 4.00
587 warn_message_file string unset main 4.00
588 widen_domains string list unset dnslookup 4.00
589 write_rejectlog boolean true main 4.31
593 2. COMMAND LINE OPTIONS
594 -----------------------
596 The table below contains a complete list of all Exim's command line options.
597 Those marked with # are available only to trusted users, those marked with +
598 are available only to admin users, and those marked with * exist only to
599 provide compatibility with Sendmail.
602 --help Give a little help (not a lot)
605 -bdf + Start daemon and run it in the foreground
606 -be Test string expansion
607 -bem Test string expansion, read test message first
608 -bF Test system filter file
609 -bf Test user filter file
610 -bfd Set domain for filter testing
611 -bfl Set local part for filter testing
612 -bfp Set local part prefix for filter testing
613 -bfs Set local part suffix for filter testing
614 -bh Test incoming SMTP call, omitting callouts
615 -bhc Test incoming SMTP call, with callouts
616 -bi * Run <command>bi_command</command>
617 -bm Accept message on standard input
618 -bmalware + Invoke configured malware scanning against supplied filename
619 -bnq Don't qualify addresses in locally submitted messages
620 -bP Show configuration option settings
622 -bpa + ... with generated addresses as well
623 -bpc + ... but just show a count of messages
624 -bpr + ... do not sort
625 -bpra + ... with generated addresses, unsorted
626 -bpru + ... only undelivered addresses, unsorted
627 -bpu + ... only undelivered addresses
628 -brt Test retry rules
629 -brw Test rewriting rules
630 -bS Read batch SMTP on standard input
631 -bs Run SMTP on standard input and output
632 -bt Test address directing and routing
633 -bV Verify version number
634 -bv Test recipient address verification
635 -bvs Test sender address verification
636 -C + Use alternate configuration file
637 -D + Define macro for configuration file
638 -d + Turn on debugging output
639 -dd + Ditto, but if a daemon, not for subprocesses
640 -dropcr Remove CR character in input: became a no-op in 4.21
642 -ex * Synonym for -oex (for several different x)
643 -F Set calling user name
644 -f # Set calling user address
647 -i Dot does not terminate message
648 -M + Force deliver specific message
649 -Mar + Add recipient to message
650 -MC Internal use only
651 -MCA Internal use only
652 -MCP Internal use only
653 -MCQ Internal use only
654 -MCS Internal use only
655 -MCT Internal use only
656 -Mc + Deliver specific message
657 -Mes + Edit message sender
658 -Mf + Freeze message(s)
659 -Mg + Give up (bounce) message(s)
660 -Mmad + Mark all recipients delivered
661 -Mmd + Mark one recipient delivered
662 -Mrm + Remove message(s) (no bounce)
663 -Mset + Load message's variables when testing with -be
664 -Mt + Thaw message(s)
665 -Mvb + View message body
666 -Mvc + View entire message in RFC 2822 format
667 -Mvh + View message header
668 -Mvl + View message log
670 -N + Deliver without transporting
673 -oA * Supply argument for <option>-bi</option>
674 -oB Set max messages down one connection
675 -odb Background delivery
676 -odf Foreground delivery
677 -odi Foreground delivery
678 -odq Queue message; do not deliver
679 -odqs ... do not do SMTP deliveries
680 -oee Error sent by mail; zero return code
681 -oem Error sent by mail; non-zero return code
682 -oep Error written to standard error stream
683 -oeq * Error written to standard error stream
684 -oew * Error sent by mail; non-zero return code
685 -oi Dot does not terminate message
686 -oitrue * Dot does not terminate message
687 -oMa # Supply host address
688 -oMaa # Supply authenticator name
689 -oMai # Supply authenticated id
690 -oMas # Supply authenticated sender
691 -oMi # Supply interface address
692 -oMr # Supply protocol name
693 -oMs # Supply host name
694 -oMt # Supply ident string
697 -oP * Specify path for daemon's pid file
698 -or Timeout non-SMTP messages
699 -os Timeout for SMTP messages
700 -ov * Verbose; same as -v
701 -oX Alternative port for daemon
702 -pd Delay Perl interpreter start
703 -ps Do not delay Perl interpreter start
704 -p<r>:<s> * Same as -oMr <r> -oMs <s>
706 -qf + ... force delivery ) Other combinations are
707 -qff + ... and include frozen messages ) possible. The syntax is
708 -qi + ... initial deliveries only )
709 -ql + ... local deliveries only ) -q[q][f][f][i|l][time]
710 -qq + Two-stage queue run )
713 -R Select by recipient in queue run
715 -Rff ... and frozen messages
716 -Rr ... using regular expression
717 -Rrf ... with forcing
718 -Rrff ... and frozen messages
720 -S Select by sender in queue run
722 -Sff ... and frozen messages
723 -Sr ... using regular expression
724 -Srf ... with forcing
725 -Srff ... and frozen messages
726 -Tqt * Used by Exim test suite; not recognized in normal use
727 -t Take recipients from header lines
729 -tls-on-connect Do TLS on startup (for legacy clients)
731 -v Verbose - shows SMTP dialogue and other delivery info
732 -x Ignored (AIX compatibility)
735 3. BUILD TIME OPTIONS FOR EXIM
736 ------------------------------
738 The table below contains a complete list of options that can be set in
739 Local/Makefile when building Exim. More information about individual options
740 can be found in src/EDITME and OS/Makefile-Default.
742 The second column below gives the type of option:
744 . `system' means the option is concerned with the operating system;
746 . `driver' means the option selects a driver to be included in the binary;
748 . `lookup' means the option selects a lookuptype to be included in the binary;
750 . `mandatory' means the option is required to be supplied;
752 . `recommended' means the option is recommended to be supplied;
754 . `optional' means what it says;
756 Those marked with * are specialized and are unlikely to be required in most
757 installations. Those that are marked with ** are commonly set in OS-specific
758 Makefiles. If you use any of these in your Local/Makefile, you may need to
759 reproduce some of the OS-specific settings. For example, in the Makefile for
760 Solaris (which is actually called OS/Makefile-SunOS5), there is
762 LIBS=-lsocket -lnsl -lkstat
764 If you use LIBS to add extra libraries, you must also include the OS ones in
765 your setting. It is better, in this particular case, to use EXTRALIBS, which is
766 empty by default, and is provided for just this reason. Of course, if you do
767 actually want to modify a setting from the OS-specific file, there is nothing
768 to stop you overriding it in your Local/Makefile.
770 Option Type Description
771 ------------------------------------------------------------------------------
773 ALT_CONFIG_PREFIX optional restricts location of -C files
774 ALT_CONFIG_ROOT_ONLY optional* privileged -C needs root (not exim)
775 APPENDFILE_MODE optional*
776 APPENDFILE_DIRECTORY_MODE optional*
777 APPENDFILE_LOCKFILE_MODE optional*
778 AR system command to build a library
779 AUTH_CRAM_MD5 driver include cram_md5 authenticator
780 AUTH_CYRUS_SASL driver include Cyrus SASL authenticator
781 AUTH_PLAINTEXT driver include plaintext authenticator
782 AUTH_SPA driver include SPA (NTLM) authenticator
783 AUTH_VARS=3 optional* number of $auth variables
784 BASENAME_COMMAND system** path to basename
785 BASE_62=62 optional* not normally changed for Unix
786 BIN_DIRECTORY mandatory Exim binary directory
787 CC system** C compiler
788 CFLAGS system** flags for C compiler
789 CHGRP_COMMAND system** path to chgrp
790 CHOWN_COMMAND system** path to chown
791 COMPRESS_COMMAND system path to a compress command
792 COMPRESS_SUFFIX system suffix added to compressed files
793 CONFIGURE_FILE mandatory Exim runtime configuration file
794 CONFIGURE_FILE_USE_EUID optional*
795 CONFIGURE_FILE_USE_NODE optional*
796 CONFIGURE_GROUP optional* alternate group for configuration file
797 CONFIGURE_OWNER optional* alternate owner for configuration file
798 CYRUS_PWCHECK_SOCKET optional socket for pwcheck daemon
799 DBMLIB optional** location of DBM library
800 DB_DIRECTORY_MODE optional* mode for hints directory
801 DB_LOCKFILE_MODE optional* mode for hints lock files
802 DB_LOCK_TIMEOUT optional* timeout for hints lock files
803 DB_MODE optional* mode for hints files
804 DEFAULT_CRYPT optional default crypt() function
805 DELIVER_IN_BUFFER_SIZE optional*
806 DELIVER_OUT_BUFFER_SIZE optional*
807 DISABLE_DKIM optional disables DKIM support
808 DISABLE_D_OPTION optional disables -D option
809 ERRNO_QUOTA optional* error code for system quota failures
810 EXICYCLOG_MAX optional number of old log files to keep
811 EXIMDB_DIRECTORY_MODE optional* for hints database directory
812 EXIMDB_LOCKFILE_MODE optional* for hints lock files
813 EXIMDB_MODE optional* mode for hints files
814 EXIMON_TEXTPOP system**
816 EXIM_GROUP mandatory group to use for Exim
817 EXIM_MONITOR optional set to eximon.bin to compile
819 EXIM_USER mandatory user to use for Exim
820 EXIWHAT_EGREP_ARG system** to find Exim processes from ps
821 EXIWHAT_KILL_SIGNAL system** -SIGUSER1 or numerical equivalent
822 EXIWHAT_MULTIKILL_CMD system**
823 EXIWHAT_MULTIKILL_ARG system**
824 EXIWHAT_PS_ARG system** to list all processes
825 EXIWHAT_PS_CMD system** path to ps command
826 EXTRALIBS system additional libraries
827 EXTRALIBS_EXIM system additional libraries for Exim only
828 EXTRALIBS_EXIMON system additional libraries for the monitor
829 FIXED_NEVER_USERS optional can't override at runtime
830 HAVE_ICONV system the iconv() function is available
831 HAVE_IPV6 system include IPv6 support
832 HEADERS_CHARSET optional charset for decoded header lines
833 HEADER_ADD_BUFFER_SIZE optional* buffer for header_add()
834 HEADER_MAXSIZE optional* max memory for message header
835 HOSTNAME_COMMAND system** path to hostname command
836 INCLUDE system path to include files
837 INFO_DIRECTORY optional directory for Info documentation
838 INPUT_DIRECTORY_MODE optional mode for input directory
839 IPV6_INCLUDE system additional includes for IPv6
840 IPV6_LIBS system additional libraries for IPv6
841 LDAP_LIB_TYPE optional type of LDAP library
842 LFLAGS system** link editor flags
843 LIBIDENTCFLAGS system C flags when compiling libident
844 LIBIDENTNAME system name for libident library
845 LIBRESOLV system** library for DNS resolver
846 LIBS system** additional libraries
847 LIBS_EXIM system** additional libraries for Exim ony
848 LIBS_EXIMON system** additional libraries for monitor
849 LOCAL_SCAN_SOURCE optional location of local_scan() source
850 LOG_DIRECTORY_MODE optional mode for log directory
851 LOG_FILE_PATH optional path to log files
852 LOG_MODE optional mode for log files
853 LOOKUP_CDB lookup include cdb lookup
854 LOOKUP_DBM lookup include dbm lookup
855 LOOKUP_DNSDB lookup include dnsdb lookup
856 LOOKUP_DSEARCH lookup include dsearch lookup
857 LOOKUP_INCLUDE lookup include files for lookups
858 LOOKUP_LDAP lookup include ldap lookup
859 LOOKUP_LIBS lookup include libraries for lookups
860 LOOKUP_LSEARCH lookup include all lsearch lookups
861 LOOKUP_MYSQL lookup include mysql lookup
862 LOOKUP_NIS lookup include nis lookup
863 LOOKUP_NISPLUS lookup include nisplus lookup
864 LOOKUP_ORACLE lookup include oracle lookup
865 LOOKUP_PGSQL lookup include pgsql lookup
866 LOOKUP_TESTDB lookup*
867 LOOKUP_WHOSON lookup include whoson lookup
868 MAKE_SHELL optional* shell to use for make
869 MAX_FILTER_SIZE optional* max file size for filter files
870 MAX_INCLUDE_SIZE optional* max file size for :include: files
871 MAX_LOCALHOST_NUMBER=256 optional* for when localhost_number is set
872 MAX_NAMED_LIST optional* max named lists of a given type
873 MAX_INTERFACES system maximum network interfaces
874 MSGLOG_DIRECTORY_MODE optional* mode for message log directory
875 MV_COMMAND system path to mv command
876 NO_SYMLINK optional install doesn't make 'exim" symlink
877 PCRE_CFLAGS system compile flags for PCRE library
878 PERL_CC system* compiler for Perl interface code
879 PERL_CCOPTS system* flags for same
880 PERL_COMMAND system path to Perl
881 PERL_LIBS system* library for compiling Perl interface
882 PID_FILE_PATH optional path to daemon's pid file
883 RADIUS_CONFIG_FILE optional path to Radius config file
884 RADIUS_LIB_TYPE optional type of RADIUS library
885 RANLIB system** path to ranlib command
886 RM_COMMAND system path to rm command
887 ROUTER_ACCEPT driver include accept router
888 ROUTER_DNSLOOKUP driver include dnslookup router
889 ROUTER_MANUALROUTE driver include manualroute router
890 ROUTER_IPLITERAL driver include ipliteral router
891 ROUTER_IPLOOKUP driver include iplookup router
892 ROUTER_REDIRECT driver include redirect router
893 ROUTER_QUERYPROGRAM driver include queryprogram router
894 SPOOL_DIRECTORY recommended path to spool directory
895 SPOOL_DIRECTORY_MODE optional mode of spool directory
896 SPOOL_MODE optional mode of spool files
897 STRING_SPRINTF_BUFFER_SIZE optional* buffer for string_sprintf()
898 STRIP_COMMAND optional* can be used to strp binaries
899 SUPPORT_A6 optional* support A6 DNS records
900 SUPPORT_CRYPTEQ optional support crypteq (if no auths)
901 SUPPORT_MAILDIR optional support for maildir delivery
902 SUPPORT_MAILSTORE optional support for mailstore delivery
903 SUPPORT_MBX optional support for MBX delivery
904 SUPPORT_MOVE_FROZEN_MESSAGES optional* support for frozen message moving
905 SUPPORT_PAM optional support for PAM authentication
906 SUPPORT_TLS optional support for TLS encryption over SMTP
907 SUPPORT_TRANSLATE_IP_ADDRESS optional* support for address translation
908 SYSLOG_LOG_PID optional add pid to syslog lines
909 SYSLOG_LONG_LINES optional do not split long syslog lines
910 SYSTEM_ALIASES_FILE optional defaults to /etc/aliases
911 TIMEZONE_DEFAULT optional default for timezone option
912 TLS_INCLUDE optional path to include files for TLS
913 TLS_LIBS optional additional libraries for TLS
914 TMPDIR system value for TMPDIR environment variable
915 TRANSPORT_APPENDFILE driver include appendfile transport
916 TRANSPORT_AUTOREPLY driver include autoreply transport
917 TRANSPORT_LMTP driver include lmtp transport
918 TRANSPORT_PIPE driver include pipe transport
919 TRANSPORT_SMTP driver include smtp transport
920 USE_DB system** use native DB interface
921 USE_GNUTLS optional use GnuTLS instead of OpenSSL
922 USE_READLINE optional try to load libreadline for -be
923 USE_TCP_WRAPPERS system link with tcpwrappers
924 USE_TDB optional use the tdb DB interface
925 WITH_OLD_CLAMAV_STREAM optional* use ClamAV API from before ClamAV 0.95
926 X11 system** X11 base directory
927 X11_LD_LIB system** X11 link library
928 XINCLUDE system** X11 include directory
929 XLFLAGS system** X11 link time flags
930 ZCAT_COMMAND system path to zcat command
933 4. BUILD TIME OPTIONS FOR EXIMON
934 --------------------------------
936 The table below contains a complete list of options that can be set in
937 Local/eximon.conf when building the Exim monitor. Where the default is shown as
938 ** it means that the text string is too long to fit in the table and is instead
939 given below. A blank default means that there is no default value.
941 ACTION_OUTPUT=no show output for every action
942 ACTION_QUEUE_UPDATE=yes update queue display after actions
943 BODY_MAX=20000 maximum body display
944 DOMAIN= domain to strip from window title
945 LOG_BUFFER=20K buffer for log tail
946 LOG_DEPTH=300 depth of log subwindow
947 LOG_FONT=** font for log display
948 LOG_STRIPCHARTS=** patterns for stripcharts
949 LOG_WIDTH=950 width of log subwindow
950 MENU_EVENT='Shift<Btn1Down>' keypress for menu
951 MIN_HEIGHT=162 minimum window height
952 MIN_WIDTH=103 minimum window width
953 QUALIFY_DOMAIN= local domain to strip from addresses
954 QUEUE_DEPTH=200 depth of queue subwindow
955 QUEUE_FONT=$LOG_FONT font for queue display
956 QUEUE_INTERVAL=300 queue refresh interval
957 QUEUE_MAX_ADDRESSES=10 max addresses to show in queue
958 QUEUE_STRIPCHART_NAME=queue name for queue stripchart
959 QUEUE_WIDTH=950 width of queue subwindow
960 SIZE_STRIPCHART= request partition size stripchart
961 SIZE_STRIPCHART_NAME=space name for size stripchart
962 START_SMALL=no if yes, start with small window
963 STRIPCHART_INTERVAL=60 stripchart refresh interval
964 TEXT_DEPTH=200 depth of text windows
965 WINDOW_TITLE="${hostname} eximon" window title
967 The default for LOG_FONT is
969 LOG_FONT=-misc-fixed-medium-r-normal-*-14-140-*-*-*-*-iso8859-1
971 and the default for LOG_STRIPCHARTS is
973 LOG_STRIPCHARTS='/ <= /in/
975 / => .+ R=local/local/
976 / => .+ T=[^ ]*smtp/smtp/'
978 That is, there are four stripcharts, named in, out, local, and smtp. The first
979 counts message arrivals, the second counts all deliveries, the third counts
980 deliveries where the router's name starts with "local", and the fourth counts
981 deliveries where the transport name contains "smtp".
983 **** End of OptionLists ****
projects / exim.git / blob