Last updated

🚦 Quick Start

Get up and running with Reusable.email in just a few minutes.
This guide will help you connect your domain, create an inbox, and start receiving email—all through the API.


1️⃣ Set Up Your Custom Domain (Required)

To access the API, you must have one of the paid domain plans, and have completed the required DNS setup/verification.

Example:
If you want to point mail.yourdomain.com to the Whitelabel Inbox Page, and recieve emails through yourdomain.com, add the following records to your DNS:

TypeNameContent / TargetProxy StatusTTLNotes
CNAMEmail*cname.reusable.email.ProxiedAutoPoints your subdomain to Reusable.email API
MX@*mx.reusable.email.N/AAutoReceives mail for your domain

*You can set the name to any subdomain (or @ for root) of your choosing, as long as it's properly configured in the dashboard.

DNS will be checked on our end every few minutes. DNS can take up to 24 hours to fully propigate in rare cases.


2️⃣ Create an Inbox

You can create inboxes instantly with a single API call.

Example: Create a public inbox

curl -X POST "https://mail.yourdomain.com/v2/inbox" \
  -H "Content-Type: application/json" \
  -d '{
    "inbox_address": "test@yourdomain.com",
    "is_public": true
  }'

Response:

{
  "id": "663dbde1e0535ce2e6a1cd99",
  "inbox_address": "test@yourdomain.com",
  "is_public": true,
  "created_at": "2024-06-01T12:00:00Z"
}

3️⃣ Access Your Inbox

  • Public inbox: Anyone can view emails sent to this address—no login required.
  • Private inbox: Set "is_public": false and include a "password". You’ll get an Inbox Token on login, which you use for all private inbox actions.

Example: Login to a private inbox

curl -X POST "https://mail.yourdomain.com/v2/inbox/663dbde1e0535ce2e6a1cd99/login" \
  -H "Content-Type: application/json" \
  -d '{"password": "your-password"}'

Response includes inbox_token. Use this for all protected API calls:

Authorization: Inbox <token>

4️⃣ Read Incoming Emails

Fetch all folders (like "Inbox", "Sent"):

curl "https://yourdomain.com/v2/inbox/663dbde1e0535ce2e6a1cd99"
  # (GET, returns folders and unread count)

Fetch emails in a folder:

curl "https://yourdomain.com/v2/inbox/663dbde1e0535ce2e6a1cd99/folder/<folder_id>?page=1"

5️⃣ Explore the API


🏁 You’re Ready!

You now have:

  • Custom or disposable inboxes
  • Programmatic email access
  • API automation in minutes