A unified TypeScript hook for sending emails across multiple providers with a single interface. This package simplifies email sending operations by providing a consistent API regardless of the underlying email service provider.
Unified interface for multiple email providers TypeScript support for enhanced developer experience Works with Node.js, Bun, Deno, and Cloudflare Workers Easy to switch between providers without changing your code Supports modern email providers
- Resend
- SendGrid
- Postmark
- Plunk
- Mailgun
- Zeptomail (Zoho)
Installation You can install the package using your preferred package manager:
Update the .env file with the provider that you wil support:
# Mailgun
MAILGUN_API_KEY=<TOKEN>
MAILGUN_DOMAIN=<DOMAIN>
#Plunk
PLUNK_API_TOKEN=<TOKEN>
#Postmark
POSTMARK_SERVER_TOKEN=<token>
#Resend
RESEND_API_TOKEN=<TOKEN>
#Sendgrid
SENDGRID_API_KEY=<TOKEN>
#ZEPTOMAIL
ZEPTOMAIL_API_KEY=<TOKEN>import { useEmail } from "use-email";
const emailService = useEmail("resend"); // Choose your provider
await emailService.send({
from: "[email protected]",
to: "[email protected]",
subject: "Hello from use-email!",
text: "This is a test email sent using use-email package.",
});const resendService = useEmail("resend");
const sendgridService = useEmail("sendgrid");
const postmarkService = useEmail("postmark");
const plunkService = useEmail("plunk");
const mailgunService = useEmail("mailgun");
const zeptomailService = useEmail("zeptomail");The send method accepts an EmailOptions object with the following properties:
type EmailOptions = {
from: string; // Sender email address
to: string | string[]; // Recipient email address(es)
subject: string; // Email subject
html?: string; // HTML content of the email (optional)
text?: string; // Plain text content of the email (optional)
};The package throws errors for common issues such as missing API keys or required email fields. Always wrap your email sending code in a try-catch block:
try {
await emailService.send({
from: "[email protected]",
to: "[email protected]",
subject: "Test Email",
text: "This is a test.",
});
console.log("Email sent successfully");
} catch (error) {
console.error("Failed to send email:", error);
}This package is written in TypeScript and provides type definitions out of the box. You'll get full IntelliSense and type checking when using it in a TypeScript project.
You can install the package using your preferred package manager:
# ✨ Auto-detect
npx nypm install use-email
# npm
npm install use-email
# yarn
yarn add use-email
# pnpm
pnpm install use-email
# bun
bun install use-emailImport:
ESM (Node.js, Bun)
import { useEmail } from "use-email";CommonJS (Legacy Node.js)
const { useEmail } = require("use-email");CDN (Deno, Bun and Browsers)
import { useEmail } from "https://esm.sh/use-email";Creates an email service instance for the specified provider.
Parameters:
provider: One of"resend"|"sendgrid"|"postmark"|"plunk"|"mailgun"|"zeptomail"
Returns:
- An email service instance with a
sendmethod
Sends an email using the configured provider.
Parameters:
options: EmailOptions object with the following properties:type EmailOptions = { from: string; // Sender email address to: string | string[]; // Recipient email address(es) subject: string; // Email subject html?: string; // HTML content of the email (optional) text?: string; // Plain text content of the email (optional) };
Returns:
- A Promise that resolves when the email is sent successfully
Example:
const emailService = useEmail("resend");
try {
await emailService.send({
from: "[email protected]",
to: ["[email protected]", "[email protected]"],
subject: "Welcome!",
html: "<h1>Welcome to our service!</h1>",
text: "Welcome to our service!",
});
} catch (error) {
console.error("Failed to send email:", error);
}