SDK-API Mapping

This page provides a mapping between the MailChannels SDK module methods and the corresponding API endpoint reference.

Email API

📧 Emails

SDK Method	API Reference
`Emails.send()`	Send an Email
`Emails.queue()`	Send an Email Asynchronously

🌐 Domains

SDK Method	API Reference
`Domains.check()`	DKIM, SPF & Domain Lockdown Check
`Domains.dkim.create()`	Create DKIM Key Pair
`Domains.dkim.list()`	Retrieve DKIM Keys
`Domains.dkim.updateStatus()`	Update DKIM Key Status
`Domains.dkim.rotate()`	Rotate DKIM Key Pair

📢 Webhooks

SDK Method	API Reference
`Webhooks.create()`	Enroll for Webhook Notifications
`Webhooks.list()`	Retrieve Customer Webhooks
`Webhooks.deleteAll()`	Delete Customer Webhooks
`Webhooks.getSigningKey()`	Retrieve Webhook Signing Key
`Webhooks.validate()`	Validate Enrolled Webhook
`Webhooks.verify()`	SDK only
`Webhooks.batches()`	Retrieve Webhook Batches
`Webhooks.resendBatch()`	Resend Events

🪪 Sub-accounts

SDK Method	API Reference
`SubAccounts.create()`	Create Sub-account
`SubAccounts.list()`	Retrieve Sub-accounts
`SubAccounts.delete()`	Delete Sub-account
`SubAccounts.suspend()`	Suspend Sub-account
`SubAccounts.activate()`	Activate Sub-account
`SubAccounts.createApiKey()`	Create Sub-account API Key
`SubAccounts.deleteApiKey()`	Delete Sub-account API Key
`SubAccounts.listApiKeys()`	Retrieve Sub-account API Keys
`SubAccounts.createSmtpPassword()`	Create Sub-account SMTP Password
`SubAccounts.deleteSmtpPassword()`	Delete Sub-account SMTP Password
`SubAccounts.listSmtpPasswords()`	Retrieve Sub-account SMTP Passwords
`SubAccounts.getLimit()`	Retrieve Sub-account Limit
`SubAccounts.setLimit()`	Set Sub-account Limit
`SubAccounts.deleteLimit()`	Delete Sub-account Limit
`SubAccounts.getUsage()`	Retrieve Sub-account Usage Stats

📊 Metrics

SDK Method	API Reference
`Metrics.engagement()`	Retrieve Engagement Metrics
`Metrics.performance()`	Retrieve Performance Metrics
`Metrics.recipientBehaviour()`	Retrieve Recipient Behaviour Metrics
`Metrics.usage()`	Retrieve Usage Stats
`Metrics.volume()`	Retrieve Volume Metrics
`Metrics.senders()`	Retrieve Sender Metrics

🚫 Suppressions

SDK Method	API Reference
`Suppressions.create()`	Create Suppression Entries
`Suppressions.delete()`	Delete Suppression Entry
`Suppressions.list()`	Retrieve Suppression List