Files
kumomta/docs/reference/events/spool_message_enumerated.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

22 lines
826 B
Markdown

# spool_message_enumerated
```lua
kumo.on('spool_message_enumerated', function(message) end)
```
Called by the spool layer during spool enumeration during server startup.
When kumod starts, after the `init` event has triggered, the spool subsystem
begins enumeration of messages to build up the queues.
For each message discovered in the spool, the `spool_message_enumerated`
event will fire prior to inserting the message into a queue.
This event gives the operator the ability to handle situations such as the
removal of a queues/paths/sources by allowing you to re-assign the queue
meta value to place the message into a different queue from that the one
that was selected during the original reception of the message.
Errors raised during the evaluation of this hook will prevent the server
from completing startup.