API reference@email-utils/classifier
@email-utils/classifier/sources
The API of the sources entry point.
Interfaces
ProviderSource
Where one registry fact about a provider comes from, and when it was checked.
Properties
note?
optional note?: string;What the source says, or how the fact was observed when there's no page.
rule
rule:
| "domains"
| "canonicalDomain"
| "mxPatterns"
| "dotsSignificant"
| "hyphensSignificant"
| "subaddressSeparator"
| "subdomainAddressing";url?
optional url?: string;The provider's own page for the fact; absent when it was read from DNS.
verified
verified: string;When the fact was last checked against the source, as YYYY-MM-DD.
Type Aliases
ProviderRule
type ProviderRule = keyof Omit<ProviderInfo, "id" | "name" | "kind">;The registry field a source backs.
Variables
providerSources
const providerSources: Readonly<Record<ProviderId, readonly ProviderSource[]>>;Sources for every provider in the registry, by provider ID.
Example
import { providerSources } from '@email-utils/classifier/sources';
providerSources.gmail?.find(
(source) => source.rule === 'subaddressSeparator',
);
// => { url: 'https://support.google.com/mail/answer/12096' }