Mailbox commands: rest, retire, warm
The Mailbox Verbs rest, retire, warm as CLI commands, with inputs, result, refusals and an example.
Reference for Mailbox, one group of Mailbox commands.
Mailbox.rest
Rest pauses a Mailbox’s sending when a brake fires and resumes it when the reading clears. Verb page.
npx startup-builder do Mailbox.rest --json '<input>' [--try | --send | --do]Emits Mailbox.rested.
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
npx startup-builder do Mailbox.rest --json '{"mailbox":Mailbox.retire
Retire stops a Mailbox for good and keeps its address, Messages and sending history. Verb page.
npx startup-builder do Mailbox.retire --json '<input>' [--try | --send | --do]Emits Mailbox.retired.
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
npx startup-builder do Mailbox.retire --json '{"mailbox":Mailbox.warm
Warm ramps a new Mailbox from a few sends a day to its cap over two to four weeks. Verb page.
npx startup-builder do Mailbox.warm --json '<input>' [--try | --send | --do]Emits Mailbox.warmed.
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
npx startup-builder do Mailbox.warm --json '{"mailbox":