# Interface: UpdateInboxOptions

Options for updating inbox properties

export

interface UpdateInboxOptions

# Hierarchy

  • UpdateInboxOptions

# Properties

# Optional description

description? : string

Defined in src/generated/api.ts:2269

Optional description of an inbox for labelling purposes

type {string}

memberof UpdateInboxOptions


# Optional expiresAt

expiresAt? : Date

Defined in src/generated/api.ts:2275

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.

type {Date}

memberof UpdateInboxOptions


# Optional favourite

favourite? : boolean

Defined in src/generated/api.ts:2281

Is the inbox favourited

type {boolean}

memberof UpdateInboxOptions


# Optional name

name? : string

Defined in src/generated/api.ts:2287

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

type {string}

memberof UpdateInboxOptions


# Optional tags

tags? : Array‹string›

Defined in src/generated/api.ts:2293

Tags that inbox has been tagged with

type {Array‹string›}

memberof UpdateInboxOptions