Rule.io SDK

Appearance

Rule.io SDK

Rule.io SDK / rcml/src / PlaceholderTokenSpec

Interface: PlaceholderTokenSpec

Defined in: rcml/src/email/placeholder-spec.ts:50

Describes one backend placeholder token type.

Properties ​

description ​

description: string

Defined in: rcml/src/email/placeholder-spec.ts:52

Human-readable description of what this token does at render time.

examples ​

examples: string[]

Defined in: rcml/src/email/placeholder-spec.ts:63

Representative valid tokens.

nestable? ​

optional nestable?: boolean

Defined in: rcml/src/email/placeholder-spec.ts:79

true when this token can appear nested inside the value of another token (e.g. [CustomField:...] inside a [RemoteContent:...] URL or a [Date:[CustomField:...]::format] type argument).

params? ​

optional params?: Record<string, PlaceholderParamSpec>

Defined in: rcml/src/email/placeholder-spec.ts:61

Named parameters appearing in the syntax, keyed by the placeholder name.

rfmPlaceholderType? ​

optional rfmPlaceholderType?: string

Defined in: rcml/src/email/placeholder-spec.ts:73

When present, this backend token maps to an RFM ::placeholder node whose type attribute equals this string.

Cross-reference:

ts
emailRfmSpec.nodes['placeholder'].attrs['type'].allowedValues

syntax ​

syntax: string

Defined in: rcml/src/email/placeholder-spec.ts:59

Syntax pattern for the token. Uses <param> for required parameters and [param] for optional ones. Where a token has two distinct syntactic forms (e.g. CustomField), both are shown separated by a newline.