mailchannels-sdk 1.4.0 → 1.5.0

package/.agents/skills/mailchannels-js/resources/domain-checks.md

@@ -86,6 +86,18 @@ const { data, error } = await mc.domains.check('example.com', {
 
 If your lockdown record uses `auth=` (account-wide authorization), omit `senderId`.
 
+## With A Different Envelope-From Domain
+
+If the envelope-from domain used during delivery differs from the domain you are
+checking, provide it with `envelopeFromDomain` so SPF is evaluated against the
+correct domain:
+
+```ts
+const { data, error } = await mc.domains.check('example.com', {
+  envelopeFromDomain: 'bounce.example.net'
+})
+```
+
 ## Verdicts Reference
 
 - DKIM, Domain Lockdown, A, and MX verdicts: `'passed'` or `'failed'`.

package/README.md

@@ -9,7 +9,7 @@
 [![TypeScript][typescript-src]][typescript-href]
 [![Node.js][node-src]][node-href]
 
-> Built and tested against Email API `1.6.0`
+> Built and tested against Email API `1.7.0`
 
 Node.js SDK to integrate [MailChannels Email API](https://docs.mailchannels.com/email-api) into your JavaScript or TypeScript server-side applications.
 
@@ -57,7 +57,7 @@ Some of the things you can do with the SDK:
 ## <a name="prerequisites">📏 Prerequisites</a>
 
 - [Create a MailChannels account](https://www.mailchannels.com/pricing/#for_devs)
-- [Create an API key](https://console.mailchannels.net/settings/accountSettings#APIKeys)
+- [Create an API key](https://dash.mailchannels.com/account/api-keys)
 
 ## <a name="installation">📦 Installation</a>
 

package/dist/_chunks/mailchannels.d.mts

@@ -475,7 +475,7 @@ type EmailsSendResponse = DataResponse<{
     /**
      * The index of the personalization in the request. Starts at 0.
      */
-    index?: number;
+    index: number;
     /**
      * The Message ID is a unique identifier generated by the service. Each personalization has a distinct Message ID, which is also used in the `Message-Id` header and included in webhooks.
      */
@@ -888,7 +888,7 @@ declare class DomainsCustomTracking {
    */
   delete(hostname: string, scope: DomainsCustomTrackingScope): Promise<SuccessResponse>;
 }
-interface DomainsCheck {
+interface DomainsCheckDkim {
   /**
    * Domain used for DKIM signing.
    */
@@ -912,9 +912,15 @@ interface DomainsCheckOptions {
    * 5. If `privateKey` is present, `selector` must be present.
    * 6. If `selector` is present and `domain` is not, the domain will be taken from the domain field of the request.
    */
-  dkim?: DomainsCheck[] | DomainsCheck;
+  dkim?: DomainsCheckDkim[] | DomainsCheckDkim;
   /**
-   * Used exclusively for [Domain Lockdown](https://support.mailchannels.com/hc/en-us/articles/16918954360845-Secure-your-domain-name-against-spoofing-with-Domain-Lockdown) verification. If you're not using senderid to associate your domain with your account, you can disregard this field. The corresponding value is included in the `X-MailChannels-SenderId` header of emails sent via MailChannels.
+   * Optional envelope-from domain. During message delivery, SPF is evaluated against the envelope sender domain.
+   * If your envelope-from domain differs from the domain used for sending messages, provide it here to ensure SPF
+   * is checked against the correct domain. Otherwise, SPF failures may cause recipient servers to reject messages.
+   */
+  envelopeFromDomain?: string;
+  /**
+   * Used exclusively for [Domain Lockdown](https://docs.mailchannels.com/email-api/domain-lockdown) verification. If you're not using senderid to associate your domain with your account, you can disregard this field. The corresponding value is included in the `X-MailChannels-SenderId` header of emails sent via MailChannels.
    */
   senderId?: string;
 }
@@ -941,7 +947,7 @@ type DomainsCheckResponse = DataResponse<{
     verdict: Extract<DomainsCheckVerdict, "passed" | "failed">;
   };
   /**
-   * These results are here to help avoid [SDNF](https://support.mailchannels.com/hc/en-us/articles/203155500-550-5-2-1-SDNF-Sender-Domain-Not-Found) (Sender Domain Not Found) blocks. For messages not to get blocked by SDNF, we require either an MX or A record to exist for the sender domain.
+   * These results are here to help avoid [SDNF](https://docs.mailchannels.com/email-api/troubleshooting#550-5-1-2-sdnf-sender-domain-not-found) (Sender Domain Not Found) blocks. For messages not to get blocked by SDNF, we require either an MX or A record to exist for the sender domain.
    */
   senderDomain: {
     a: {

package/dist/_chunks/mailchannels.mjs

@@ -3,7 +3,7 @@ import { subtle } from "node:crypto";
 import { Buffer } from "node:buffer";
 import mime from "mime";
 var name = "mailchannels-sdk";
-var version = "1.4.0";
+var version = "1.5.0";
 var MailChannelsClient = class MailChannelsClient {
 	static DEFAULT_BASE_URL = "https://api.mailchannels.net";
 	static DEFAULT_TIMEOUT = 12e4;
@@ -904,6 +904,7 @@ var Domains = class {
 				dkim_selector: dkim.selector
 			})),
 			domain,
+			envelope_from_domain: options?.envelopeFromDomain,
 			sender_id: options?.senderId
 		};
 		const response = await this.mailchannels.post("/tx/v1/check-domain", {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mailchannels-sdk",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "description": "Node.js SDK to integrate MailChannels Email API into your JavaScript or TypeScript server-side applications.",
   "type": "module",
   "license": "MIT",