Rule.io SDK

---

Rule.io SDK / rcml/src / RcmlPreview

Interface: RcmlPreview

Defined in: rcml/src/email/rcml-types.ts:155

<rc-preview> — preheader text shown in inbox previews.

content accepts a plain string (the shape builders produce) or a { type: 'text', text } object (the shape the Rule.io API returns on read — it serialises every leaf's content uniformly, with no special case for rc-preview). Both are equivalent; treat them as the same preheader text.

Properties

content?

optional content?: string | { text: string; type: "text"; }

Defined in: rcml/src/email/rcml-types.ts:158

---

id?

optional id?: string

Defined in: rcml/src/email/rcml-types.ts:156

---

tagName

tagName: "rc-preview"

Defined in: rcml/src/email/rcml-types.ts:157