Quickstart

Get started with SpawnMail in under 2 minutes.

1. Create an Account

Sign up at app.spawnmail.sh to get your dashboard.

2. Get an API Key

Navigate to API Keys in the dashboard and create a new key. Your key starts with sk_.

3. Install an SDK

JavaScript

bun add @spawnmailhq/sdk

Python

uv add spawnmail

CLI

bun add -g spawnmail
spawnmail login --key sk_your_api_key

4. Capture Your First Email

JavaScript

import SpawnMail from "@spawnmailhq/sdk";

const client = new SpawnMail("sk_your_api_key");
const { inbox, email } = await client.capture({ ttl: 300, timeout: 30_000 });

console.log(`Inbox: ${inbox.address}`);
console.log(`Email from: ${email.sender}`);
console.log(`Subject: ${email.subject}`);

Python

from spawnmail import SpawnMail

with SpawnMail("sk_your_api_key") as client:
    result = client.capture(ttl=300, timeout=30)
    print(f"Inbox: {result.inbox.address}")
    print(f"Email from: {result.email.sender}")
    print(f"Subject: {result.email.subject}")

CLI

# Create an inbox
spawnmail create --json | jq -r '.address'

# Read emails
spawnmail read <inbox-id> --json

Next Steps

• JavaScript SDK Reference — Full JS/TS API
• Python SDK Reference — Full Python API
• CLI Reference — Shell scripting patterns
• API Reference — REST API documentation