Skip to main content

Interface: PasswordResetLinkEmailInput

Defined in: type/PasswordResetLinkEmailInput.ts:7

Input object for PasswordResetLinkEmailInput

Properties​

attachments?​

optional attachments?: Base64FileInput[]

Defined in: type/PasswordResetLinkEmailInput.ts:25

Attachments to add to the email

content?​

optional content?: string

Defined in: type/PasswordResetLinkEmailInput.ts:21

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

email​

email: string

Defined in: type/PasswordResetLinkEmailInput.ts:31

The email address of the user to generate the recovery link for

from?​

optional from?: EmailSendContactInput

Defined in: type/PasswordResetLinkEmailInput.ts:23

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

language?​

optional language?: string

Defined in: type/PasswordResetLinkEmailInput.ts:29

language input field

letterId?​

optional letterId?: string

Defined in: type/PasswordResetLinkEmailInput.ts:17

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

linkText?​

optional linkText?: string

Defined in: type/PasswordResetLinkEmailInput.ts:35

Text to display that will lead to link when clicked

orderId?​

optional orderId?: number

Defined in: type/PasswordResetLinkEmailInput.ts:13

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

redirectUrl?​

optional redirectUrl?: string

Defined in: type/PasswordResetLinkEmailInput.ts:33

The page the user will be redirected to after the user changed their password.

siteId?​

optional siteId?: number

Defined in: type/PasswordResetLinkEmailInput.ts:11

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

subject?​

optional subject?: string

Defined in: type/PasswordResetLinkEmailInput.ts:19

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

type​

type: EmailEventType

Defined in: type/PasswordResetLinkEmailInput.ts:9

The type of email event to trigger

userId?​

optional userId?: number

Defined in: type/PasswordResetLinkEmailInput.ts:15

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/PasswordResetLinkEmailInput.ts:27

Variables that can be used in the email template