Link check | mailpit unofficial

2 parameters

IDstringrequired

Message database ID or "latest"

followstringoptional

Follow redirects

Default:false

3 status codes

200LinkCheckResponse

Errorsintegeroptional

Total number of errors

Linksarray<object>optional

Tested links

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 "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
});

const result = await client.linkCheck.list({
  iD: "c0a80123-4567-89ab-cdef-0123456789ab",
  follow: "example",
});

{
  "Errors": 1,
  "Links": [
    {
      "Status": "active",
      "StatusCode": 1,
      "URL": "https://example.com"
    }
  ]
}