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