EmailNotificationInputType

Attributes of an email notification, the same ones that can be set in an emails/*.liquid file

type EmailNotificationInputType {
  attachments: String
  bcc: String
  cc: String
  content: String
  delay_by: String
  form_configuration_ids: [ID]
  from: String
  layout: String
  layout_path: String
  manually_managed: Boolean
  metadata: HashObject
  name: String
  physical_file_path: String!
  reply_to: String
  subject: String!
  to: String
  trigger_condition: String
}

Fields

attachments (String)

Liquid code rendering to a JSON object of attachments keyed by file name, for
example { "file_name.jpg": { "url": "https://example.com/file.jpg" } }

bcc (String)

Liquid code rendering to a comma-separated list of blind carbon copy recipients

cc (String)

Liquid code rendering to a comma-separated list of carbon copy recipients

content (String)

Liquid code rendered into the HTML body of the email. The data argument of
email_send is available in the data variable. Required

delay_by (String)

Number of minutes email_send waits before sending the email, given as a plain
number, for example 60. Defaults to 0, sent right away

form_configuration_ids (ID)

Deprecated, ids of legacy forms that send the email; replaces the current list

from (String)

Liquid code rendering to the sender address, for example [email protected]. Required

layout (String)

Name of the layout the rendered content is injected into, for example mailer; must be an existing layout

layout_path (String)

Deprecated, use layout

manually_managed (Boolean)

When true, pos-cli deploy and sync never overwrite or delete it and pos-cli
pull skips it. When omitted, defaults to the track_manually_managed setting of
the instance (false unless enabled in app/config.yml)

metadata (HashObject)

Arbitrary JSON data stored with the email (the metadata section of the file)

name (String)

Deprecated, the name is derived from physical_file_path. Name used to send the email with the email_send mutation

physical_file_path (String)

Path of the file the email is stored as, used by pos-cli pull and deploy. Must
be emails/<name>.liquid (or legacy
notifications/email_notifications/<name>.liquid), optionally prefixed with
modules/<module_name>/public/ or modules/<module_name>/private/, for
example emails/welcome.liquid

reply_to (String)

Liquid code rendering to the address replies should go to, for example [email protected]

subject (String)

Liquid code rendered into the subject line

to (String)

Liquid code rendering to a comma-separated list of recipients, for example [email protected], [email protected]

trigger_condition (String)

Liquid code; the email is sent only when it renders to true. Defaults to true