MailSlurp JS

Globals / Email

# 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.


interface Email

# Hierarchy

  • Email

# Index

# Properties

# Properties

# analysis

Optional analysis: EmailAnalysis

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

Smart analysis of email content including spam ratings"

memberof Email

# attachments

Optional attachments: Array<string>

Defined in src/generated/api.ts:685 (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.

memberof Email

# bcc

Optional bcc: Array<string>

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

List of BCC recipients email was addressed to

memberof Email

# body

Optional body: string

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

The body of the email message

memberof Email

# bodyMD5Hash

Optional bodyMD5Hash: string

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

A hash signature of the email message

memberof Email

# cc

Optional cc: Array<string>

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

List of CC recipients email was addressed to

memberof Email

# charset

Optional charset: string

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

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

memberof Email

# createdAt

Optional createdAt: Date

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

When was the email received by MailSlurp

memberof Email

# from

Optional from: string

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

Who the email was sent from

memberof Email

# headers

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

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

memberof Email

# id

Optional id: string

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

ID of the email

memberof Email

# inboxId

Optional inboxId: string

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

ID of the inbox that received the email

memberof Email

# isHTML

Optional isHTML: boolean

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

Was HTML sent in the email body

memberof Email

# read

Optional read: boolean

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

Has the email been viewed ever

memberof Email

# subject

Optional subject: string

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

The subject line of the email message

memberof Email

# to

Optional to: Array<string>

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

List of To recipients email was addressed to

memberof Email

# updatedAt

Optional updatedAt: Date

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

When was the email last updated

memberof Email

# userId

Optional userId: string

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

ID of user that email belongs

memberof Email