Interface EmailPreview

Preview of an email message. For full message (including body and attachments) call the getEmail or other email endpoints with the provided email ID.

Export

Interface

EmailPreview

Hierarchy

  • EmailPreview

Properties

attachments?: string[]

List of IDs of attachments found in the email. Use these IDs with the Inbox and Email Controllers to download attachments and attachment meta data such as filesize, name, extension.

Memberof

EmailPreview

bcc?: string[]

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

Memberof

EmailPreview

cc?: string[]

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

Memberof

EmailPreview

createdAt: Date

When was the email received by MailSlurp

Memberof

EmailPreview

domainId?: string

ID of the domain that received the email

Memberof

EmailPreview

from?: string

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

Memberof

EmailPreview

id: string

ID of the email entity

Memberof

EmailPreview

read: boolean

Read flag. Has the email ever been viewed in the dashboard or fetched via the API with a hydrated body? If so the email is marked as read. Paginated results do not affect read status. Read status is different to email opened event as it depends on your own account accessing the email. Email opened is determined by tracking pixels sent to other uses if enable during sending. You can listened for both email read and email opened events using webhooks.

Memberof

EmailPreview

subject?: string

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

Memberof

EmailPreview

to: string[]

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

Memberof

EmailPreview