Mailbox.retire

Its Inputs, Outputs, Effects and guards quote the hub’s Mailbox.retire; this page adds what each Venue honors, its limits and a worked call. It is one of the Verbs of Mailboxes.

InputsCopy Anchor Link

OutputsCopy Anchor Link

EffectsCopy Anchor Link

Action class

None: no approval rule names it, so it runs within its seat’s Permissions and Limits

Modes

• try: Runs every check and returns the record as it would be; nothing is stored.
• send: Returns a pending Action at once; Mailbox.retired fires when it is done.
• do: Waits for the Action to finish and returns the record.

Idempotency

Only with a key: the same Idempotency-Key and input return the first Action, and the same key with other input returns 409.

Saved or shared

Routes new mail to the Mailbox of the Role it served.

Emits

Mailbox.retired with { mailbox }

Performed by

Customer lead

Price

Free on your own account: the platform charges nothing for the call.

On each VenueCopy Anchor Link

It acts on your own records and reaches no Venue, so every account answers the same way.

What try doesCopy Anchor Link

Runs every check the call meets and returns the record as it would be; nothing is stored, sent or posted.

Refuses whenCopy Anchor Link

The hub sets no guard of its own on this call: it refuses only on the shared checks every write meets (a missing record, a Permission the seat lacks).

When it waitsCopy Anchor Link

Returns in one response; nothing waits.

ExampleCopy Anchor Link

In send mode the call returns its pending Action at once, and Mailbox.retired delivers the result.

Retire dana.okafor@tryleaseline.app: two inboxes are enough now.

{
  "mode": "send",
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/action_Sd3kQ9vT2w",
    "operation": "Mailbox.retire",
    "status": "pending",
    "reason": "running"
  }
}

To retry, send the same Idempotency-Key: the retry returns the first answer for $0. A new key reads again.

Used byCopy Anchor Link

None.

RelatedCopy Anchor Link

• Message.broadcastSends one email to a whole Audience, such as your waitlist, now or at a set time.
• Message.scheduleHolds one email until the minute you set, such as 9:10 in the buyer’s morning, then sends it from your Mailbox.
• Mailbox.warmRamps a new Mailbox from 5 sends a day to 25 over 14 days, before any cold email leaves it.
• Mailbox.restPauses a Mailbox’s sending when a brake fires, such as bounces over 2%, and resumes it when the reading clears.
• Domain.authenticateWrites your domain’s SPF, DKIM and DMARC records and checks them before its first send.
• Contact.suppressAdds an address to the one list every send reads first, honored by every startup, forever.
• Contact.unsubscribeStops commercial email to a person in one click, for one topic or all, at once.
• Consent.withdrawEnds a Consent at once: sending for its purpose stops, and the record stays.