Interface NormalizeOptions

Options accepted by the normalization functions.

interface NormalizeOptions {
    defaultRule?: LocalPartRules;
    lowercaseDomain?: boolean;
    providers?: ProviderRule[];
    replaceDefaultProviders?: boolean;
}

Properties

Rule applied to domains that match no provider. Defaults to a conservative rule that only lowercases the domain and leaves the local part untouched.

lowercaseDomain?: boolean

Lowercase the domain. Domains are case-insensitive per RFC 1035, so this defaults to true. Disabling it is rarely useful but available.

providers?: ProviderRule[]

Additional provider rules, or overrides for the built-in providers. Matched by domain; entries here take precedence over the built-ins.

replaceDefaultProviders?: boolean

Ignore the built-in provider list entirely and use only the providers supplied in NormalizeOptions.providers. Defaults to false.