Files
kumomta/docs/reference/kumo/make_egress_source/_index.md
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

584 B

kumo.make_egress_source

kumo.make_egress_source { PARAMS }

Defines an egress source, which is an entity associated with the source of outbound traffic from the MTA. A source must be referenced by a pool to be useful.

This function is intended to be used inside your get_egress_source event handler.

A source must have at a minimum a name, which will be used in logging/reporting.

PARAMS is a lua table which may have the following keys:

Egress Source Parameters { data-search-exclude }