Getting Started
Installation
Set up Emailens for your project — API keys, engine package, MCP server, or GitHub Action.
API key
To use the REST API with higher rate limits and saved previews:
- Create an account at emailens.dev
- Go to Dashboard > API Keys
- Click Generate New Key
- Copy the key — it starts with
ek_
Use the key in requests:
curl -X POST https://emailens.dev/api/preview \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ek_your_api_key" \
-d '{"html": "<html><body>...</body></html>"}'Engine package
Install the standalone engine for direct use in Node.js, Bun, or Deno:
# bun
bun add @emailens/engine
# npm
npm install @emailens/engine
# pnpm
pnpm add @emailens/engineThe engine has minimal dependencies (cheerio for HTML parsing, css-tree for CSS parsing) and works in any JavaScript runtime.
MCP server
See MCP server setup for Claude Desktop and Claude Code integration.
GitHub Action
See GitHub Action setup to add email compatibility checks to your CI pipeline.
Plans and limits
| Plan | Price | Previews/day | API keys |
|---|---|---|---|
| Free | $0 | 3 | 0 |
| Dev | $9/mo | 50 | 1 |
| Pro | $19/mo | Unlimited | 10 |
Rate limits apply regardless of plan:
- Anonymous: 30 requests/minute per IP
- Authenticated: 60 requests/minute per user