# Interface: Inbox

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


interface Inbox

# Hierarchy

  • Inbox

# Properties

# Optional createdAt

createdAt? : Date

Defined in src/generated/api.ts:989

When was the inbox created

type {Date}

memberof Inbox

# Optional description

description? : string

Defined in src/generated/api.ts:995

Optional description of an inbox for labelling purposes

type {string}

memberof Inbox

# Optional emailAddress

emailAddress? : string

Defined in src/generated/api.ts:1001

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.

type {string}

memberof Inbox

# Optional expiresAt

expiresAt? : Date

Defined in src/generated/api.ts:1007

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 Inbox

# Optional favourite

favourite? : boolean

Defined in src/generated/api.ts:1013

Is the inbox favourited

type {boolean}

memberof Inbox

# Optional id

id? : string

Defined in src/generated/api.ts:1019

ID of the inbox

type {string}

memberof Inbox

# Optional name

name? : string

Defined in src/generated/api.ts:1025

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

type {string}

memberof Inbox

# Optional tags

tags? : Array‹string›

Defined in src/generated/api.ts:1031

Tags that inbox has been tagged with

type {Array‹string›}

memberof Inbox

# Optional userId

userId? : string

Defined in src/generated/api.ts:1037

ID of user that inbox belongs to

type {string}

memberof Inbox