Nascent Prototype Metaverse

    @exodus/email-deep-validator

    3.4.0-2 • Public • Published

    email-deep-validator

    Verify email address checking MX records, and SMTP connection.

    Installation

    Install the module through NPM:

    $ npm install email-deep-validator --save
    

    Requires Node 7.6 or above

    Examples

    Include the module, create a new EmailValidator object and call verify method:

    const EmailValidator = require('email-deep-validator')
    
    const emailValidator = new EmailValidator()
    const { wellFormed, validDomain, validMailbox } = await emailValidator.verify(
      'foo@email.com'
    )
    // wellFormed: true
    // validDomain: true
    // validMailbox: true

    When a domain does not exist or has no MX records, the domain validation will fail, and the mailbox validation will return null because it could not be performed:

    const { wellFormed, validDomain, validMailbox } = await emailValidator.verify(
      'foo@bad-domain.com'
    )
    // wellFormed: true
    // validDomain: false
    // validMailbox: null

    A valid Yahoo domain will still return validMailbox true because their SMTP servers do not allow verifying if a mailbox exists.

    Configuration options

    timeout

    Set a timeout in seconds for the smtp connection. Default: 10000.

    verifyDomain

    Enable or disable domain checking. This is done in two steps:

    1. Verify that the domain does indeed exist;
    2. Verify that the domain has valid MX records.

    Default: true.

    verifyMailbox

    Enable or disable mailbox checking. Only a few SMTP servers allow this, and even then whether it works depends on your IP's reputation with those servers. This library performs a best effort validation:

    • It returns null for Yahoo addresses, for failed connections, for unknown SMTP errors.
    • It returns true for valid SMTP responses.
    • It returns false for SMTP errors specific to the address's formatting or mailbox existance.

    Default: true.

    useOpenSSL

    Use openssl as fallback if STARTTLS is required by email server. Only valid with verifyMailbox set to true.

    Default: false.

    ports

    List of SMTP ports to try. Can be a single integer or array of integers. If array of integers, for example, [25,467,587], each port will be tried, and on timeout will advance to the next port.

    Default: 25.

    Testing

    $ npm test
    

    Changelog

    2.0.0

    • (BREAKING) Requires node 7.6 for async/await.
    • (BREAKING) Instead of throwing on any invalidation, the lib now returns an object with which validations failed.
    • (BREAKING) Configuration property verifyMxRecords renamed to verifyDomain.
    • (BREAKING) Configuration property verifySmtpConnection renamed to verifyMailbox.

    Contributing

    This module was originally written to be used with Conversio and is used in a production environment currently. This will ensure that this module is well maintained, bug free and as up to date as possible.

    Conversio's developers will continue to make updates as often as required to have a consistently bug free platform, but we are happy to review any feature requests or issues and are accepting constructive pull requests.

    Keywords

    none

    Install

    npm i @exodus/email-deep-validator

    DownloadsWeekly Downloads

    17

    Version

    3.4.0-2

    License

    MIT

    Unpacked Size

    15.3 kB

    Total Files

    8

    Last publish

    Collaborators

    • jamiemaw
    • exodus-justin.za
    • brahim.ma
    • cmosetick
    • javiexodus
    • skanislav
    • wcastr
    • brandon-exodus
    • daniel.je
    • rg911
    • alex.alexandrius
    • filipexodus
    • jeremyex0j
    • ryansquared-npm
    • andrescarreon
    • florianmathieu
    • dwolfgram
    • eox42
    • iamsaikranthi
    • janwe
    • fosterdill
    • eduardoexodus
    • luvette
    • fboucquez
    • skapala
    • nlavrex
    • umito
    • lanahizzle
    • iaacek
    • nafisholeh
    • ariene-exodus
    • ps.mcnally
    • akinncar
    • matias.la
    • gaganatexodus
    • voltagebots
    • jhony112
    • siva-ramnathan
    • kwwood
    • sergii_bo
    • dimitrios.pa
    • mongkuen
    • philipcr
    • jacobbr22
    • kashifchoudhry
    • lekzd
    • cdotta
    • alexandrbbm
    • danm.exodus
    • danh.t.vo
    • ezenwankwogabriel
    • meniem
    • mzndako
    • ianertson
    • kevva
    • aaronloexodus
    • vikgmdev
    • iamcrazycoder
    • cassapula
    • feri42
    • jprichardson
    • farisissa
    • dooglio
    • ryanzim
    • headfire
    • gutenye
    • mosesbot
    • roccomuso
    • dcastagnoli
    • sonaye
    • nareg_exodus
    • ves
    • tenaciousmv
    • asyakost
    • bulgakovk
    • sekhmet
    • chalker
    • andrejb
    • gordonel
    • jaydp17
    • olistic
    • joepie91
    • merlz
    • jadechip
    • vbonini
    • cooncesean
    • devopsrobot
    • jenish-sojitra
    • unidwell
    • nachoalvarez
    • giovannirco
    • rec
    • dncabal
    • diegomura
    • danilsergeev
    • lanre-mark
    • sunilagrawal
    • guillecura
    • mariosvlad
    • federico-po
    • pagan404