mailpit-api - v1.5.3
    Preparing search index...

    Interface MailpitHTMLCheckResponse

    Response from the htmlCheck() API containing HTML check results.

    interface MailpitHTMLCheckResponse {
        Platforms: { [key: string]: [string] };
        Total: {
            Nodes: number;
            Partial: number;
            Supported: number;
            Tests: number;
            Unsupported: number;
        };
        Warnings: {
            Category: "css"
            | "html";
            Description: string;
            Keywords: string;
            NotesByNumber: { [key: string]: string };
            Results: {
                Family: string;
                Name: string;
                NoteNumber: string;
                Platform: string;
                Support: "yes" | "no" | "partial";
                Version: string;
            }[];
            Score: {
                Found: number;
                Partial: number;
                Supported: number;
                Unsupported: number;
            };
            Slug: string;
            Tags: string[];
            Title: string;
            URL: string;
        }[];
    }
    Index

    Properties

    Platforms Total Warnings

    Properties

    Platforms: { [key: string]: [string] }

    All platforms tested, mainly for the web UI

    Total: {
        Nodes: number;
        Partial: number;
        Supported: number;
        Tests: number;
        Unsupported: number;
    }

    Total weighted result for all scores

    Type declaration

    • Nodes: number

      Total number of HTML nodes detected in message

    • Partial: number

      Overall percentage partially supported

    • Supported: number

      Overall percentage supported

    • Tests: number

      Total number of tests done

    • Unsupported: number

      Overall percentage unsupported

    Warnings: {
        Category: "css" | "html";
        Description: string;
        Keywords: string;
        NotesByNumber: { [key: string]: string };
        Results: {
            Family: string;
            Name: string;
            NoteNumber: string;
            Platform: string;
            Support: "yes" | "no" | "partial";
            Version: string;
        }[];
        Score: {
            Found: number;
            Partial: number;
            Supported: number;
            Unsupported: number;
        };
        Slug: string;
        Tags: string[];
        Title: string;
        URL: string;
    }[]

    List of warnings from tests

    Type declaration

    • Category: "css" | "html"

      Category

    • Description: string

      Description

    • Keywords: string

      Keywords

    • NotesByNumber: { [key: string]: string }

      Notes based on results

    • Results: {
          Family: string;
          Name: string;
          NoteNumber: string;
          Platform: string;
          Support: "yes" | "no" | "partial";
          Version: string;
      }[]

      Test results

    • Score: { Found: number; Partial: number; Supported: number; Unsupported: number }

      Score object

      • Found: number

        Number of matches in the document

      • Partial: number

        Total percentage partially supported

      • Supported: number

        Total percentage supported

      • Unsupported: number

        Total percentage unsupported

    • Slug: string

      Slug identifier

    • Tags: string[]

      Tags

    • Title: string

      Friendly title

    • URL: string

      URL to caniemail.com

    Settings

    Member Visibility

    On This Page

    Properties