Rule.io SDK

---

Rule.io SDK / rcml/src / smsRfmSpec

Variable: smsRfmSpec

const smsRfmSpec: SmsRfmSpec

Defined in: rcml/src/sms/sms-rfm-spec.ts:251

Machine-readable SMS RFM specification.

Example

import { smsRfmSpec, smsPlaceholderSpec } from '@rule/rcml'

// Which inline nodes are valid in SMS content?
smsRfmSpec.flavors['sms-rfm-content'].inlineNodes
// → ['text', 'placeholder', 'hardbreak']

// Attribute schema for the link mark:
smsRfmSpec.marks['link'].attrs['track']
// → { type: 'boolean', required: true, description: '...' }

// Which placeholder types are allowed?
smsRfmSpec.nodes['placeholder'].attrs?.['type'].allowedValues
// → ['CustomField', 'Subscriber', 'User', 'RemoteContent', 'Date', 'Link']

// Cross-reference token syntax:
smsPlaceholderSpec.tokens['Link'].examples
// → ['[Link:Unsubscribe]', '[Link:WebBrowser]', '[Link:Optin]']