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

624 B

Raw Blame History

kumo.define_spool

kumo.define_spool { PARAMS }

Defines a named spool storage backend.

KumoMTA uses separate storage areas for metadata and message contents, named "meta" and "data" respectively.

This function should be called only from inside your init event handler.

kumo.on('init', function()
  kumo.define_spool {
    name = 'data',
    path = '/var/spool/kumo/data',
  }
  kumo.define_spool {
    name = 'meta',
    path = '/var/spool/kumo/meta',
  }
end)

PARAMS is a lua table that can accept the keys listed below:

624 B Raw Blame History

kumo.define_spool

Spool Parameters { data-search-exclude }

624 B

Raw Blame History