Managing Inboxes

An inbox is a named email destination within a team. Every inbox has a unique address in the format [email protected]. You can have multiple inboxes per team — one per test suite, feature area, or workflow.

Create an Inbox

Inboxes are created inside a team. The username you choose becomes the local part of the email address.

Via web UI: Navigate to your team → Inboxes → New Inbox → enter a username → Create.

Via SDK:

TypeScript

const inbox = await mf.inboxes.create({
  orgSlug: 'acme',
  teamSlug: 'qa',
  username: 'signup-flow',
});

console.log(inbox.address); // [email protected]

Pause and Resume

Pausing an inbox causes Haraka to reject inbound mail at the SMTP level with a 5.2.1 permanent failure. No email is accepted while paused — nothing is lost, senders receive a clear rejection.

Via web UI: Open the inbox detail page → Pause Inbox. The button toggles to Resume when the inbox is paused.

Via SDK:

TypeScript

// Pause
await mf.inboxes.update({
  inboxAddress: '[email protected]',
  status: 'paused',
});

// Resume
await mf.inboxes.update({
  inboxAddress: '[email protected]',
  status: 'active',
});

Enable Catch-All

Paid feature. Catch-all is available on paid plans only. One catch-all inbox per team.

A catch-all inbox receives email addressed to any username under the team that doesn't match an existing inbox. This is useful for testing flows that generate dynamic addresses, or for capturing emails from third-party systems that send to unpredictable addresses.

Via web UI: Open the inbox detail page → Catch-All → toggle to Enabled.

Via SDK:

TypeScript

await mf.inboxes.update({
  inboxAddress: '[email protected]',
  catchAll: true,
});

Delete an Inbox

Permanent. Deleting an inbox removes all emails, all aliases, and all routing rules associated with it. This action cannot be undone.

Via web UI: Open the inbox detail page → Settings → Delete Inbox → confirm by typing the inbox username in the confirmation dialog → Delete.

What's next?

Working with Aliases →

Create ephemeral aliases to isolate each test run automatically.

Routing Rules & Folders →

Automatically sort incoming emails into folders based on conditions.