MailSlurp JS

Globals / Email

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

Index

Properties

Properties

analysis

Optional analysis: EmailAnalysis

Defined in src/generated/api.ts:1401

Smart analysis of email content including spam ratings

memberof Email


attachments

Optional attachments: Array

Defined in src/generated/api.ts:1407

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

Defined in src/generated/api.ts:1413

List of BCC recipients email was addressed to

memberof Email


body

Optional body: string

Defined in src/generated/api.ts:1419

The body of the email message

memberof Email


bodyMD5Hash

Optional bodyMD5Hash: string

Defined in src/generated/api.ts:1425

A hash signature of the email message

memberof Email


cc

Optional cc: Array

Defined in src/generated/api.ts:1431

List of CC recipients email was addressed to

memberof Email


charset

Optional charset: string

Defined in src/generated/api.ts:1437

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

memberof Email


createdAt

Optional createdAt: Date

Defined in src/generated/api.ts:1443

When was the email received by MailSlurp

memberof Email


from

Optional from: string

Defined in src/generated/api.ts:1449

Who the email was sent from

memberof Email


headers

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

Defined in src/generated/api.ts:1455

Collection of SMTP headers attached to email

memberof Email


id

Optional id: string

Defined in src/generated/api.ts:1461

ID of the email entity

memberof Email


inboxId

Optional inboxId: string

Defined in src/generated/api.ts:1467

ID of the inbox that received the email

memberof Email


isHTML

Optional isHTML: boolean

Defined in src/generated/api.ts:1473

Is the email body HTML

memberof Email


read

Optional read: boolean

Defined in src/generated/api.ts:1479

Read flag. Has the email ever been viewed in the dashboard or fetched via the API? If so the email is marked as read.

memberof Email


replyTo

Optional replyTo: string

Defined in src/generated/api.ts:1485

The replyTo field on the received email message

memberof Email


subject

Optional subject: string

Defined in src/generated/api.ts:1491

The subject line of the email message

memberof Email


teamAccess

Optional teamAccess: boolean

Defined in src/generated/api.ts:1497

Can the email be accessed by organization team members

memberof Email


to

Optional to: Array

Defined in src/generated/api.ts:1503

List of To recipients that email was addressed to

memberof Email


updatedAt

Optional updatedAt: Date

Defined in src/generated/api.ts:1509

When was the email last updated

memberof Email


userId

Optional userId: string

Defined in src/generated/api.ts:1515

ID of user that email belongs to

memberof Email