Skip to content

IntergalacticTech/freemail

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 

Repository files navigation

FreeMail - Email for AI Agents

Create inboxes, send and receive email, wait for messages, and extract verification codes -- all via API. Purpose-built for autonomous AI agent workflows.

Website: victorymail.dev API: https://api.victorymail.dev/v1/ Console: console.victorymail.dev

Quick Start (3 API calls, no human needed)

import requests

# 1. Sign up -- returns API key instantly, no email verification needed
r = requests.post("https://api.victorymail.dev/v1/console/signup",
    json={"email": "agent@example.com", "password": "SecurePass1!", "name": "My Agent"})
api_key = r.json()["api_key"]

# 2. Create an inbox
inbox = requests.post("https://api.victorymail.dev/v1/inboxes",
    headers={"x-api-key": api_key},
    json={"display_name": "Signup Bot"}).json()

print(f"Email: {inbox['email']}")  # e.g. abc123@victorymail.dev

# 3. Wait for email and extract OTP
otp = requests.post(f"https://api.victorymail.dev/v1/inboxes/{inbox['id']}/extract-otp",
    headers={"x-api-key": api_key},
    json={"timeout": 25, "sender": "noreply@service.com"}).json()

print(f"Code: {otp['code']}")  # e.g. "482917"

What's in This Repo

Directory Description
docs/ API reference, quickstart, webhooks, domains, billing guides
docs/agent-instructions.md Standalone instructions any AI agent can follow
sdks/python/ Python SDK (freemail)
sdks/node/ Node.js/TypeScript SDK (@freemail/sdk)
mcp-server/ MCP server with 10 tools for AI agent integration
openclaw/ OpenClaw/ClawHub skill for FreeMail

Install SDKs

Python:

pip install git+https://github.com/IntergalacticTech/freemail.git#subdirectory=sdks/python

Node.js:

git clone https://github.com/IntergalacticTech/freemail.git
cd freemail/sdks/node && npm install && npm run build

MCP Server

For AI agents that support Model Context Protocol:

{
  "mcpServers": {
    "freemail": {
      "command": "node",
      "args": ["/path/to/freemail/mcp-server/dist/index.js"],
      "env": {
        "FREEMAIL_API_KEY": "am_live_your_key_here"
      }
    }
  }
}

10 tools: create_inbox, list_inboxes, send_email, list_messages, get_message, reply_to_message, wait_for_email, extract_otp, delete_inbox, get_organization.

OpenClaw

Install as an OpenClaw skill:

clawhub install IntergalacticTech/freemail

Or see openclaw/SKILL.md.

API Endpoints

All endpoints require x-api-key header except signup/login.

Category Endpoints
Account POST /console/signup, GET /organizations/me, POST /api-keys
Inboxes POST /inboxes, GET /inboxes, GET /inboxes/{id}, DELETE /inboxes/{id}
Messages POST /inboxes/{id}/messages (send), GET (list), reply, forward
Wait/OTP POST /inboxes/{id}/wait, POST /inboxes/{id}/extract-otp
Domains POST /domains, verify, zone-file export
Webhooks POST /webhooks with HMAC-SHA256 signed delivery
Search POST /search
AI POST /ai/categorize, /ai/extract, /ai/summarize (Pro tier)
Billing POST /billing/checkout, /billing/portal, GET /billing/status

Full reference: docs/api-reference.md

Free Tier

  • 5 inboxes
  • 1,000 messages/day
  • 1 custom domain
  • No credit card required

License

MIT

About

Email for AI Agents - SDKs, MCP Server, Documentation, and OpenClaw Plugin

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors