Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.simpleemailapi.dev/llms.txt

Use this file to discover all available pages before exploring further.

​
Quickstart

This guide will get you sending emails in minutes using our TypeScript SDK or your preferred method.
1

Install the SDK

Install the package using your favorite package manager:
npm install simpleemailapi
2

Get your API Key

Sign up on the dashboard, create a workspace, and grab your API key (starts with sea_live_).
3

Send your first email

Use one of the methods below to send your first email.
import { createClient } from 'simpleemailapi';

const client = createClient({
  apiKey: 'sea_live_...'
});

await client.send({
  from: 'onboarding@yourdomain.com',
  to: ['you@example.com'],
  subject: 'Hello from Simple Email API',
  body: 'It works!'
});
4

Receive Emails

Handle incoming emails and events using your preferred method.
import { createClient } from 'simpleemailapi';

const client = createClient({ apiKey: 'sea_live_...' });

// Listen for events in real-time
client.onReceive({
  onDelivered: (event) => console.log('Delivered:', event),
  onReplied: (event) => console.log('Reply:', event.body),
  onBounced: (event) => console.log('Bounced:', event),
  onError: (err) => console.error(err)
});

​
Next Steps

Add your domain

Configure your own domain to send from your brand.

Receive emails

Listen for replies and events in real-time.