MailChannels

Node.js SDK to integrate MailChannels API into your JavaScript or TypeScript server-side applications.

This library provides a simple way to interact with the MailChannels API. It is written in TypeScript and can be used in both JavaScript and TypeScript projects and in different runtimes.

• ✨ Release Notes
• 📖 Documentation

Contents

• 🚀 Features
• 📏 Requirements
• 🏃 Quick setup
• 🚧 Roadmap
• ⚖️ License
• 💻 Development

🚀 Features

• Send transactional emails
• Check DKIM, SPF & Domain Lockdown
• Webhook notifications
• Manage sub-accounts

📏 Requirements

• MailChannels account
• Email API key

🏃 Quick setup

1. Add @yizack/mailchannels dependency to your project

# npm
npm i @yizack/mailchannels

# yarn
yarn add @yizack/mailchannels

# pnpm
pnpm add @yizack/mailchannels

⚖️ License

MIT License

🚧 Roadmap

I plan to implement the following features in the future. Already implemented features are marked with a checkmark.

Email API

• Emails
  • ✅ Send an Email
  • ✅ DKIM, SPF & Domain Lockdown Check
• Webhooks
  • ✅ Enroll for Webhook Notifications
  • ✅ Retrieve Customer Webhooks
  • ✅ Delete Customer Webhooks
  • ✅ Retrieve Webhook Signing Key
• Sub-accounts
  • ✅ Create Sub-account
  • ✅ Retrieve Sub-accounts
  • 🚧 Delete Sub-account
  • 🚧 Activate Sub-account
  • 🚧 Suspend Sub-account
  • ✅ Create Sub-account API Key
  • 🚧 Delete Sub-account API Key
  • 🚧 Retrieve Sub-account API Keys
  • ✅ Create Sub-account SMTP password
  • 🚧 Delete Sub-account SMTP password
  • 🚧 Retrieve Sub-account SMTP Passwords

💻 Development

Local development

# Install dependencies
pnpm install

# Build the package
npm run build

# Run ESLint
npm run lint

# Run Vitest
npm run test
npm run test:watch

# Run typecheck
npm run test:types

# Release new version
npm run release