Skip to main content

TypeScript SDK

The simpleemailapi package provides a fully typed, backend-first SDK for Node.js workflows.

Installation

Usage

Initialize the client with your API key and use the client.send method.
The from address must belong to a domain you have verified.

Client Configuration

The createClient function accepts the following options:
string
required
Your API Key, starting with sea_live_.
string
API endpoint URL. Defaults to https://api.simpleemailapi.dev.

arguments

The client.send method accepts an object with the following properties:
string
required
Sender email address. Must be from a verified domain.
string[]
required
List of primary recipient email addresses.
string
required
Email subject line.
string
Plain text content of the email.
string
HTML content of the email.
string[]
List of CC recipient email addresses.
string[]
List of BCC recipient email addresses.
Attachment[]
List of files to attach.
string
Reply to a previous email using its id from our response. We automatically resolve threading headers.
string
Raw Message-ID for threading (advanced). Use replyTo for simpler threading with our email IDs.
string[]
List of message IDs for threading context.
Record<string, string>
Custom headers. // Proto has metadata, effectively custom headers/metadata.
Record<string, string>
Custom key-value metadata.
Date
Schedule the email for future delivery.
All emails are queued for reliable delivery with automatic retries. Use webhooks or event streaming to track delivery status.