Interface: Email

Email entity (also known as EmailDto). When an SMTP email message is received by MailSlurp it is parsed. The body and attachments are written to disk and the fields such as to, from, subject etc are stored in a database. The body contains the email content. If you want the original SMTP message see the getRawEmail endpoints. The attachments can be fetched using the AttachmentController

export

interface Email

Table of contents

Properties

Properties

analysis

Optional analysis: EmailAnalysis

memberof Email


attachments

Optional 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 Email


bcc

Optional bcc: string[]

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

memberof Email


body

Optional body: string

The body of the email message as text parsed from the SMTP message body (does not include attachments). Fetch the raw content to access the SMTP message and use the attachments property to access attachments. The body is stored separately to the email entity so the body is not returned in paginated results only in full single email or wait requests.

memberof Email


bodyExcerpt

Optional bodyExcerpt: string

An excerpt of the body of the email message for quick preview .

memberof Email


bodyMD5Hash

Optional bodyMD5Hash: string

A hash signature of the email message using MD5. Useful for comparing emails without fetching full body.

memberof Email


cc

Optional cc: string[]

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

memberof Email


charset

Optional charset: string

Detected character set of the email body such as UTF-8

memberof Email


createdAt

Optional createdAt: Date

When was the email received by MailSlurp

memberof Email


from

Optional from: string

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

memberof Email


headers

Optional headers: Object

Collection of SMTP headers attached to email

memberof Email

Index signature

▪ [key: string]: string


id

Optional id: string

ID of the email entity

memberof Email


inboxId

Optional inboxId: string

ID of the inbox that received the email

memberof Email


isHTML

Optional isHTML: boolean

Is the email body HTML

memberof Email


read

Optional 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 Email


recipients

Optional recipients: EmailRecipients

memberof Email


replyTo

Optional replyTo: string

The replyTo field on the received email message

memberof Email


sender

Optional sender: Sender

memberof Email


subject

Optional subject: string

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

memberof Email


teamAccess

Optional teamAccess: boolean

Can the email be accessed by organization team members

memberof Email


to

Optional to: string[]

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

memberof Email


updatedAt

Optional updatedAt: Date

When was the email last updated

memberof Email


userId

Optional userId: string

ID of user that email belongs to

memberof Email