Skip to main content

Interface: EmailEventInput

Defined in: type/EmailEventInput.ts:7

Input object for EmailEventInput

Properties​

attachments?​

optional attachments?: Base64FileInput[]

Defined in: type/EmailEventInput.ts:25

Attachments to add to the email

content?​

optional content?: string

Defined in: type/EmailEventInput.ts:19

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

from?​

optional from?: EmailSendContactInput

Defined in: type/EmailEventInput.ts:21

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

language?​

optional language?: string

Defined in: type/EmailEventInput.ts:29

The language of the generated email

letterId?​

optional letterId?: string

Defined in: type/EmailEventInput.ts:15

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

orderId?​

optional orderId?: number

Defined in: type/EmailEventInput.ts:11

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

subject?​

optional subject?: string

Defined in: type/EmailEventInput.ts:17

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

to?​

optional to?: EmailSendContactInput[]

Defined in: type/EmailEventInput.ts:23

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

type​

type: EmailEventType

Defined in: type/EmailEventInput.ts:9

The type of email event to trigger

userId?​

optional userId?: number

Defined in: type/EmailEventInput.ts:13

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

variables?​

optional variables?: any

Defined in: type/EmailEventInput.ts:27

Variables that can be used in the email template