HTML check | Mailpit SDK Examples

1 parameter

IDstringrequired

Message database ID or "latest"

3 status codes

200HTMLCheckResponse

Platformsobjectoptional

All platforms tested, mainly for the web UI

Totalobjectoptional

Total weighted result for all scores

Warningsarray<object>optional

List of warnings from tests

400Server error will return with a 400 status code with the error message in the body

404Not found error will return a 404 status code

Error handling

A 400 is returned: Server error will return with a 400 status code with the error message in the body. A 404 is returned: Not found error will return a 404 status code.

import { Client } from "@octridev/mailpit-example";

const client = new Client({
  baseUrl: "http://localhost:8025",
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 250,
    maxBackoffMs: 2000,
  },
  timeoutMs: 10000,
});

const result = await client.htmlCheck.list({ id: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21" });

{
  "Total": {
    "Nodes": 1,
    "Partial": 1,
    "Supported": 1,
    "Tests": 1,
    "Unsupported": 1
  },
  "Warnings": [
    {
      "Category": "example_value",
      "Description": "Example description",
      "Keywords": "example_key_abc123",
      "Results": [
        {
          "Family": "example_value",
          "Name": "Example Name",
          "NoteNumber": "example_value",
          "Platform": "example_value",
          "Support": "example_value",
          "Version": "example_value"
        }
      ],
      "Score": {
        "Found": 1,
        "Partial": 1,
        "Supported": 1,
        "Unsupported": 1
      },
      "Slug": "my-example-resource",
      "Tags": [
        "example_value"
      ],
      "Title": "Example Title",
      "URL": "https://example.com"
    }
  ]
}

Request

Response

Errors