IsEmailOptions | @bizjs/biz-utils

Hierarchy

IsEmailOptions

Index

Properties

Optional allow_display_name

allow_display_name?: boolean

If allow_display_name is set to true, the validator will also match Display Name <email-address>.

default: false

Optional allow_ip_domain

allow_ip_domain?: boolean

If allow_ip_domain is set to true, the validator will allow IP addresses in the host part.

default: false

Optional allow_utf8_local_part

allow_utf8_local_part?: boolean

If allow_utf8_local_part is set to false, the validator will not allow any non-English UTF8 character in email address' local part.

default: true

Optional domain_specific_validation

domain_specific_validation?: boolean

If domain_specific_validation is true, some additional validation will be enabled, e.g. disallowing certain syntactically valid email addresses that are rejected by GMail.

default: false

Optional host_blacklist

host_blacklist?: string[]

If host_blacklist is set to an array of strings and the part of the email after the @ symbol matches one of the strings defined in it, the validation fails.

Optional ignore_max_length

ignore_max_length?: boolean

If ignore_max_length is set to true, the validator will not check for the standard max length of an email.

default: false

Optional require_display_name

require_display_name?: boolean

If require_display_name is set to true, the validator will reject strings without the format Display Name <email-address>.

default: false

Optional require_tld

require_tld?: boolean

If require_tld is set to false, e-mail addresses without having TLD in their domain will also be matched.

default: true