Files
kumomta/docs/reference/message/import_scheduling_header.md
T
Wez Furlong 2b0ba702cb add scheduling constraints
This is implemented by allowing the Message:set_due method to
load the message metadata to consult the scheduling constraints,
which should mean that all scheduling updates have the constraints
applied to them.
2023-03-01 09:43:48 -07:00

26 lines
816 B
Markdown

# `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()](set_scheduling.md) parameters. If successful, it
will call [message:set_scheduling()](set_scheduling.md) with that value, and if
*REMOVE* is set to true, will remove the header from the message.
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:
```lua
kumo.on('smtp_server_message_received', function(msg)
msg:import_scheduling_header 'X-Schedule'
end)
```