Skip to Content

The MailTemplateVariable type of the TypeScript SDK, part of MailTemplateRender.

type MailTemplateVariable = {
  bodies: ('subject' | 'text' | 'html')[]
  description: string | null
  filledFromSample: boolean
  name: string
  sample: string | number | boolean | null
}

Fields

FieldTypeDescription
bodies('subject' | 'text' | 'html')[]Which fields reference it
descriptionstring | null
filledFromSamplebooleanTrue when the preview's sample stood in for a value not passed
namestring
samplestring | number | boolean | null

Used in

MailTemplateRender.

On this page