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