Email Template

amerta

---

amerta / payload-types / EmailTemplate

Interface: EmailTemplate

Defined in: payload-types.ts:3197

Manage transactional emails.

This interface was referenced by Config's JSON-Schema via the definition "email-templates".

Properties

bccAddress?

optional bccAddress: string | null

Defined in: payload-types.ts:3229

comma separated email addresses to BCC on this email

---

body

body: string

Defined in: payload-types.ts:3199

---

category?

optional category: string | null

Defined in: payload-types.ts:3200

---

createdAt

createdAt: string

Defined in: payload-types.ts:3231

---

enabled?

optional enabled: boolean | null

Defined in: payload-types.ts:3201

---

id

id: string

Defined in: payload-types.ts:3198

---

staffRecipients?

optional staffRecipients: (string | User)[] | null

Defined in: payload-types.ts:3225

Who receives this alert?

---

subject

subject: string

Defined in: payload-types.ts:3221

---

type

type: "new_order" | "cancelled_order" | "failed_order" | "new_account" | "customer_cancelled_order" | "customer_failed_order" | "customer_on_hold_order" | "customer_processing_order" | "customer_completed_order" | "customer_shipped_order" | "customer_refunded_order" | "customer_invoice" | "customer_new_account" | "customer_verify_email" | "customer_reset_password"

Defined in: payload-types.ts:3205

Determines when this email is sent.

---

updatedAt

updatedAt: string

Defined in: payload-types.ts:3230