@email-utils/classifier/classify

InterfacesCopy Anchor Link

ClassificationCopy Anchor Link

What the classifier knows about an address.

PropertiesCopy Anchor Link

disposableCopy Anchor Link

disposable: boolean;

From isDisposable.

providerCopy Anchor Link

provider: ProviderInfo | undefined;

The mailbox provider, from getProvider.

roleCopy Anchor Link

role: boolean;

From isRoleAccount.

suggestionCopy Anchor Link

suggestion: string | undefined;

A likely intended address when the domain looks like a typo, from suggestCorrection.

ClassifierCopy Anchor Link

classify and each check it makes, with options bound.

MethodsCopy Anchor Link

classify()Copy Anchor Link

classify(email): Classification;

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Classification

getProvider()Copy Anchor Link

getProvider(email): ProviderInfo | undefined;

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

ProviderInfo | undefined

isDisposable()Copy Anchor Link

isDisposable(email): boolean;

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

boolean

isRoleAccount()Copy Anchor Link

isRoleAccount(email): boolean;

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

boolean

suggestCorrection()Copy Anchor Link

suggestCorrection(email): string | undefined;

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

string | undefined

ClassifyOptionsCopy Anchor Link

How suggestCorrection matches a domain against the ones it knows.

PropertiesCopy Anchor Link

domains?Copy Anchor Link

optional domains?: readonly string[];

Domains that suggestCorrection corrects toward, ahead of the common mailbox domains, and never away from, such as your own company's. Compared without case.

ignore?Copy Anchor Link

optional ignore?: readonly string[];

Domains that are never corrected and never corrected toward, compared without case. Replaces defaultIgnore, the real domains one edit from a common one; spread it in to keep them. Registry domains are never corrected either way.

Default ValueCopy Anchor Link

defaultIgnore

keyboard?Copy Anchor Link

optional keyboard?: Keyboard;

The layout that key distance is measured on.

Default ValueCopy Anchor Link

'qwerty'

maxEdits?Copy Anchor Link

optional maxEdits?: 0 | 1 | 2;

The most edits a domain may be from a known one and still be taken for it: 0 turns name corrections off, leaving only TLD fixes. 2 catches double slips like hotmal.co, and also turns some distinct domains, like yopmail.com, into common ones.

Default ValueCopy Anchor Link

1

maxKeyDistance?Copy Anchor Link

optional maxKeyDistance?: number;

How many keys apart a typed letter may be from the intended one and still count as one edit: 1 for neighboring keys only. A letter farther away counts as two, a deletion and an insertion. Infinity counts any substitution as one edit.

Default ValueCopy Anchor Link

1

Type AliasesCopy Anchor Link

KeyboardCopy Anchor Link

type Keyboard = "qwerty" | "qwertz" | "azerty";

A keyboard layout that typo suggestions measure key distance on.

VariablesCopy Anchor Link

defaultIgnoreCopy Anchor Link

const defaultIgnore: readonly string[];

Widely used domains outside the registry that sit one edit from a common one and would otherwise be "corrected" to it. The ignore option replaces them, so spread them in to add your own.

ExampleCopy Anchor Link

import {
  createClassifier,
  defaultIgnore,
} from '@email-utils/classifier/classify';

defaultIgnore.includes('mail.com'); // => true
createClassifier({ ignore: [...defaultIgnore, 'gmial.com'] })
  .suggestCorrection('ada@gmial.com'); // => undefined

FunctionsCopy Anchor Link

classify()Copy Anchor Link

function classify(email, options?): Classification;

The address's provider, whether it's disposable or a role account, and a suggested correction if its domain looks like a typo. A string is parsed once for all four.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Classification

ExampleCopy Anchor Link

import { classify } from '@email-utils/classifier/classify';

classify('ceo@mailinator.com');
// => { provider: undefined, disposable: true, role: true, suggestion: undefined }
classify('ada@gmial.com').suggestion; // => 'ada@gmail.com'
classify('ada@gmail.com', { maxKeyDistance: 0 }); // => throws TypeError

ThrowsCopy Anchor Link

TypeError when email is neither a string nor a parsed address, or options are malformed.

createClassifier()Copy Anchor Link

function createClassifier(options?): Classifier;

Binds options once, checking them up front, and returns classify and the checks it makes with them applied.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Classifier

ExampleCopy Anchor Link

import { createClassifier } from '@email-utils/classifier/classify';

const classifier = createClassifier({ domains: ['example-corp.com'] });
classifier.suggestCorrection('ada@example-crop.com');
// => 'ada@example-corp.com'
classifier.classify('ada@example-corp.com');
// => { provider: undefined, suggestion: undefined }

ThrowsCopy Anchor Link

TypeError when options are malformed.