API.md

Academic Email Verifier API

Verifier

Exposes academic email verifier API

Kind: global class Author: Benny Megidish

• Verifier
  • .isValidEmailAddress(emailAddress) ⇒ boolean
  • .domainToUrl(emailAddress) ⇒ string
  • .isAcademic(emailAddress) ⇒ Promise.<boolean>
  • .getInstitutionName(emailAddress) ⇒ Promise.<string>

Verifier.isValidEmailAddress(emailAddress) ⇒ boolean

check's if the email address is valid (in an proper email format - RFC 2822)

Kind: static method of Verifier Returns: boolean - true, if the email address is valid, false, otherwise

Param	Type	Description
emailAddress	string	email address to be checked

Verifier.domainToUrl(emailAddress) ⇒ string

converts tld to url format

Kind: static method of Verifier Returns: string - tld as url

Param	Type	Description
emailAddress	string	email address to be converted

Verifier.isAcademic(emailAddress) ⇒ Promise.<boolean>

check's if the email address is academic

Kind: static method of Verifier Returns: Promise.<boolean> - true, if the email address is academic, false, otherwise

Param	Type	Description
emailAddress	string	email address to be checked

Verifier.getInstitutionName(emailAddress) ⇒ Promise.<string>

query email address institution name

Kind: static method of Verifier Returns: Promise.<string> - academic institution name, if exist, '', otherwise

Param	Type	Description
emailAddress	string	email address to be checked