Interface EmailOptions

interface EmailOptions {
    allowDisplayName?: boolean;
    allowIPDomain?: boolean;
    allowUTF8LocalPart?: boolean;
    blacklistedChars?: string;
    hostBlacklist?: string[];
    hostWhitelist?: string[];
    ignoreMaxLength?: boolean;
    requireDisplayName?: boolean;
    requireTLD?: boolean;
}

Hierarchy

Properties

allowDisplayName? allowIPDomain? allowUTF8LocalPart? blacklistedChars? hostBlacklist? hostWhitelist? ignoreMaxLength? requireDisplayName? requireTLD?

Properties

OptionalallowDisplayName

allowDisplayName?: boolean

If true then display names are allowed (Display Name ).

Default

false

OptionalallowIPDomain

allowIPDomain?: boolean

If true then IP addresses are allowed in the host part.

Default

false

OptionalallowUTF8LocalPart

allowUTF8LocalPart?: boolean

If false then` any non-English UTF8 character in the local part of the email address are forbidden.

Default

true

OptionalblacklistedChars

blacklistedChars?: string

Reject emails that include any of the given characters in the name part.

OptionalhostBlacklist

hostBlacklist?: string[]

If the part of the email after the @ symbol matches one of the strings defined in it then the validation fails.

OptionalhostWhitelist

hostWhitelist?: string[]

Validation succeeds, only if the part of the email after the @ symbol matches one of the strings defined in it.

OptionalignoreMaxLength

ignoreMaxLength?: boolean

If true then the standard max length of an email is ignored.

Default

false

OptionalrequireDisplayName

requireDisplayName?: boolean

If true then display names are required (Display Name ).

Default

false

OptionalrequireTLD

requireTLD?: boolean

If false then addresses without a top-level domain are allowed.

Default

true

Settings

Member Visibility

On This Page

Properties