MailSlurp JS

Globals / Inbox

Namespace: Inbox


namespace Inbox






Optional createdAt: Date

Defined in src/generated/api.ts:2266

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


Optional description: string

Defined in src/generated/api.ts:2272

Description of an inbox for labelling and searching purposes

memberof Inbox


Optional emailAddress: string

Defined in src/generated/api.ts:2278

The inbox’s email address. Inbox projections and previews may not include the email address. To view the email address fetch the inbox entity directly. 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


Optional expiresAt: string

Defined in src/generated/api.ts:2284

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


Optional favourite: boolean

Defined in src/generated/api.ts:2290

Is the inbox a favorite inbox. Make an inbox a favorite is typically done in the dashboard for quick access or filtering

memberof Inbox


Optional id: string

Defined in src/generated/api.ts:2296

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


Optional inboxType: InboxTypeEnum

Defined in src/generated/api.ts:2302

Type of inbox - either HTTP (default) or SMTP. HTTP inboxes are great for testing. SMTP inboxes are processed by a custom SMTP mail server and are better for public facing inboxes that receive emails from Gmail and other large providers. If using a custom domain the domain type must match the inbox type. Use an SMTP domain for SMTP inboxes that includes an MX record pointing to 10 for inbound messages.

memberof Inbox


Optional name: string

Defined in src/generated/api.ts:2308

Name of the inbox and used as the sender name when sending emails .Displayed in the dashboard for easier search

memberof Inbox


Optional readOnly: boolean

Defined in src/generated/api.ts:2314

Is the inbox readOnly for the caller. Read only means can not be deleted or modified. This flag is present when using team accounts and shared inboxes.

memberof Inbox


Optional tags: Array

Defined in src/generated/api.ts:2320

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


Optional teamAccess: boolean

Defined in src/generated/api.ts:2326

Does inbox permit team access for organization team members. If so team users can use inbox and emails associated with it. See the team access guide at

memberof Inbox


Optional userId: string

Defined in src/generated/api.ts:2332

ID of user that inbox belongs to

memberof Inbox