Mailbox methods: rest, retire, warm

Reference for Mailbox, one group of Mailbox methods.

Mailbox.rest

Rest pauses a Mailbox’s sending when a brake fires and resumes it when the reading clears. Verb page.

TypeScript

interface MailboxVerbs {
  rest(input: MailboxRestInput, options?: SB.CallOptions): SB.Call<Mailbox>
}

Inputs

Input	Type	Required	Description
`mailbox`	Mailbox	required	The Mailbox to pause.
`reason`	`string`	required	The brake that fired.

Returns

Output	Type	Required	Description
`mailbox`	Mailbox	required	The Mailbox, resting.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

TypeScript

import { $ } from 'startup-builder'

const mailbox = await $.Mailbox.rest({ mailbox: 'mailbox_93HvOnR17L', reason: 'complaints' })

Retire stops a Mailbox for good and keeps its address, Messages and sending history. Verb page.

TypeScript

interface MailboxVerbs {
  retire(input: MailboxRetireInput, options?: SB.CallOptions): SB.Call<Mailbox>
}

Inputs

Input	Type	Required	Description
`mailbox`	Mailbox	required	The Mailbox to retire.

Returns

Output	Type	Required	Description
`mailbox`	Mailbox	required	The retired Mailbox.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

TypeScript

import { $ } from 'startup-builder'

const mailbox = await $.Mailbox.retire({ mailbox: 'mailbox_93HvOnR17L' })

Warm ramps a new Mailbox from a few sends a day to its cap over two to four weeks. Verb page.

TypeScript

interface MailboxVerbs {
  warm(input: MailboxWarmInput, options?: SB.CallOptions): SB.Call<Mailbox>
}

Inputs

Input	Type	Required	Description
`mailbox`	Mailbox	required	The new Mailbox.
`cap`	`integer`	required	The daily sends it ramps to.

Returns

Output	Type	Required	Description
`mailbox`	Mailbox	required	The Mailbox, warming.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

TypeScript

import { $ } from 'startup-builder'

const mailbox = await $.Mailbox.warm({ mailbox: 'mailbox_93HvOnR17L', cap: 1 })