mailchannels-sdk

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.

[!NOTE] This library is NOT officially maintained by MailChannels Corporation.

• ✨ 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
• Retrieve metrics
• Manage suppressions
• Manage inbound domains
• Manage account lists
• Manage recipient lists

📏 Requirements

• MailChannels account
• Email API key

🏃 Quick setup

1. Add mailchannels-sdk dependency to your project

# npm
npm i mailchannels-sdk

# yarn
yarn add mailchannels-sdk

# pnpm
pnpm add mailchannels-sdk

⚖️ License

MIT License

🚧 Roadmap

Already implemented features are marked with a checkmark. Please open an issue if you find any bugs or missing features.

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
  • ✅ Validate Enrolled Webhook
• 🪪 Sub-accounts
  • ✅ Create Sub-account
  • ✅ Retrieve Sub-accounts
  • ✅ Delete Sub-account
  • ✅ Suspend Sub-account
  • ✅ Activate 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
  • ✅ Retrieve Sub-account Limit
  • ✅ Set Sub-account Limit
  • ✅ Delete Sub-account Limit
  • ✅ Retrieve Sub-account Usage Stats
• 📊 Metrics
  • ✅ Retrieve Engagement Metrics
  • ✅ Retrieve Performance Metrics
  • ✅ Retrieve Recipient Behaviour Metrics
  • ✅ Retrieve Usage Stats
  • ✅ Retrieve Volume Metrics
• 🚫 Suppressions
  • ✅ Create Suppression Entries
  • ✅ Delete Suppression Entry
  • ✅ Retrieve Suppression List

Inbound API

• 🌐 Domains
  • ✅ Provision domain
  • ✅ Remove domain
  • ✅ List domains
  • ✅ Bulk provision domains
  • ✅ Add domain list entry
  • ✅ Get domain list entries
  • ✅ Delete domain list entry
  • ✅ Create login link
  • ✅ Bulk create login links
  • ✅ Set downstream address
  • ✅ Fetch downstream addresses
  • ✅ Update API key
• 📋 Lists
  • ✅ Add item to customer list
  • ✅ Delete item from customer list
  • ✅ Get customer list entries
• 📥 Users
  • ✅ Create a recipient
  • ✅ Add item to recipient list
  • ✅ Get recipient list entries
  • ✅ Delete item from recipient list
• ⚙️ Service
  • ✅ Retrieve the condition of the service
  • ✅ Submit a false negative or false positive report
  • ✅ Get a list of your subscriptions to MailChannels Inbound

💻 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