Rule.io SDK

---

Rule.io SDK / rcml/src / placeholderSpec

Variable: placeholderSpec

const placeholderSpec: PlaceholderSpec

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

Machine-readable placeholder specification.

Example

import { placeholderSpec } from '@rule/rcml'

// All token type names
Object.keys(placeholderSpec.tokens)
// → ['CustomField', 'Subscriber', 'User', 'Date', ...]

// Cross-reference: which tokens map to RFM ::placeholder types?
Object.entries(placeholderSpec.tokens)
  .filter(([, t]) => t.rfmPlaceholderType !== undefined)
  .map(([k]) => k)
// → ['CustomField', 'Subscriber', 'User', 'Date', 'RemoteContent']

// Allowed values for the Subscriber field parameter
placeholderSpec.tokens['Subscriber'].params?.['field'].allowedValues
// → ['email', 'phone_number', 'language']