Files
kumomta/docs/reference/message/set_recipient.md
T
Wez Furlong db5ebb88a7 message: expose recipient list to lua api
message:recipient() may now return an array style table
holding the recipient list, if there is more than a single
recipient on the message.

Since this can be somewhat ambiguous/frustrating to work with,
there is now also a message:recipient_list() that will always
return an array style table, even if it holds just a single
element.

The included helpers have been updated to use `message:recipient_list`.

message:set_recipient() will now optionally accept an array
style table holding the recipient list to be set.
2025-10-07 07:52:58 +01:00

661 B

set_recipient

message:set_recipient(ENVELOPE)

{{since('2023.08.22-4d895015')}}

Sets the envelope recipient of the message. The value can be an EnvelopeAddress or a string that can be parsed into an EnvelopeAddress.

message:set_recipient 'someone.else@example.com'

See also message:set_sender.

Recipient List

{{since('dev')}}

The value can be an array style table holding one EnvelopeAddress for each recipient that you wish to assign to the message.

!!! note At the time of writing, only the SMTP and maildir delivery protocols have support for multi-recipient messages.