Mailbox · StartupBuilder

Properties

Property	Type	Required	Description
`address`	`email`	required	The email address.
`stream`	`string`	required	What it sends: receipts and resets, broadcasts, or cold outbound; one stream per Mailbox.
`dailyCap`	`integer`		Sends allowed today, raised by the warmup ramp and cut by the brakes.
`status`	`string`		Where the Mailbox stands in its warmup and rest cycle.
`tenant`	Tenant		The Tenant it sends for, at a Domain that Tenant’s Customer holds; replies land in the Tenant’s Threads.

Inherited from Channel: 5 properties

Property	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.

Object

JSON

{
  "$id": "https://api.sb/tutorloop.com/mailboxes/mailbox_1",
  "$type": "Mailbox",
  "medium": "email",
  "organization": "organization_1",
  "external": true,
  "areaCode": "Example area code",
  "number": "Example number",
  "address": "malik@tutorloop.com",
  "stream": "transactional",
  "dailyCap": 1,
  "status": "warming",
  "tenant": "tenant_1"
}

Relationships

A Mailbox belongs to one Worker: every Worker, Agent or Human, has its own Mailbox. belongsTo, inverse mailbox.

Lifecycle

State	Meaning	Moves to
`warming` (first)	Its daily sends ramp toward its cap over two to four weeks.	`active` by Mailbox.warm; `retired` by Mailbox.retire
`active`	It sends up to its cap while its readings stay inside their brakes.	`resting` by Mailbox.rest; `retired` by Mailbox.retire
`resting`	A brake fired, so it sends nothing until the reading clears.	`active` by Mailbox.warm; `retired` by Mailbox.retire
`retired`	It sends nothing again; its address, Messages and sending history stay.	None: it ends here.

Verbs

createCreates a Mailbox.
POST /{namespace}/mailboxesdoMailbox.created
getReturns one Mailbox by id.
GET /{namespace}/mailboxes/{id}readNo Event
listReturns Mailboxes, newest first, one page at a time.
GET /{namespace}/mailboxesreadNo Event
updateChanges the given properties of a Mailbox.
PATCH /{namespace}/mailboxes/{id}doMailbox.updated
restRest pauses a Mailbox’s sending when a brake fires and resumes it when the reading clears.
POST /{namespace}/mailboxes/{mailbox}/restdoMailbox.rested
retireRetire stops a Mailbox for good and keeps its address, Messages and sending history.
POST /{namespace}/mailboxes/{mailbox}/retiredoMailbox.retired
warmWarm ramps a new Mailbox from a few sends a day to its cap over two to four weeks.
POST /{namespace}/mailboxes/{mailbox}/warmdoMailbox.warmed

A Mailbox is never deleted: it ends by Mailbox.retire, and its records stay.

Permissions

Which Access level may call each Verb. One-way Verbs wait their delay window.

Operation	`owner`	`admin`	`member`	`viewer`
`Mailbox.create`	Yes	Yes	Yes	No
`Mailbox.get`	Yes	Yes	Yes	Yes
`Mailbox.list`	Yes	Yes	Yes	Yes
`Mailbox.update`	Yes	Yes	Yes	No
`Mailbox.rest`	Yes	Yes	Yes	No
`Mailbox.retire`	Yes	No	No	No
`Mailbox.warm`	Yes	Yes	Yes	No

Call it

Text

Warm my mailbox.

Example

susan@lessonloft.app is the Mailbox of Susan, the Customer Lead of a lesson-booking App. Teachers' replies to her land there, not in a shared inbox.

PropertiesCopy Anchor Link

ObjectCopy Anchor Link

RelationshipsCopy Anchor Link

LifecycleCopy Anchor Link

VerbsCopy Anchor Link

PermissionsCopy Anchor Link

Call itCopy Anchor Link

ExampleCopy Anchor Link