Skip to main content

DocumentEmailPreview

A rendered sample of one outbound document email.

type DocumentEmailPreview {
  html: String!
  locale: String!
  subject: String!
  templateVersion: Int!
  type: String!
}

Fields​

DocumentEmailPreview.html ● String! non-null scalar​

Fully rendered email body HTML

DocumentEmailPreview.locale ● String! non-null scalar​

Resolved content locale: 'en' | 'es' | 'fr' | 'ms'

DocumentEmailPreview.subject ● String! non-null scalar​

The subject line.

DocumentEmailPreview.templateVersion ● Int! non-null scalar​

The version of the template used.

DocumentEmailPreview.type ● String! non-null scalar​

Registry key, e.g. 'QUOTE' | 'INVOICE' | 'PAYMENT_RECEIPT'

Returned By​

previewDocumentEmail query