Skip to content

kumo.on('tsa_load_shaping_data', FUNCTION)

Since: Version 2023.08.22-4d895015

The functionality described in this section requires version 2023.08.22-4d895015 of KumoMTA, or a more recent version.

Called by the tsa-daemon whenever it is going to evaluate a newly received log record.

The event must return a Shaping object, as can be obtained via kumo.shaping.load.

It is recommended that you use the same list of filenames that you would use with the shaping helper so that the two services have a consensus on the shaping configuration.

tsa-daemon is only really concerned with automation rules defined by the shaping configuration.

local tsa = require 'tsa'
local kumo = require 'kumo'

kumo.on('tsa_init', function()
  tsa.start_http_listener {
    listen = '',
    trusted_hosts = { '', '::1' },

local cached_load_shaping_data = kumo.memoize(kumo.shaping.load, {
  name = 'tsa_load_shaping_data',
  ttl = '5 minutes',
  capacity = 4,

kumo.on('tsa_load_shaping_data', function()
  local shaping = cached_load_shaping_data {
    -- This is the default file used by the shaping helper
    -- in KumoMTA, which references the community shaping rules

    -- and maybe you have your own rules
  return shaping