Skip to main content

EmailEventInput

No description

input EmailEventInput {
type: EmailEventType!
siteId: Int
orderId: Int
userId: Int
letterId: String
subject: String
content: String
from: EmailSendContactInput
to: [EmailSendContactInput!]
attachments: [Base64FileInput!]
variables: JSONObject
language: String
}

Fields

EmailEventInput.type ● EmailEventType! non-null enum

The type of email event to trigger

EmailEventInput.siteId ● Int scalar

The id of the site to use when sending the email, required when the site can not be derived from other inputs

EmailEventInput.orderId ● Int scalar

The id of the order to use when triggering an event of type orderconfirm

EmailEventInput.userId ● Int scalar

The id of the user to send to email to. Can be used to replace to, when the user can't be derived from other inputs

EmailEventInput.letterId ● String scalar

The id of the Propeller letter to use when type is 'campaign'

EmailEventInput.subject ● String scalar

The subject of the email, use when the subject can not be derived from other inputs

EmailEventInput.content ● String scalar

The content of the email, use when the content can not be derived from other inputs

EmailEventInput.from ● EmailSendContactInput input

The sender of the email, use when the sender can not be derived from other inputs

EmailEventInput.to ● [EmailSendContactInput!] list input

The recipient(s) of the email, use when the recipient(s) can not be derived from other inputs

EmailEventInput.attachments ● [Base64FileInput!] list input

Attachments to add to the email

EmailEventInput.variables ● JSONObject scalar

Variables that can be used in the email template

EmailEventInput.language ● String scalar

The language of the generated email

Member Of

publishEmailEvent mutation