@rule/rcml
v0.4.0-beta.9
Published
RCML email template builders and type definitions for the Rule.io SDK.
Readme
@rule/rcml
RCML (Rule Campaign Markup Language) template builders and type definitions. Use this package to compose email templates that you can send through the Rule.io API via @rule/client (or one of the vendor presets).
import {
createRCMLDocument,
createBrandTemplate,
} from '@rule/rcml';What's included
- Primitives:
createRCMLDocument,createSection,createHeading,createText,createButton,createImage,createLogo,createSpacer,createDivider,createLoop,createSwitch/createCase,createSocial/createSocialElement, and related helpers - Brand-style helpers:
createBrandTemplate,createBrandHead,createBrandLogo,createBrandHeading,createBrandText,createBrandButton,createContentSection,createFooterSection,createStatusTrackerSection,createAddressBlock,validateCustomFields - Types: full RCML structural type hierarchy (
RCMLDocument,RCMLSection,RCMLProseMirrorDoc, etc.) - Automation config schema:
AutomationConfigV2,TemplateConfigV2,getAutomationByIdV2,getAutomationByTriggerV2
See the main @rule/sdk README for end-to-end usage examples.
