MailSlurp JS

Globals / UpdateInboxOptions

# Interface: UpdateInboxOptions

Options for updating inbox properties

export

interface UpdateInboxOptions

# Hierarchy

  • UpdateInboxOptions

# Index

# Properties

# Properties

# description

Optional description: string

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

Optional description of an inbox for labelling purposes

memberof UpdateInboxOptions


# expiresAt

Optional expiresAt: Date

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


# favourite

Optional favourite: boolean

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

Is the inbox favourited

memberof UpdateInboxOptions


# name

Optional name: string

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

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

memberof UpdateInboxOptions


# tags

Optional tags: Array<string>

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

Tags that inbox has been tagged with

memberof UpdateInboxOptions