@teachable/email-validator

Email Validator

Email Validator is a client side validator for email addresses. It currently takes in an email address and an optional error message and checks to see whether or not the email looks valid. Email Validator does not do any form of Regex, MX, or SMPT check. It only checks to see if an email looks correct based upon the Mailcheck library.

Installation

To install Email Validator use yarn or request it via a script tag in the browser:

Script

<script src="https://unpkg.com/@teachable/email-validator@1.0.1/build/legacy-browser-bundle.js"></script>

The script tag will fetch version 1.0.1 of Email Validator. When loaded with a script tag, EmailValidator is made available on the window.

Yarn

yarn add @teachable/email-validator

Once added, you can access the EmailValidator with:

import { EmailValidator } from '@teachable/email-validator';

Checking for a suggestion

To see if an email looks valid, use checkForSuggestion.

EmailValidator.checkForSuggestion('[e-mail]')

The method returns an object, indicating whether or not the email looks valid. For emails that look invalid, the methods returns an object containing:

{
  suggestion: true,
  error: "Did you mean [e-mail]?",
  errorWithButton: "Did you mean <button>[e-mail]</button>?",
  suggestedEmail: "[e-mail]"
}

For valid emails or emails with no suggestions, the method returns an object containing:

{ suggestion: false, error: "", errorWithButton: "", suggestedEmail: "" }

Custom error messages

By default, if a suggestion exists for the email, the checkForSuggestion method returns Did you mean ${suggestedEmail}? as the error message. If you want a different error message, the method accepts a second argument for a custom error message or an error in a foreign language.

EmailValidator.checkForSuggestion('[e-mail]', "Are you sure you didn't mean %{suggested_email}?")

{
  suggestion: true,
  error: "Are you sure you didn't mean [e-mail]?",
  errorWithButton: "Are you sure you didn't mean <button>[e-mail]</button>?",
  suggestedEmail: "[e-mail]"
}

All instances of %{suggested_email} will be replaced with the the email suggestion if the email looks invalid. If the custom error text does not contain %{suggested_email}, then no email will be interpolated.