# Interface: Email

Email model (also referred to as EmailDto). Represents an email that was received by an inbox. If you want the original SMTP message see the getRawEmail endpoint.

export

interface Email

# Hierarchy

  • Email

# Properties

# Optional analysis

analysis? : EmailAnalysis

Defined in src/generated/api.ts:581 (opens new window)

Smart analysis of email content including spam ratings"

type {EmailAnalysis}

memberof Email


# Optional attachments

attachments? : Array‹string›

Defined in src/generated/api.ts:587 (opens new window)

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.

type {Array‹string›}

memberof Email


# Optional bcc

bcc? : Array‹string›

Defined in src/generated/api.ts:593 (opens new window)

List of BCC recipients email was addressed to

type {Array‹string›}

memberof Email


# Optional body

body? : string

Defined in src/generated/api.ts:599 (opens new window)

The body of the email message

type {string}

memberof Email


# Optional cc

cc? : Array‹string›

Defined in src/generated/api.ts:605 (opens new window)

List of CC recipients email was addressed to

type {Array‹string›}

memberof Email


# Optional charset

charset? : string

Defined in src/generated/api.ts:611 (opens new window)

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

type {string}

memberof Email


# Optional createdAt

createdAt? : Date

Defined in src/generated/api.ts:617 (opens new window)

When was the email received by MailSlurp

type {Date}

memberof Email


# Optional from

from? : string

Defined in src/generated/api.ts:623 (opens new window)

Who the email was sent from

type {string}

memberof Email


# Optional headers

headers? : object

Defined in src/generated/api.ts:629 (opens new window)

memberof Email

# Type declaration:


# Optional id

id? : string

Defined in src/generated/api.ts:635 (opens new window)

ID of the email

type {string}

memberof Email


# Optional inboxId

inboxId? : string

Defined in src/generated/api.ts:641 (opens new window)

ID of the inbox that received the email

type {string}

memberof Email


# Optional isHTML

isHTML? : boolean

Defined in src/generated/api.ts:647 (opens new window)

Was HTML sent in the email body

type {boolean}

memberof Email


# Optional read

read? : boolean

Defined in src/generated/api.ts:653 (opens new window)

Has the email been viewed ever

type {boolean}

memberof Email


# Optional subject

subject? : string

Defined in src/generated/api.ts:659 (opens new window)

The subject line of the email message

type {string}

memberof Email


# Optional to

to? : Array‹string›

Defined in src/generated/api.ts:665 (opens new window)

List of To recipients email was addressed to

type {Array‹string›}

memberof Email


# Optional updatedAt

updatedAt? : Date

Defined in src/generated/api.ts:671 (opens new window)

When was the email last updated

type {Date}

memberof Email


# Optional userId

userId? : string

Defined in src/generated/api.ts:677 (opens new window)

ID of user that email belongs

type {string}

memberof Email