Giter Club home page Giter Club logo

joi-email-extensions's Introduction

joi-email-extensions

Joi extensions providing email normalization, MX record validation, checking for emails from free and disposable email providers and various ways to match against a list of email patterns or domains.

Usage

The methods of this extension are chained after the Joi email validator.

import BaseJoi from 'joi'
import JoiEmailExtensions from 'joi-email-extensions'

const Joi = BaseJoi.extend([JoiEmailExtensions])

const schema = Joi.object().keys({
  // Normalize an email
  normalizedEmail: Joi.string().email().normalize(),

  // Check if email is not from known disposable email provider
  notAThrowAwayEmail: Joi.string().email().nonDisposable(),

  // Validate an email by ensuring the domain has MX records
  mxValidatedEmail: Joi.string().email().hasMx(),

  // Validate only emails from a given exact domain
  exactDomain: Joi.string().email().domains(['mydomain.tld']),

  // Validate email against a list of patterns
  onlyUkEuDomains: Joi.string().email().domains([
    '*.uk',
    '*.eu'
  ], { mode: 'glob' }),

  // Allow emails from domains with the word 'awesome' or 'awful'
  onlyAwesomeDomains: Joi.string().email().domains([
    /awe(some|ful)/
  ], { mode: 'regexp' })
})

const result = schema.validate({
  normalizedEmail: '[email protected]',
  notAThrowAwayEmail: '[email protected]',
  mxValidatedEmail: '[email protected]',
  exactDomain: '[email protected]',
  onlyUkEuDomains: '[email protected]',
  onlyAwesomeDomains: '[email protected]'
})

console.log(result)
// { error: null,
//   value:
//    { normalizedEmail: '[email protected]',
//      notAThrowAwayEmail: '[email protected]',
//      mxValidatedEmail: '[email protected]',
//      exactDomain: '[email protected]',
//      onlyUkEuDomains: '[email protected]',
//      onlyAwesomeDomains: '[email protected]' } }

API

normalize

Transforms email string to a normalized form. Uses normalize-email under the hood.

Joi.string().email().normalize()

nonDisposable

Require the email to be from a domain that is not a known disposable email provider.

Joi.string().email().nonDisposable()

hasMx

Require the email to have valid MX records for handling email.

Joi.string().email().hasMx()

domains(patterns, options)

Require the email to be from a list of domain names. The domain names to match against are passed as the patterns argument and can be specified as exact strings, or glob patterns or regular expressions. The options argument takes an object containing 'mode' with acceptable values of 'exact' (default), 'regexp' or 'glob'.

Joi.string().email().domains(['mydomain.tld'], { mode: 'exact' })

Author

Jawish Hameed

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.