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

Hierarchy

  • Email

Properties

analysis?: EmailAnalysis

Memberof

Email

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?: string[]

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

Memberof

Email

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?: string

An excerpt of the body of the email message for quick preview. Takes HTML content part if exists falls back to TEXT content part if not

Memberof

Email

bodyMD5Hash?: string

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

Memberof

Email

bodyPartContentTypes?: string[]

A list of detected multipart mime message body part content types such as text/plain and text/html. Can be used with email bodyPart endpoints to fetch individual body parts.

Memberof

Email

cc?: string[]

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

Memberof

Email

charset?: string

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

Memberof

Email

createdAt: Date

When was the email received by MailSlurp

Memberof

Email

domainId?: string

ID of the domain that received the email

Memberof

Email

from?: string

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

Memberof

Email

headers?: {
    [key: string]: string;
}

Collection of SMTP headers attached to email

Memberof

Email

Type declaration

  • [key: string]: string
headersMap?: {
    [key: string]: string[];
}

Multi-value map of SMTP headers attached to email

Memberof

Email

Type declaration

  • [key: string]: string[]
html?: boolean

Memberof

Email

id: string

ID of the email entity

Memberof

Email

inboxId: string

ID of the inbox that received the email

Memberof

Email

isHTML?: boolean

Is the email body content type HTML?

Memberof

Email

isXAmpHtml?: boolean

Is the email body content type x-amp-html Amp4Email?

Memberof

Email

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?: EmailRecipients

Memberof

Email

replyTo?: string

The replyTo field on the received email message

Memberof

Email

sender?: Sender

Memberof

Email

subject?: string

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

Memberof

Email

teamAccess: boolean

Can the email be accessed by organization team members

Memberof

Email

textExcerpt?: string

An excerpt of the body of the email message for quick preview. Takes TEXT content part if exists

Memberof

Email

to: string[]

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

Memberof

Email

updatedAt: Date

When was the email last updated

Memberof

Email

userId: string

ID of user that email belongs to

Memberof

Email

xampHtml?: boolean

Memberof

Email