Homepage

EmailNotification

Last edit: Oct 26, 2022

Email Notification

type EmailNotification implements AdminSharedAttributesInterface {
  attachments: String
  bcc: String
  cc: String
  content: String
  created_at: JSONDate!
  delay_by: String
  form_configurations: [FormConfiguration!]
  forms: [Form!]
  from: String
  id: ID!
  layout: String
  layout_path: String
  metadata: HashObject
  name: String!
  physical_file_path: String
  reply_to: String
  subject: String
  to: String
  trigger_condition: String
  updated_at: JSONDate!
}

Fields

attachments (String)

json of the form { "file_name.jpg": { "url": "http://example.com/file.jpg" } }
which defines email attachments. Liquid will be processed.

bcc (String)

Comma separated blind carbon copy list. Liquid allowed. For example "[email protected], [email protected]"

cc (String)

Comma separated carbon copy list. Liquid allowed. For example "[email protected], [email protected]"

content (String)

liquid code to evaluate to valid form html. If email is triggered via form
configuration, You have access to "form" variable, with data specified in the configuration.

created_at (JSONDate)

delay_by (String)

liquid code which should evaluate to integer. Delays invoking the job by
specified number of minutes. Useful to invoke code at certain point in time,
for example 1 hour before something etc. To calculate proper number you can
use time_diff filter.

form_configurations (FormConfiguration)

form configurations which trigger the email

forms (Form)

forms which trigger the email

from (String)

email address from which you would like to send the email, for example [email protected]

id (ID)

layout (String)

name of the liquid layout to which the content should be injected

layout_path (String)

name of the liquid layout to which the content should be injected

metadata (HashObject)

name (String)

name of the email, which is used in form_configurations or mutation to trigger it

physical_file_path (String)

defines the physical path of the file

reply_to (String)

email address to which users should reply, for example [email protected]

subject (String)

liquid code to evaluate to text

to (String)

Comma separated recipient list. Liquid allowed. For example: "[email protected], [email protected]"

trigger_condition (String)

liquid code which should evaluate to true if the email should be sent

updated_at (JSONDate)

Interfaces

AdminSharedAttributesInterface

Contribute to this page

Github Icon

Questions?

We are always happy to help with any questions you may have.

contact us