Mailbox programs: create, get, list
The Mailbox Verbs create, get, list as MCP do programs, with inputs, result, refusals and an example.
Reference for Mailbox, one group of Mailbox programs.
Mailbox.create
Creates a Mailbox. Verb page.
do:Emits Mailbox.created.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
medium | string | required | The platform type, such as email, sms, or chat. |
organization | Organization | The outside Organization the Channel is shared with; its new Messages open Conversations for that Customer. | |
external | boolean | True when people from another Organization post in it, as in a channel two companies share. | |
areaCode | string | For an sms Channel, the phone area code its number is drawn from, such as 512. | |
number | string | For an sms Channel, its phone number in international form, assigned when it is created. | |
address | email | required | The email address. |
stream | string | required | What it sends: receipts and resets, broadcasts, or cold outbound; one stream per Mailbox. |
tenant | Tenant | The Tenant it sends for, at a Domain that Tenant’s Customer holds; replies land in the Tenant’s Threads. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
mailbox | Mailbox | required | The 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
{
"name": "do",
"arguments": {
"code": "return await $.Mailbox.create({ medium:Mailbox.get
Returns one Mailbox by id. Verb page.
do:Reads only: it emits no Event.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Mailbox. |
at | string | A time or Version name: the record as it stood then. Unset: as it stands now. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
mailbox | Mailbox | required | The 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
{
"name": "do",
"arguments": {
"code": "return await $.Mailbox.get({ id:Mailbox.list
Returns Mailboxes, newest first, one page at a time. Verb page.
do:Reads only: it emits no Event.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
limit | integer | At most this many records, up to 100. The default is 20. | |
after | string | The cursor from the previous page. | |
where | string | A filter over the properties, such as paidAt = null and total.amount > 500. | |
sort | string | Properties to sort by, comma-separated; a leading minus sorts descending. | |
total | boolean | True adds the match count as meta.total, exact up to 10,000 matches and estimated above. | |
facets | string | Properties to count by value, comma-separated, returned as meta.facets. | |
fields | string | Properties to return on each record, comma-separated; $id and $type always return. | |
include | string | Related records to embed in place of their URLs, comma-separated. | |
depth | integer | How many levels of related records to embed. The default is 1. | |
q | string | Words to match across the text properties, ranked by relevance. | |
match | string | Ranks the search by words, or meaning; words is the default. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
mailboxes | list of Mailbox | required | One page of Mailboxes. |
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
{
"name": "do",
"arguments": {
"code": "return await $.Mailbox.list({ limit: