Introduced deliverability reporting request/models

Author: ey-mailosaur

src/mailosaurCommands.d.ts

@@ -513,6 +513,180 @@ export interface SpamAnalysisResult {
     score?: number;
 }
 
+/**
+ * The results of deliverability report performed by Mailosaur.
+ */
+export interface DeliverabilityReport {
+    /**
+     * The result of checking for SPF issues
+     */
+    spf?: EmailAuthenticationResult;
+    /**
+     * The result of checking for DKIM issues
+     */
+    dkim?: EmailAuthenticationResult[];
+    /**
+     * The result of checking for DMARC issues
+     */
+    dmarc?: EmailAuthenticationResult;
+    /**
+     * The result of each blocklist that was checked
+     */
+    blockLists?: BlockListResult[];
+    /**
+     * The result of content checks made on the email
+     */
+    content?: Content;
+    /**
+     * The DNS records checks made against the sender's domain
+     */
+    dnsRecords?: DnsRecords;
+    /**
+     * The result of spam analysis performed by Mailosaur 
+     */
+    spamAssassin?: SpamAssassinResult;
+}
+
+/**
+ * The result of an email domain check
+ */
+export interface EmailAuthenticationResult {
+    /**
+     * The result of the check
+     */
+    result?: ResultEnum;
+    /**
+     * A description of any issue/notes found
+     */
+    description?: string;
+    /**
+     * The raw values returned from the check
+     */
+    rawValue?: string;
+    /** 
+     * The seperated tags returned from the check
+    */
+    tags?: { [key: string]: string};
+}
+
+/**
+ * The result of an domain check against a blocklist checker
+ */
+export interface BlockListResult{
+    /**
+     * The identifier of the blocklist
+     */
+    id: string;
+    /**
+     * The name of the blocklist
+     */
+    name: string;
+    /**
+     * The result of the blocklist check
+     */
+    result: ResultEnum;
+}
+
+/**
+ * The results of email content analysis
+ */
+export interface Content{
+    /**
+     * The content contained embed tags
+     */
+    embed: boolean;
+    /**
+     * The content contained Iframe tags
+     */
+    iframe: boolean;
+    /**
+     * The content contained object tags
+     */
+    object: boolean;
+    /**
+     * The content contained script tags
+     */
+    script: boolean;
+    /**
+     * The content contained URL's that have been shortened
+     */
+    shortUrls: boolean;
+    /**
+     * The length of all text that the content contained
+     */
+    textSize: number;
+    /**
+     * The length of all HTML that the content contained
+     */
+    totalSize: number;
+    /**
+     * Image(s) were missing "alt" properties
+     */
+    missingAlt: boolean;
+    /**
+     * The message is missing a "List-Unsubscribe" header
+     */
+    missingListUnsubscribe: boolean;
+}
+
+/**
+ * The records found when checking DNS records of an email sender's domain
+ */
+export interface DnsRecords{
+    /**
+     * The A Records of the sender's domain
+     */
+    a?: string[];
+    /**
+     * The MX Records of the sender's domain
+     */
+    mx?: string[];
+    /**
+     * The PTR Record of the sender's domain
+     */
+    ptr?: string[];
+}
+
+/**
+ * The results of spam assassin check performed by Mailosaur.
+ */
+export interface SpamAssassinResult{
+    /**
+     * Overall Mailosaur spam score.
+     */
+    score: number;
+    /**
+     * The result of the spam check
+     */
+    result: ResultEnum;
+    /**
+     * Spam Assassin filter rules.
+     */
+    rules: SpamAssassinRule[];
+}
+
+/**
+ * The result of a deliverability check
+ */
+export enum ResultEnum {
+    /**
+     * The check had a positive result
+     */
+    Pass,
+    /**
+     * The check was acceptable but could be improved
+     */
+    Warning,
+    /**
+     * The check had a negative result
+     */
+    Fail,
+    /**
+     * The check was inconclusive due to a timeout
+     */
+    Timeout
+}
+
 /**
  * The detail of an individual account limit.
  */
@@ -1023,7 +1197,17 @@ declare global {
                  * The identifier of the message to be analyzed.
                  */
                 messageId: string
-            ): Chainable<SpamAnalysisResult>;
+            ): Cypress.Chainable<SpamAnalysisResult>;
+
+            /**
+             * Perform a deliverability report of an email.
+             */
+            mailosaurGetDeliverabilityReport(
+                /**
+                 * The identifier of the message to be analyzed.
+                 */
+                messageId: string
+            ): Cypress.Chainable<DeliverabilityReport>;
 
             /**
              * Generates a random email address by appending a random string in front of the server's

src/mailosaurCommands.js

@@ -28,6 +28,7 @@ class MailosaurCommands {
       'mailosaurDownloadAttachment',
       'mailosaurDownloadMessage',
       'mailosaurGetSpamAnalysis',
+      'mailosaurGetDeliverabilityReport',
       'mailosaurGenerateEmailAddress',
       'mailosaurGetUsageLimits',
       'mailosaurGetUsageTransactions',
@@ -220,6 +221,10 @@ class MailosaurCommands {
     return this.request.get(`api/analysis/spam/${messageId}`);
   }
 
+  mailosaurGetDeliverabilityReport(messageId) {
+    return this.request.get(`api/analysis/deliverability/${messageId}`);
+  }
+
   mailosaurGenerateEmailAddress(serverId) {
     const host = Cypress.env('MAILOSAUR_SMTP_HOST') || 'mailosaur.net';
     const random = (Math.random() + 1).toString(36).substring(7);

test/react-app/cypress/e2e/messages.cy.js

@@ -327,6 +327,53 @@ describe('Mailosaur message commands', () => {
       });
     });
   });
+  
+  describe('.mailosaurGetDeliverabilityReport', () => {
+    it('should perform a deliverability report on an email', (done) => {
+      const targetId = emails[0].id;
+      cy.mailosaurGetDeliverabilityReport(targetId).then((result) => {
+
+        expect(result).to.be.ok;
+
+        result.dkim.forEach((dkim) => {
+          expect(dkim.result).to.be.ok;
+          expect(dkim.tags).to.be.ok;
+        });
+
+        expect(result.dmarc).to.be.ok;
+        expect(result.dmarc.result).to.be.ok;
+        expect(result.dmarc.tags).to.be.ok;
+
+        expect(result.blockLists).to.be.ok;
+        result.blockLists.forEach((blockList) => {
+          expect(blockList.result).to.be.ok;
+          expect(blockList.id).to.be.ok;
+          expect(blockList.name).to.be.ok;
+        });
+
+        expect(result.content).to.be.ok;
+        expect(result.content.embed).to.be.a('boolean');
+        expect(result.content.iframe).to.be.a('boolean');
+        expect(result.content.object).to.be.a('boolean');
+        expect(result.content.script).to.be.a('boolean');
+        expect(result.content.shortUrls).to.be.a('boolean');
+        expect(result.content.totalSize).to.be.ok;
+        expect(result.content.textSize).to.be.ok;
+        expect(result.content.missingAlt).to.be.a('boolean');
+        expect(result.content.missingListUnsubscribe).to.be.a('boolean');
+
+        expect(result.dnsRecords).to.be.ok;
+
+        expect(result.spamAssassin).to.be.ok;
+        result.spamAssassin.rules.forEach((rule) => {
+          expect(rule.score).to.be.a('number');
+          expect(rule.rule).to.be.ok;
+          expect(rule.description).to.be.ok;
+        });
+        done();
+      });
+    });
+  });
 
   describe('.mailosaurDeleteMessage', () => {
     it('should delete an email', (done) => {