mymx 0.3.8 → 0.3.91

package/dist/contract.d.ts

@@ -1,4 +1,4 @@
-import { EmailAddress, EmailAuth, EmailReceivedEvent, ParsedDataComplete, ParsedDataFailed, ParsedError, RawContentDownloadOnly, RawContentInline, WEBHOOK_VERSION$1 as WEBHOOK_VERSION, WebhookAttachment } from "./types-B5aR2RnG.js";
+import { EmailAddress, EmailAnalysis, EmailAuth, EmailReceivedEvent, ParsedDataComplete, ParsedDataFailed, ParsedError, RawContentDownloadOnly, RawContentInline, WEBHOOK_VERSION$1 as WEBHOOK_VERSION, WebhookAttachment } from "./types-COLkx-eW.js";
 import { SignResult, signWebhookPayload$1 as signWebhookPayload } from "./signing-Ecohrukk.js";
 
 //#region src/contract.d.ts
@@ -86,6 +86,8 @@ interface EmailReceivedEventInput {
   parsed?: ParsedInput;
   /** Email authentication results (SPF, DKIM, DMARC) */
   auth: EmailAuth;
+  /** Email analysis results */
+  analysis: EmailAnalysis;
 }
 /**
  * Generate a stable event ID for webhook deduplication.
@@ -145,4 +147,4 @@ declare function buildEmailReceivedEvent(input: EmailReceivedEventInput, options
   /** Override attempted_at timestamp (for testing) */
   attempted_at?: string;
 }): EmailReceivedEvent; //#endregion
-export { EmailAddress, EmailAuth, EmailReceivedEvent, EmailReceivedEventInput, ParsedDataComplete, ParsedDataFailed, ParsedError, ParsedInput, ParsedInputComplete, ParsedInputFailed, RAW_EMAIL_INLINE_THRESHOLD, RawContentDownloadOnly, RawContentInline, SignResult, WEBHOOK_VERSION, WebhookAttachment, buildEmailReceivedEvent, generateEventId, signWebhookPayload };
+export { EmailAddress, EmailAnalysis, EmailAuth, EmailReceivedEvent, EmailReceivedEventInput, ParsedDataComplete, ParsedDataFailed, ParsedError, ParsedInput, ParsedInputComplete, ParsedInputFailed, RAW_EMAIL_INLINE_THRESHOLD, RawContentDownloadOnly, RawContentInline, SignResult, WEBHOOK_VERSION, WebhookAttachment, buildEmailReceivedEvent, generateEventId, signWebhookPayload };

package/dist/contract.js

@@ -175,6 +175,7 @@ function buildEmailReceivedEvent(input, options) {
 				}
 			},
 			parsed: parsedData,
+			analysis: input.analysis,
 			auth: input.auth
 		}
 	};

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { AuthConfidence, AuthVerdict, DkimSignature, DkimSignatureResult, DmarcPolicy, DmarcResult, EmailAddress, EmailAuth, EmailReceivedEvent, KnownWebhookEvent, ParsedData, ParsedDataComplete, ParsedDataFailed, ParsedError, ParsedStatus, RawContent, RawContentDownloadOnly, RawContentInline, SpfResult, UnknownEvent, ValidateEmailAuthResult, WEBHOOK_VERSION$1 as WEBHOOK_VERSION, WebhookAttachment, WebhookEvent } from "./types-B5aR2RnG.js";
+import { AuthConfidence, AuthVerdict, DkimResult, DkimSignature, DmarcPolicy, DmarcResult, EmailAddress, EmailAnalysis, EmailAuth, EmailReceivedEvent, EventType, ForwardAnalysis, ForwardOriginalSender, ForwardResult, ForwardResultAttachmentAnalyzed, ForwardResultAttachmentSkipped, ForwardResultInline, ForwardVerdict, ForwardVerification, KnownWebhookEvent, ParsedData, ParsedDataComplete, ParsedDataFailed, ParsedError, ParsedStatus, RawContent, RawContentDownloadOnly, RawContentInline, SpfResult, UnknownEvent, ValidateEmailAuthResult, WEBHOOK_VERSION$1 as WEBHOOK_VERSION, WebhookAttachment, WebhookEvent } from "./types-COLkx-eW.js";
 import { MYMX_CONFIRMED_HEADER$1 as MYMX_CONFIRMED_HEADER, MYMX_SIGNATURE_HEADER$1 as MYMX_SIGNATURE_HEADER, VerifyOptions, verifyWebhookSignature$1 as verifyWebhookSignature } from "./signing-Ecohrukk.js";
 import { MyMXWebhookError$1 as MyMXWebhookError, PAYLOAD_ERRORS$1 as PAYLOAD_ERRORS, RAW_EMAIL_ERRORS$1 as RAW_EMAIL_ERRORS, RawEmailDecodeError$1 as RawEmailDecodeError, RawEmailDecodeErrorCode, VERIFICATION_ERRORS$1 as VERIFICATION_ERRORS, WebhookErrorCode, WebhookPayloadError$1 as WebhookPayloadError, WebhookPayloadErrorCode, WebhookValidationError$1 as WebhookValidationError, WebhookValidationErrorCode, WebhookVerificationError$1 as WebhookVerificationError, WebhookVerificationErrorCode } from "./errors-CSPHzZB_.js";
 
@@ -152,31 +152,15 @@ declare const emailReceivedEventJsonSchema: {
               readonly description: "Parsed email content (body text, HTML, attachments). Check `status` to determine if parsing succeeded.";
             };
             readonly analysis: {
-              readonly type: "object";
-              readonly properties: {
-                readonly spamassassin: {
-                  readonly type: "object";
-                  readonly properties: {
-                    readonly score: {
-                      readonly type: "number";
-                      readonly description: "Overall spam score (sum of all rule scores). Higher scores indicate higher likelihood of spam. Unbounded - can be negative (ham) or very high (spam).";
-                    };
-                  };
-                  readonly required: ["score"];
-                  readonly additionalProperties: false;
-                  readonly description: "SpamAssassin analysis results.";
-                };
-              };
-              readonly required: ["spamassassin"];
-              readonly additionalProperties: false;
-              readonly description: "Email analysis and classification results. May be absent if analysis was not performed.";
+              readonly $ref: "#/definitions/EmailAnalysis";
+              readonly description: "Email analysis and classification results.";
             };
             readonly auth: {
               readonly $ref: "#/definitions/EmailAuth";
               readonly description: "Email authentication results (SPF, DKIM, DMARC).";
             };
           };
-          readonly required: ["id", "received_at", "smtp", "headers", "content", "parsed", "auth"];
+          readonly required: ["id", "received_at", "smtp", "headers", "content", "parsed", "analysis", "auth"];
           readonly additionalProperties: false;
           readonly description: "The email that triggered this event.";
         };
@@ -487,6 +471,235 @@ declare const emailReceivedEventJsonSchema: {
       readonly additionalProperties: false;
       readonly description: "Error details when email parsing fails.";
     };
+    readonly EmailAnalysis: {
+      readonly type: "object";
+      readonly properties: {
+        readonly spamassassin: {
+          readonly type: "object";
+          readonly properties: {
+            readonly score: {
+              readonly type: "number";
+              readonly description: "Overall spam score (sum of all rule scores). Higher scores indicate higher likelihood of spam. Unbounded - can be negative (ham) or very high (spam).";
+            };
+          };
+          readonly required: ["score"];
+          readonly additionalProperties: false;
+          readonly description: "SpamAssassin analysis results.";
+        };
+        readonly forward: {
+          readonly $ref: "#/definitions/ForwardAnalysis";
+          readonly description: "Forward detection and analysis results.";
+        };
+      };
+      readonly additionalProperties: false;
+      readonly description: "Email analysis and classification results.";
+    };
+    readonly ForwardAnalysis: {
+      readonly type: "object";
+      readonly properties: {
+        readonly detected: {
+          readonly type: "boolean";
+          readonly description: "Whether any forwards were detected in the email.";
+        };
+        readonly results: {
+          readonly type: "array";
+          readonly items: {
+            readonly $ref: "#/definitions/ForwardResult";
+          };
+          readonly description: "Analysis results for each detected forward.";
+        };
+        readonly attachments_found: {
+          readonly type: "number";
+          readonly description: "Total number of .eml attachments found.";
+        };
+        readonly attachments_analyzed: {
+          readonly type: "number";
+          readonly description: "Number of .eml attachments that were analyzed.";
+        };
+        readonly attachments_limit: {
+          readonly type: ["number", "null"];
+          readonly description: "Maximum number of attachments that will be analyzed, or null if unlimited.";
+        };
+      };
+      readonly required: ["detected", "results", "attachments_found", "attachments_analyzed", "attachments_limit"];
+      readonly additionalProperties: false;
+      readonly description: "Forward detection and analysis results.";
+    };
+    readonly ForwardResult: {
+      readonly anyOf: [{
+        readonly $ref: "#/definitions/ForwardResultInline";
+      }, {
+        readonly $ref: "#/definitions/ForwardResultAttachmentAnalyzed";
+      }, {
+        readonly $ref: "#/definitions/ForwardResultAttachmentSkipped";
+      }];
+      readonly description: "Result for a single forwarded email detected in the message.\n\nUse the `type` and `analyzed` fields to narrow the type:\n- `type: 'inline'` - Inline forward, always analyzed\n- `type: 'attachment'` + `analyzed: true` - Analyzed attachment\n- `type: 'attachment'` + `analyzed: false` - Skipped attachment";
+    };
+    readonly ForwardResultInline: {
+      readonly type: "object";
+      readonly properties: {
+        readonly type: {
+          readonly type: "string";
+          readonly const: "inline";
+        };
+        readonly original_sender: {
+          readonly anyOf: [{
+            readonly $ref: "#/definitions/ForwardOriginalSender";
+          }, {
+            readonly type: "null";
+          }];
+          readonly description: "Original sender of the forwarded email, if extractable.";
+        };
+        readonly verification: {
+          readonly $ref: "#/definitions/ForwardVerification";
+          readonly description: "Verification result for the forwarded email.";
+        };
+        readonly summary: {
+          readonly type: "string";
+          readonly description: "Human-readable summary of the forward analysis.";
+        };
+      };
+      readonly required: ["type", "original_sender", "verification", "summary"];
+      readonly additionalProperties: false;
+      readonly description: "Result for an inline forward that was detected and analyzed. Inline forwards are always analyzed when forward detection is enabled.";
+    };
+    readonly ForwardOriginalSender: {
+      readonly type: "object";
+      readonly properties: {
+        readonly email: {
+          readonly type: "string";
+          readonly description: "Email address of the original sender.";
+        };
+        readonly domain: {
+          readonly type: "string";
+          readonly description: "Domain of the original sender.";
+        };
+      };
+      readonly required: ["email", "domain"];
+      readonly additionalProperties: false;
+      readonly description: "Original sender information extracted from the forwarded email.";
+    };
+    readonly ForwardVerification: {
+      readonly type: "object";
+      readonly properties: {
+        readonly verdict: {
+          readonly $ref: "#/definitions/ForwardVerdict";
+          readonly description: "Overall verdict on whether the forward is authentic.";
+        };
+        readonly confidence: {
+          readonly $ref: "#/definitions/AuthConfidence";
+          readonly description: "Confidence level for this verdict.";
+        };
+        readonly dkim_verified: {
+          readonly type: "boolean";
+          readonly description: "Whether a valid DKIM signature was found that verifies the original sender.";
+        };
+        readonly dkim_domain: {
+          readonly type: ["string", "null"];
+          readonly description: "Domain of the DKIM signature that verified the forward, if any.";
+        };
+        readonly dmarc_policy: {
+          readonly $ref: "#/definitions/DmarcPolicy";
+          readonly description: "DMARC policy of the original sender's domain.";
+        };
+      };
+      readonly required: ["verdict", "confidence", "dkim_verified", "dkim_domain", "dmarc_policy"];
+      readonly additionalProperties: false;
+      readonly description: "Verification result for a forwarded email.";
+    };
+    readonly ForwardVerdict: {
+      readonly type: "string";
+      readonly enum: ["legit", "unknown"];
+      readonly description: "Verdict for forwarded email verification.\n\n- `legit`: DKIM signature verified the original sender\n- `unknown`: Could not verify the forwarded email's authenticity";
+    };
+    readonly AuthConfidence: {
+      readonly type: "string";
+      readonly enum: ["high", "medium", "low"];
+      readonly description: "Confidence level for the authentication verdict.\n\n- `high`: Strong cryptographic evidence (DKIM aligned + DMARC pass)\n- `medium`: Good evidence but with caveats (SPF-only alignment)\n- `low`: Weak evidence (missing authentication or unclear results)";
+    };
+    readonly DmarcPolicy: {
+      readonly type: ["string", "null"];
+      readonly enum: ["reject", "quarantine", "none", null];
+      readonly description: "DMARC policy action specified in the domain's DMARC record.\n\n- `reject`: The domain owner requests that receivers reject failing emails\n- `quarantine`: The domain owner requests that failing emails be treated as suspicious\n- `none`: The domain owner is only monitoring (no action requested)\n- `null`: No DMARC policy was found for the domain";
+    };
+    readonly ForwardResultAttachmentAnalyzed: {
+      readonly type: "object";
+      readonly properties: {
+        readonly type: {
+          readonly type: "string";
+          readonly const: "attachment";
+        };
+        readonly attachment_tar_path: {
+          readonly type: "string";
+          readonly description: "Path to the attachment in the attachments tar archive.";
+        };
+        readonly attachment_filename: {
+          readonly type: ["string", "null"];
+          readonly description: "Original filename of the attachment, if available.";
+        };
+        readonly analyzed: {
+          readonly type: "boolean";
+          readonly const: true;
+          readonly description: "Whether this attachment was analyzed.";
+        };
+        readonly original_sender: {
+          readonly anyOf: [{
+            readonly $ref: "#/definitions/ForwardOriginalSender";
+          }, {
+            readonly type: "null";
+          }];
+          readonly description: "Original sender of the forwarded email, if extractable.";
+        };
+        readonly verification: {
+          readonly $ref: "#/definitions/ForwardVerification";
+          readonly description: "Verification result for the forwarded email.";
+        };
+        readonly summary: {
+          readonly type: "string";
+          readonly description: "Human-readable summary of the forward analysis.";
+        };
+      };
+      readonly required: ["type", "attachment_tar_path", "attachment_filename", "analyzed", "original_sender", "verification", "summary"];
+      readonly additionalProperties: false;
+      readonly description: "Result for an attachment forward that was analyzed.";
+    };
+    readonly ForwardResultAttachmentSkipped: {
+      readonly type: "object";
+      readonly properties: {
+        readonly type: {
+          readonly type: "string";
+          readonly const: "attachment";
+        };
+        readonly attachment_tar_path: {
+          readonly type: "string";
+          readonly description: "Path to the attachment in the attachments tar archive.";
+        };
+        readonly attachment_filename: {
+          readonly type: ["string", "null"];
+          readonly description: "Original filename of the attachment, if available.";
+        };
+        readonly analyzed: {
+          readonly type: "boolean";
+          readonly const: false;
+          readonly description: "Whether this attachment was analyzed.";
+        };
+        readonly original_sender: {
+          readonly type: "null";
+          readonly description: "Always null when not analyzed.";
+        };
+        readonly verification: {
+          readonly type: "null";
+          readonly description: "Always null when not analyzed.";
+        };
+        readonly summary: {
+          readonly type: "string";
+          readonly description: "Human-readable summary explaining why analysis was skipped.";
+        };
+      };
+      readonly required: ["type", "attachment_tar_path", "attachment_filename", "analyzed", "original_sender", "verification", "summary"];
+      readonly additionalProperties: false;
+      readonly description: "Result for an attachment forward that was detected but not analyzed. This occurs when attachment analysis is disabled or the limit was reached.";
+    };
     readonly EmailAuth: {
       readonly type: "object";
       readonly properties: {
@@ -544,11 +757,6 @@ declare const emailReceivedEventJsonSchema: {
       readonly enum: ["pass", "fail", "none", "temperror", "permerror"];
       readonly description: "DMARC verification result.";
     };
-    readonly DmarcPolicy: {
-      readonly type: ["string", "null"];
-      readonly enum: ["reject", "quarantine", "none", null];
-      readonly description: "DMARC policy action specified in the domain's DMARC record.\n\n- `reject`: The domain owner requests that receivers reject failing emails\n- `quarantine`: The domain owner requests that failing emails be treated as suspicious\n- `none`: The domain owner is only monitoring (no action requested)\n- `null`: No DMARC policy was found for the domain";
-    };
     readonly DkimSignature: {
       readonly type: "object";
       readonly properties: {
@@ -561,7 +769,7 @@ declare const emailReceivedEventJsonSchema: {
           readonly description: "The DKIM selector used to locate the public key (s= tag). Combined with the domain to form the DNS lookup: `selector._domainkey.domain`";
         };
         readonly result: {
-          readonly $ref: "#/definitions/DkimSignatureResult";
+          readonly $ref: "#/definitions/DkimResult";
           readonly description: "Verification result for this specific signature.";
         };
         readonly aligned: {
@@ -581,7 +789,7 @@ declare const emailReceivedEventJsonSchema: {
       readonly additionalProperties: false;
       readonly description: "Details about a single DKIM signature found in the email.\n\nAn email may have multiple DKIM signatures (e.g., one from the sending domain and one from the ESP). Each signature is verified independently.";
     };
-    readonly DkimSignatureResult: {
+    readonly DkimResult: {
       readonly type: "string";
       readonly enum: ["pass", "fail", "temperror", "permerror"];
       readonly description: "DKIM signature verification result for a single signature.";
@@ -927,4 +1135,4 @@ declare function decodeRawEmail(event: EmailReceivedEvent, options?: DecodeRawEm
 declare function verifyRawEmailDownload(downloaded: Buffer | ArrayBuffer | Uint8Array, event: EmailReceivedEvent): Buffer;
 
 //#endregion
-export { AuthConfidence, AuthVerdict, DecodeRawEmailOptions, DkimSignature, DkimSignatureResult, DmarcPolicy, DmarcResult, EmailAddress, EmailAuth, EmailReceivedEvent, HandleWebhookOptions, KnownWebhookEvent, MYMX_CONFIRMED_HEADER, MYMX_SIGNATURE_HEADER, MyMXWebhookError, PAYLOAD_ERRORS, ParsedData, ParsedDataComplete, ParsedDataFailed, ParsedError, ParsedStatus, RAW_EMAIL_ERRORS, RawContent, RawContentDownloadOnly, RawContentInline, RawEmailDecodeError, RawEmailDecodeErrorCode, SpfResult, UnknownEvent, VERIFICATION_ERRORS, ValidateEmailAuthResult, VerifyOptions, WEBHOOK_VERSION, WebhookAttachment, WebhookErrorCode, WebhookEvent, WebhookHeaders, WebhookPayloadError, WebhookPayloadErrorCode, WebhookValidationError, WebhookValidationErrorCode, WebhookVerificationError, WebhookVerificationErrorCode, confirmedHeaders, decodeRawEmail, emailReceivedEventJsonSchema, getDownloadTimeRemaining, handleWebhook, isDownloadExpired, isEmailReceivedEvent, isRawIncluded, parseWebhookEvent, validateEmailAuth, verifyRawEmailDownload, verifyWebhookSignature };
+export { AuthConfidence, AuthVerdict, DecodeRawEmailOptions, DkimResult, DkimSignature, DmarcPolicy, DmarcResult, EmailAddress, EmailAnalysis, EmailAuth, EmailReceivedEvent, EventType, ForwardAnalysis, ForwardOriginalSender, ForwardResult, ForwardResultAttachmentAnalyzed, ForwardResultAttachmentSkipped, ForwardResultInline, ForwardVerdict, ForwardVerification, HandleWebhookOptions, KnownWebhookEvent, MYMX_CONFIRMED_HEADER, MYMX_SIGNATURE_HEADER, MyMXWebhookError, PAYLOAD_ERRORS, ParsedData, ParsedDataComplete, ParsedDataFailed, ParsedError, ParsedStatus, RAW_EMAIL_ERRORS, RawContent, RawContentDownloadOnly, RawContentInline, RawEmailDecodeError, RawEmailDecodeErrorCode, SpfResult, UnknownEvent, VERIFICATION_ERRORS, ValidateEmailAuthResult, VerifyOptions, WEBHOOK_VERSION, WebhookAttachment, WebhookErrorCode, WebhookEvent, WebhookHeaders, WebhookPayloadError, WebhookPayloadErrorCode, WebhookValidationError, WebhookValidationErrorCode, WebhookVerificationError, WebhookVerificationErrorCode, confirmedHeaders, decodeRawEmail, emailReceivedEventJsonSchema, getDownloadTimeRemaining, handleWebhook, isDownloadExpired, isEmailReceivedEvent, isRawIncluded, parseWebhookEvent, validateEmailAuth, verifyRawEmailDownload, verifyWebhookSignature };