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