Get started / Overview
Get started

r2-mailbox documentation

These pages cover setting up r2-mailbox, reading the mail it stores, and keeping it safe. If you haven’t deployed it yet, start with the setup tutorial. Every other page assumes you’ve finished it.

Set up r2-mailbox

Follow the tutorial yourself, or hand it to an AI agent. Both take about 15 minutes:

Use your inbox

These guides each cover one task, for when you’re already set up:

Understand the design

This page explains the parts and the reasons behind them:

  • How r2-mailbox works: the path an email takes, why nobody can call the Worker from the internet, how emails are stored, and what it costs to run

Look up details

The reference pages list every command, setting, and field: