mirror of https://github.com/mailscope/kumomta.git synced 2026-08-19 10:58:17 +00:00

Files

T

Wez Furlong 42bf5c5e61 docs: adjust reference to improve search terms

We've been hoping that mkdocs-material will ship the much anticipated
search enhancements for some time, but it's time to recognize that
we need to do something to improve the search results with how
things work right now.

This is a big commit that changes the titles of the various pages
from the code-annotated synopsis to just the name of the function.

This makes it much easier now to match things like `kumo.reject`
directly, but `reject` remains awkward to find.

I think this is the best that we can do at this time.

A few functions have been annotated with the `status: deprecated` to
show as deprecated in the toc/nav (shows with a little trash can next
to the name).

2025-05-16 14:02:19 -07:00

834 B

Raw Blame History

set_mx_timeout

kumo.dns.set_mx_timeout(DURATION)

Set overall time limit for MX record resolution. This applies to the MX record resolution, rather than the resolution of MX hosts into addresses.

DURATION is either a number expressed as optionally fractional seconds, or a human readable duration string like "5s" to specify the units.

The default value for this is "5 seconds".

!!! note This timeout is layered over any internal timeout that the underlying DNS resolver might be configured to use, which means that the effective timeout will be the smallest of both this value and what is configured for the underlying resolver.

kumo.on('pre_init', function()
  kumo.dns.set_mx_timeout(5)
  -- or alternatively: kumo.dns.set_mx_timeout("5s")
end)

834 B Raw Blame History

set_mx_timeout

834 B

Raw Blame History