ObjectStackEmail Template
Email Template protocol schemas
Email Template Metadata Protocol
Declarative template definition consumed by IEmailService.sendTemplate()
to render outbound mail. Persisted as rows of sys_email_template so
administrators can author/edit/translate templates in Studio without
shipping code, and tenants can override the built-in defaults
(allowOrgOverride: true in the metadata registry).
Aligned with Salesforce EmailTemplate and ServiceNow
sysevent_email_action conventions: a single named template is
resolved by (name, locale); subject/body strings carry simple
{{path.to.value}} placeholders rendered against a per-send
data payload.
Source: packages/spec/src/system/email-template.zod.ts
TypeScript Usage
import { EmailTemplateDefinitionSchema, EmailTemplateDefinitionCategorySchema, EmailTemplateDefinitionVariableSchema } from '@objectstack/spec/system';
import type { EmailTemplateDefinition, EmailTemplateDefinitionCategory, EmailTemplateDefinitionVariable } from '@objectstack/spec/system';
// Validate data
const result = EmailTemplateDefinitionSchema.parse(data);EmailTemplateDefinition
Properties
| Property | Type | Required | Description |
|---|---|---|---|
| name | string | ✅ | Template identifier (dotted snake_case) |
| label | string | ✅ | Display label |
| category | Enum<'auth' | 'notification' | 'workflow' | 'marketing' | 'custom'> | ✅ | |
| locale | string | ✅ | BCP-47 locale (e.g. en-US, zh-CN) |
| subject | string | ✅ | Subject template |
| bodyHtml | string | ✅ | HTML body template |
| bodyText | string | optional | Plain-text body template (auto-derived from HTML when omitted) |
| variables | { name: string; type: Enum<'string' | 'number' | 'boolean' | 'date' | 'url' | 'user' | 'record'>; required: boolean; description?: string }[] | ✅ | |
| fromOverride | { name?: string; address: string } | optional | |
| replyTo | string | optional | |
| active | boolean | ✅ | |
| isSystem | boolean | ✅ | |
| description | string | optional | |
| protection | { lock: Enum<'none' | 'no-overlay' | 'no-delete' | 'full'>; reason: string; docsUrl?: string } | optional | Package author protection block — lock policy for this email template. |
| _lock | Enum<'none' | 'no-overlay' | 'no-delete' | 'full'> | optional | Item-level lock — controls overlay & delete (ADR-0010). |
| _lockReason | string | optional | Human-readable reason shown when a write is refused by _lock. |
| _lockSource | Enum<'artifact' | 'package' | 'env-forced'> | optional | Layer that set _lock (artifact | package | env-forced). |
| _provenance | Enum<'package' | 'org' | 'env-forced'> | optional | Origin of the item (package | org | env-forced). |
| _packageId | string | optional | Owning package machine id. |
| _packageVersion | string | optional | Owning package version. |
| _lockDocsUrl | string | optional | Optional documentation link surfaced next to _lockReason. |
EmailTemplateDefinitionCategory
Allowed Values
authnotificationworkflowmarketingcustom
EmailTemplateDefinitionVariable
Properties
| Property | Type | Required | Description |
|---|---|---|---|
| name | string | ✅ | Variable name as referenced in placeholders (snake_case or dotted path) |
| type | Enum<'string' | 'number' | 'boolean' | 'date' | 'url' | 'user' | 'record'> | ✅ | |
| required | boolean | ✅ | |
| description | string | optional | Author hint shown in Studio |