mirror of
https://github.com/mailscope/kumomta.git
synced 2026-09-13 14:02:13 +00:00
Wez Furlong
6f53931fde
These functions are similar to the existing invoke_get_egress_path_config and invoke_get_queue_config functions; they return the configuration information that is defined by your overall policy in the same way that the system does. The intent is for more advanced policies that need that info to decide how to configure other parts of the policy. Docs are included, and I fleshed out the missing docs for the two pre-existing functions.
923 B
923 B
kumo.invoke_get_egress_source
local config = kumo.invoke_get_egress_source(source_name)
{{since('dev')}}
This function triggers a call through to the
get_egress_source event callback(s)
that have been defined in the policy to obtain the effective configuration for
the specified source_name.
The result of that is then serialized and returned as a lua value that has the
same shape as the PARAMS defined for
kumo.make_egress_source.
This function may be satisfied by the internal cache of resolved source
configuration information, so it may not directly trigger the
get_egress_source callback every time that it is called.
!!! danger
Take care when using this function and its related invoke_xxx functions,
as you can potentially create cross-dependent, mututally recursive,
event callbacks that call into each other.