Files
kumomta/docs/reference/message/set_due.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

32 lines
1.1 KiB
Markdown

# set_due
```lua
message:set_due(due)
```
{{since('2024.06.10-84e84b89')}}
This method overrides the next delivery time for the message. The *due* parameter
may be:
* `nil` - to indicate that delivery should be attempted as soon as possible.
* an ISO 8601 date and timestamp to specify the time of the next delivery attempt.
`msg:set_due("2024-03-08T17:51:42.481711Z")`
Setting the due time is only valid in certain limited circumstances:
* Immediately at reception in either the
[smtp_server_message_received](../events/smtp_server_message_received.md) or
[http_message_generated](../events/http_message_generated.md) events, although
it is much simpler to use the [message:set_scheduling](set_scheduling.md) method
in almost all cases.
* During spooling in the
[spool_message_enumerated](../events/spool_message_enumerated.md) event, where
it is anticipated that re-binding a message for immediate delivery would be
the most likely use-case.
!!! warning
Using this method in any other way can result in non-deterministic,
undefined and unsupported behavior.