set_recipient

message:set_recipient(ENVELOPE)

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.

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: Version 2025.12.02-67ee9e96

The functionality described in this section requires version 2025.12.02-67ee9e96 of KumoMTA, or a more recent version.

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.