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