API

Every mailcheck.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.

New to Corsair? See API access, authentication, and error handling.

Domain

domain.validate Check a domain for MX records, disposable providers, and catch-all mail Risk: read

await corsair.mailcheck.api.domain.validate({});

Input

Name	Type	Required	Description
`domain`	`string`	Yes	—

Output

Name	Type	Required	Description
`domain`	`string`	Yes	—
`mxExists`	`boolean`	Yes	—
`isNotDisposable`	`boolean`	Yes	—
`isNotSmtpCatchAll`	`boolean`	Yes	—

email.verify Verify an email for syntax, MX records, and SMTP validity Risk: read

await corsair.mailcheck.api.email.verify({});

Input

Name	Type	Required	Description
`email`	`string`	Yes	—

Output

Name	Type	Required	Description
`email`	`string`	Yes	—
`trustRate`	`number`	Yes	—
`mxExists`	`boolean`	Yes	—
`smtpExists`	`boolean`	Yes	—
`isNotDisposable`	`boolean`	Yes	—
`isNotSmtpCatchAll`	`boolean`	Yes	—
`gravatar`	`object`	No	—

gravatar full type

{
  entries?: {
    profileUrl?: string,
    preferredUsername?: string,
    accounts?: {
      domain: string
    }[]
  }[]
}