Rule.io SDK

---

Rule.io SDK / rcml/src / RcmlPublicAttrSpec

Interface: RcmlPublicAttrSpec

Defined in: rcml/src/email/rcml-spec.ts:31

Public descriptor for a single attribute.

Properties

allowedValues?

optional allowedValues?: string[]

Defined in: rcml/src/email/rcml-spec.ts:47

Allowed values — populated only for enum-type attributes.

---

default?

optional default?: string | number | boolean | null

Defined in: rcml/src/email/rcml-spec.ts:41

Default value applied when the attribute is omitted.

---

description

description: string

Defined in: rcml/src/email/rcml-spec.ts:43

Human-readable explanation of what the attribute does.

---

examples?

optional examples?: string[]

Defined in: rcml/src/email/rcml-spec.ts:45

Representative valid values.

---

required

required: boolean

Defined in: rcml/src/email/rcml-spec.ts:39

true when the attribute has no declared default value and should be provided explicitly. Derived from the absence of a default in the internal schema — use as authoring guidance rather than a strict validator constraint.

---

type

type: string

Defined in: rcml/src/email/rcml-spec.ts:33

Validator type key, e.g. 'color', 'padding', 'px', 'enum'.