lumail.emails.verify

SDK 2.1.0 · API v2 · POST /api/v2/emails/verify

MethodPOST

/api/v2/emails/verify

Request Examples

import { Lumail } from "lumail";

const lumail = new Lumail({ apiKey: process.env.LUMAIL_API_KEY });
const { data, error } = await lumail.emails.verify({
  email: "[email protected]",
});
if (error) {
  throw error;
}
console.log(data.valid);

Response Examples

{ "valid": true }

[email protected] · lumail.emails

emails.verify({ email: string }): Promise<LumailResult<VerifyEmailResponse>>

Syntax and deliverability check. A timeout is { data: null, error: { name: "timeout" } }, never a successful verify. { valid: false, error, code } is still HTTP 200 and lands in data.

Body Parameters

Name	Type	Description
`email`	string	Required. Address to check.

Response Fields

Field	Type	Description
`valid`	boolean	`true` when the address passes. `false` on a completed check that failed.
`warnings`	string[]	Optional warnings on either outcome.
`error`	string	Present when `valid` is `false`. Human-readable reason.
`code`	`"invalid_format"` / `"disposable_email"` / `"spam_domain"` / `"invalid_domain"` / `"test_email"` / `"internal_error"`	Present when `valid` is `false`.
`suggestion`	string	Optional correction when `valid` is `false`.

data is { valid: true } or { valid: false, error, code, ... }. Transport failures, including timeout, return { data: null, error }.

Previouslumail.emails.list Nextlumail.subscribers