Rule.io SDK

---

Rule.io SDK / rcml/src / createPreviewElement

Function: createPreviewElement()

createPreviewElement(options?): RcmlPreview

Defined in: rcml/src/email/create-rcml-element.ts:1064

Build an <rc-preview> — the preheader text that mail clients show next to the subject line in the inbox list.

Parameters

options?

PreviewElementOptions = {}

options.content is the preheader string (rendered verbatim). Omit to leave the preheader empty.

Returns

RcmlPreview

A typed RcmlPreview node.

Example

createPreviewElement({ content: 'See inside for 20% off' })