MailSlurp JS / WebhookNewEmailPayload

Interface: WebhookNewEmailPayload

NEW_EMAIL webhook payload. Sent to your webhook url endpoint via HTTP POST when an email is received by the inbox that your webhook is attached to. Use the email ID to fetch the full email body or attachments.

export

interface WebhookNewEmailPayload

Table of contents

Properties

Properties

attachmentMetaDatas

Optional attachmentMetaDatas: AttachmentMetaData[]

List of attachment meta data objects if attachments present

memberof WebhookNewEmailPayload

Defined in

src/generated/api.ts:6680


bcc

Optional bcc: string[]

List of BCC recipients email addresses that the email was addressed to. See recipients object for names.

memberof WebhookNewEmailPayload

Defined in

src/generated/api.ts:6686


cc

Optional cc: string[]

List of CC recipients email addresses that the email was addressed to. See recipients object for names.

memberof WebhookNewEmailPayload

Defined in

src/generated/api.ts:6692


createdAt

Optional createdAt: Date

Date time of event creation

memberof WebhookNewEmailPayload

Defined in

src/generated/api.ts:6698


emailId

Optional emailId: string

ID of the email that was received. Use this ID for fetching the email with the EmailController.

memberof WebhookNewEmailPayload

Defined in

src/generated/api.ts:6704


eventName

Optional eventName: EventNameEnum

Name of the event type webhook is being triggered for.

memberof WebhookNewEmailPayload

Defined in

src/generated/api.ts:6710


from

Optional from: string

Who the email was sent from. An email address - see fromName for the sender name.

memberof WebhookNewEmailPayload

Defined in

src/generated/api.ts:6716


inboxId

Optional inboxId: string

Id of the inbox that received an email

memberof WebhookNewEmailPayload

Defined in

src/generated/api.ts:6722


messageId

Optional messageId: string

Idempotent message ID. Store this ID locally or in a database to prevent message duplication.

memberof WebhookNewEmailPayload

Defined in

src/generated/api.ts:6728


subject

Optional subject: string

The subject line of the email message as specified by SMTP subject header

memberof WebhookNewEmailPayload

Defined in

src/generated/api.ts:6734


to

Optional to: string[]

List of To recipient email addresses that the email was addressed to. See recipients object for names.

memberof WebhookNewEmailPayload

Defined in

src/generated/api.ts:6740


webhookId

Optional webhookId: string

ID of webhook entity being triggered

memberof WebhookNewEmailPayload

Defined in

src/generated/api.ts:6746


webhookName

Optional webhookName: string

Name of the webhook being triggered

memberof WebhookNewEmailPayload

Defined in

src/generated/api.ts:6752