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