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