MailSlurp JS

Globals / Inbox

# Interface: Inbox

Representation of an inbox with an email address. Emails can be sent to or from this email address.

export

interface Inbox

# Hierarchy

  • Inbox

# Index

# Properties

# Properties

# createdAt

Optional createdAt: Date

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

When was the inbox created

memberof Inbox


# description

Optional description: string

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

Optional description of an inbox for labelling purposes

memberof Inbox


# emailAddress

Optional emailAddress: string

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

The inbox's email address. Send an email to this address and the inbox will receive and store it for you. To retrieve the email use the Inbox and Email Controller endpoints.

memberof Inbox


# expiresAt

Optional expiresAt: string

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

When, if ever, will the inbox expire and be deleted. If null then this inbox is permanent and the emails in it won't be deleted. Timestamp passed as string.

memberof Inbox


# favourite

Optional favourite: boolean

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

Is the inbox favourited

memberof Inbox


# id

Optional id: string

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

ID of the inbox

memberof Inbox


# name

Optional name: string

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

Optional name of the inbox. Displayed in the dashboard for easier search

memberof Inbox


# tags

Optional tags: Array<string>

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

Tags that inbox has been tagged with

memberof Inbox


# userId

Optional userId: string

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

ID of user that inbox belongs to

memberof Inbox