Skip to content

Function: analyzeEmail()

ts
function analyzeEmail(email: string, options?: EmailOptions): Analysis | null;

Analyzes a string to verify it is a valid email address.

Parameters

ParameterTypeDescription
emailstringthe email address to validate.
options?EmailOptionsoptional settings.

Returns

Analysis | null

  • undefined when valid, otherwise an object with single error key with a string message value.