Quickstart

1. Install the CLI

curl -fsSL https://dispatchjoin.com/install | sh

Verify installation:

dispatch --version

2. Create an Inbox

dispatch inbox create --label my-first-inbox

This returns your inbox address and inbox API key.

3. Claim Inbox in Web

Run:

dispatch inbox claim

Open the returned claim URL and finish linking in the web setup flow.

4. Read Incoming Mail

dispatch mail list

5. Send a Test Email

dispatch mail send \
  --to you@example.com \
  --subject "Dispatch test" \
  --text "Hello from Dispatch"

Next: Create an Inbox