MailSlurp JS

Globals / Inbox

# Interface: Inbox

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


interface Inbox

# Hierarchy

  • Inbox

# Index

# Properties

# Properties

# createdAt

Optional createdAt: Date

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

When the inbox was created. Time stamps are in ISO DateTime Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX e.g. 2000-10-31T01:30:00.000-05:00.

memberof Inbox

# description

Optional description: string

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

Description of an inbox for labelling and searching purposes

memberof Inbox

# emailAddress

Optional emailAddress: string

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

The inbox's email address. Send an email to this address and the inbox will receive and store it for you. Note the email address in MailSlurp match characters exactly and are case sensitive so +123 additions are considered different addresses. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID.

memberof Inbox

# expiresAt

Optional expiresAt: string

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

Inbox expiration time. When, if ever, the inbox should expire and be deleted. If null then this inbox is permanent and the emails in it won't be deleted. This is the default behavior unless expiration date is set. If an expiration date is set and the time is reached MailSlurp will expire the inbox and move it to an expired inbox entity. You can still access the emails belonging to it but it can no longer send or receive email.

memberof Inbox

# favourite

Optional favourite: boolean

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

Is the inbox favorited. Favouriting inboxes is typically done in the dashboard for quick access or filtering

memberof Inbox

# id

Optional id: string

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

ID of the inbox. The ID is a UUID-V4 format string. Use the inboxId for calls to Inbox and Email Controller endpoints. See the emailAddress property for the email address or the inbox. To get emails in an inbox use the WaitFor and Inbox Controller methods waitForLatestEmail and getEmails methods respectively. Inboxes can be used with aliases to forward emails automatically.

memberof Inbox

# name

Optional name: string

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

Name of the inbox. Displayed in the dashboard for easier search

memberof Inbox

# tags

Optional tags: Array<string>

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

Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI.

memberof Inbox

# userId

Optional userId: string

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

ID of user that inbox belongs to

memberof Inbox