MailChannels Node.js SDK

MailChannelsNode.js SDK

Integrate MailChannels API into your JavaScript or TypeScript server-side applications.

Emails module

Send transactional emails

Webhooks module

Notifications for email events

Sub-accounts module

Manage sub-accounts

Metrics module

Retrieve account metrics

Suppressions module

Manage account suppressions

Domains module

Manage Inbound domains

Lists module

Manage account-level lists

Users module

Manage recipient users

IMPORTANT

Disclaimer: This library is not associated with MailChannels Corporation.

🚧 Roadmap

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

NOTE

Links below point to the official MailChannels API documentation, options and responses may differ slightly when using this SDK. Please refer to the documentation for the correct usage of each feature.

Email API

📧 Emails
- ✅ Send an Email
- ✅ DKIM, SPF & Domain Lockdown Check
- ✅ Create DKIM Key Pair
- ✅ Retrieve DKIM Keys
- ✅ Update DKIM Key Status
- ✅ Rotate DKIM Key Pair
📢 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
- ✅ Retrieve Sender 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
📥 Users
- ✅ Create a recipient
- ✅ Add item to recipient list
- ✅ Get recipient list entries
- ✅ Delete item from recipient list
⚙️ Service