mirror of https://github.com/mailscope/kumomta.git synced 2026-08-20 19:38:18 +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

788 B

Raw Blame History

rebind_message

kumo.on('rebind_message', function(message, data) end)

This event is triggered when processing a rebind request that was triggered by the /api/admin/rebind/v1 HTTP endpoint (which is is what is used by the kcli rebind command).

This event is only triggered when trigger_rebind_event is set in the incoming request.

The purpose of the event is for you to perform an optional, site-specific modification to the message and/or its metadata in response to the rebind request.

The data parameter is the verbatim data field from the request.

kumo.on('rebind_message', function(msg, data)
  if some_condition then
    msg:set_meta('queue', data.queue)
  end
end)

788 B Raw Blame History

rebind_message

788 B

Raw Blame History