Skip to content

Interface: EmailOptions

Properties

PropertyTypeDescription
allowFullyQualified?booleanif true, domains ending with a . character are permitted Default false
allowUnderscore?booleanIf true, underscores (_) are allowed in the domain name Default false
allowUnicode?booleanIf true, Unicode characters are permitted Default true
ignoreLength?booleanif true, ignore invalid email length errors. Default false
maxDomainSegments?numberThe maximum number of domain segments (e.g. x.y.z has 3 segments) allowed. Defaults to no limit. Default Infinity
minDomainSegments?numberNumber of segments required for the domain. Be careful since some domains, such as io, directly allow email. Default 2
multiple?booleanif true, allows multiple email addresses in a single string, separated by , or the separator characters. Default false
separator?string | string[]when multiple is true, overrides the default , separator. String can be a single character or multiple separator characters. Default ','
tlds?false | TopLevelDomainOptionsOptions for TLD (top level domain) validation. By default, the TLD must be a valid name listed on the IANA registry Default { allow: true }