mirror of
https://github.com/KumoCorp/kumomta.git
synced 2026-08-18 16:01:07 +00:00
Wez Furlong
42bf5c5e61
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).
1.3 KiB
1.3 KiB
import_scheduling_header
message:import_scheduling_header(HEADER_NAME, REMOVE)
Reads the header specified and attempts to parse it as JSON-encoded version of the message:set_scheduling() parameters. If successful, it will call message:set_scheduling() with that value, and if REMOVE is set to true, will remove the header from the message.
The return value of message:import_scheduling_header is:
- A lua table representation of the scheduling parameters, or nil if the specified header was not present. {{since('2025.03.19-1d3f1f67', inline=True)}}
nilin prior versions of KumoMTA.
If the header is present, but has invalid contents the behavior will be:
- An error will be raised explaining the issue. {{since('2025.03.19-1d3f1f67', inline=True)}}
- No error indication will be given and no errors will be logged in prior versions of KumoMTA.
For example, given this message:
X-Schedule: {"dow":"Mon,Wed","tz":"America/Phoenix","start":"09:00:00","end":"17:00:00"}
Subject: hello
This message should only be delivered during working hours
in Phoenix on Mondays or Wednesdays.
this policy script will parse and remove that header, and apply the scheduling constraints:
kumo.on('smtp_server_message_received', function(msg)
msg:import_scheduling_header('X-Schedule', true)
end)