Link check | Mailpit SDK Examples

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 "@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.linkCheck.list({
  id: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21",
  follow: "example",
});

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