{"_id":"emailvalid","_rev":"5-23d777d835d3e56885cbd5ae36f3cd7c","name":"emailvalid","dist-tags":{"latest":"1.0.4"},"versions":{"1.0.0":{"name":"emailvalid","version":"1.0.0","description":"Email validation with more than 10K disposable/temporary email domains","main":"index.js","scripts":{"test":"standard && nyc --reporter=html --reporter=text mocha \"./{,!(node_modules)/**/}*.spec.js\"","coverage":"nyc report --reporter=text-lcov | coveralls","lint":"standard","lint:fix":"standard --fix","add-domain":"node ./scripts/add","clean":"node ./scripts/clean"},"author":{"name":"Romain Simon","email":"contact@romainsimon.net"},"license":"MIT","keywords":["email","validation","disposable","throwaway","freemail","temporary"],"standard":{"env":{"mocha":true}},"dependencies":{},"devDependencies":{"chai":"^4.1.2","coveralls":"^3.0.2","mocha":"^5.2.0","mocha-lcov-reporter":"^1.3.0","nyc":"^12.0.2","standard":"^12.0.1"},"engines":{"node":">=10","npm":">=6"},"gitHead":"9ec532652fe9edaf6c45dc8e62048d32e74e1cb1","_id":"emailvalid@1.0.0","_nodeVersion":"12.16.0","_npmVersion":"6.13.4","dist":{"integrity":"sha512-JRpA3c2gmqRRMvfjpmqupGJxDrAXl/vPfAOx3DS0Wem30V8oGIFUdzBfl1breSrfyYD3r285oX4lsWLPO72jOQ==","shasum":"ea7791ffbd03ddd94ffdd1bc5bbfa25252791cf8","tarball":"https://registry.npmjs.org/emailvalid/-/emailvalid-1.0.0.tgz","fileCount":13,"unpackedSize":372736,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJelgHDCRA9TVsSAnZWagAA+aQP/j3Y6NCwx+Y+GJMzK3Oq\n6f0P2WrA7WiULjcD4H5b1z/zF7otDTeCEzGSEvfNRKgdg+Iz3amtl6P6JcA+\nqo3IO9/zadA74/j6BwITrcIr32d7vBxBl8deWw9v7QILDZV0S2IqHh5XpeHR\n0zmgFIv94rQm9dXYdgDFdPX4X9CZp1NlDVlfYTHJlqqtBlUjGljecl2G+ErW\n5nQ3vKI01699l8i4u8umnBNbLrf3B93NZginNo9p/z2m1pJ1N7rOjuiKSHD4\n8svDcoxlT0P0JGiAgVjQfLpQVzPb1jGiNgKVjPcHu5FK7oe3jfM515YT+w8a\njnBPVqcKFAcCTo84s1GdeVfU2Y2+WuNcEd82NKEjucis67ECEc0Cdut8j+iz\nauc7pui7m6HVtghx63VoOoKX+4OjwI1SoWXvgRX3yw2ed+4IGSjW/aDrclc2\nlobVUXdLJ0js+uZ6jNH/7jetHbc/VNgPyl7+An5WzXRKJczHAgCEQp2i4a5i\ng+akhIBApW92VXV0cSTTdaz7iDalWwJ4RitAbs+dCJ8sI4JCo/ipf8EJno8M\n7ldBcQFP2JYL5rtFOXkG5s1rVNiFU3x9H14yfnJHKs++KzNXzthL5PdWjPGN\nk9kyD5PaNYjqCnjn07PN8bQqy3bD4oOlnPvCzGnik+wUDLLnG9SdzrFGxfpz\ndvP2\r\n=yVrn\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIBfPafm2r89S4OpnHi2labYDAhuo0zxylv432EViGQpAAiBGy23HZsOxMZP6k2PXenTp6XpQ6hPG1jfqpCzorGpA0Q=="}]},"maintainers":[{"name":"romainsimon","email":"romain@datananas.com"}],"_npmUser":{"name":"romainsimon","email":"romain@datananas.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/emailvalid_1.0.0_1586889154431_0.597689510246131"},"_hasShrinkwrap":false},"1.0.1":{"name":"emailvalid","version":"1.0.1","description":"Email validation with more than 10K disposable/temporary email domains","main":"index.js","scripts":{"test":"standard && nyc --reporter=html --reporter=text mocha \"./{,!(node_modules)/**/}*.spec.js\"","coverage":"nyc report --reporter=text-lcov | coveralls","lint":"standard","lint:fix":"standard --fix","add-domain":"node ./scripts/add","clean":"node ./scripts/clean"},"author":{"name":"Romain Simon","email":"contact@romainsimon.net"},"license":"MIT","keywords":["email","validation","disposable","throwaway","freemail","temporary"],"standard":{"env":{"mocha":true}},"dependencies":{},"devDependencies":{"chai":"^4.1.2","coveralls":"^3.0.2","mocha":"^5.2.0","mocha-lcov-reporter":"^1.3.0","nyc":"^12.0.2","standard":"^12.0.1"},"engines":{"node":">=10","npm":">=6"},"gitHead":"aa4010cc97e4feb9ef99fc0d5b385ee297a9b36d","_id":"emailvalid@1.0.1","_nodeVersion":"12.16.0","_npmVersion":"6.13.4","dist":{"integrity":"sha512-YZtAVssnyS8uN/XV9h3d+A+krq4rKqzifJjm0l4ak5Ju9QeJLgBIidFgDnGt5lqjJq0yEv3lYqvVQ1RGSpRmBg==","shasum":"711aa6d5d1c66d99d56eb1cca1c954d1a7ffeb8f","tarball":"https://registry.npmjs.org/emailvalid/-/emailvalid-1.0.1.tgz","fileCount":13,"unpackedSize":373918,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJelgn7CRA9TVsSAnZWagAApKAP/RJriN0LGB9UxcYwK/uW\nPKn7n8ym8Qed3SvktJ1CXx3V6RorArxHrHSktl9ERklh/Xf/froaHK7ARmZj\njJdqKNJrG7y445LsCUFZlRvGt4QhZwFaEwZJFR5ZXnygqdYNvmehp4cexff4\nAcYl1PYJpcernKhAvRt/IGBFeqDFRbekcXyMoFYyIwl1orE2Bj8Wm7g4x/7Y\nnIC0aOUfr+yYht4Ps5ruzXAxe7dK+DRgHf9zkI5Bl1zKyHnfwTsptEQgYUEW\neLkAsjJKkIdz4G5WuvExU0+kQFlrkeQ9d0GTDia6LdKwaKYoji5wUquNqZGL\npzGjdeXGFRPqwninzaVS+qXodAtgojK4bMQ8ufpLC/ZW6qGmy68Gdsr1qmb0\nj9KdzCK2YqATlnsJVsdcH20uiIgl8WfRx7h2pke0gAqtrPdGbRZhMLLLVjfW\n0iumolRxnw0lSkKrFJk/IYwAvrM/91bEPXSssTrey8+t3NyvL5pl10g8j9ve\nrSVroG97eu+PeQjxHiXGHdVe4XamoojE7OptjRJZFy0yYbSlP1RKJpwsAfPL\nR/sZ8vvWdLrbChlv6JCEYDo+8MZX3/qI/x5ALZ4gGIjAgVQ+/Wlj41rWUOBq\nF4huN/oQqdeLLXV6BxiZ5e3U/GVrKDf1a8Ik4JzZ5WJt3f9nF0MJbAOTfI48\nXwEu\r\n=Svqv\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDS7h1nwb9yya4sfnlILmX9LMfe4nI8KFDUncLsCV5ZEQIhANNFfgh8FcPfmrq5tXY24Ho36CPDfwtsVXp0lpL4V60F"}]},"maintainers":[{"name":"romainsimon","email":"romain@datananas.com"}],"_npmUser":{"name":"romainsimon","email":"romain@datananas.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/emailvalid_1.0.1_1586891259159_0.6839150260799025"},"_hasShrinkwrap":false},"1.0.2":{"name":"emailvalid","version":"1.0.2","description":"Email validation with more than 10K disposable/temporary email domains","main":"index.js","scripts":{"test":"standard && nyc --reporter=html --reporter=text mocha \"./{,!(node_modules)/**/}*.spec.js\"","coverage":"nyc report --reporter=text-lcov | coveralls","lint":"standard","lint:fix":"standard --fix","add-domain":"node ./scripts/add","clean":"node ./scripts/clean"},"author":{"name":"Romain Simon","email":"contact@romainsimon.net"},"license":"MIT","keywords":["email","validation","disposable","throwaway","freemail","temporary"],"standard":{"env":{"mocha":true}},"dependencies":{},"devDependencies":{"chai":"^4.1.2","coveralls":"^3.0.2","mocha":"^5.2.0","mocha-lcov-reporter":"^1.3.0","nyc":"^12.0.2","standard":"^12.0.1"},"engines":{"node":">=10","npm":">=6"},"gitHead":"42a6ae445e64961c02576e84686dcb7c5e079874","_id":"emailvalid@1.0.2","_nodeVersion":"12.16.0","_npmVersion":"6.13.4","dist":{"integrity":"sha512-84RHRSvynmEQcUSYbRA4NcePbh5rTx+AeqD4pLnGiucliIOgzhcO75+xPevtb1WhO8+pFzsT25mtvsDlJc2dAw==","shasum":"e2b4e750e0a87f27cc3b4b36498e2b059de459d7","tarball":"https://registry.npmjs.org/emailvalid/-/emailvalid-1.0.2.tgz","fileCount":13,"unpackedSize":374942,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJelhImCRA9TVsSAnZWagAA6A0P/R1txNXBFBjyl6Lz/pu3\n3r3Q6nCy5Joh8ZsFj8FTKHjYCQZVGpRa8JWBCFLD58e4M15SFhamq4ejTE9S\nDvLB+ha2E/L3zzfJThF4GZqoZHILyQnk/CjwMQf3bbPZ3jK+Tha6DDeeV0wd\na/j9Rt5cT39Rk6nr5yjK7Jy7PK1b/pjIMAZTp60wJuPo218izPDbeu6rUG2M\nrZoNXUeOxk5frCEyY0pbf6fO1UzcgdkWYUfcZ2SRfhqHPzxitKIh7SXccNdz\n1H5nMwnoMN1nWyrzUmwSju3uGTeeOADINdcnmSZfr+mRmi3rlST2gq+lYRKn\n/gHqSrfM0pEApNlu8O4R61MOI8RyhjiwrpNXTZJtbzD5nuH14X/lbck2irue\n76e2FZg8k7EmwtchIQ/rK/BPacergVD5/RUphgtrJav1/MXwy6lbG5WFrbN6\neNViUBToaAFxOjeztJF16jx5+nCV4M5/uxOxYJNTJpvIKfp5vNGpeAnpdpzz\nWnwo4erSRj6yjNBnSqotTxDv4lPzGkbe213qYg6wIBUsTYednqyBozk0DDFG\n50TLt08ts6rhk/TseUfEh1dphEm6UmKS4wXEp5NBler5qGr83hjptZBCdCxb\ntOWifm38zPhSwZhaVcU5KAp+YEiLUBrwo9g/PDpWpb76vclM0VGPH8XfbLjW\n9QEB\r\n=YhXy\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIDDwh/wNIJq+STcjTYUeZnGQq/ViFGL2bP6L1sSed1ZgAiEA9haL//J0zzhEJTilxm2flbDlvvjwBb0trcYTz5n7ENw="}]},"maintainers":[{"name":"romainsimon","email":"romain@datananas.com"}],"_npmUser":{"name":"romainsimon","email":"romain@datananas.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/emailvalid_1.0.2_1586893350278_0.12311030087563801"},"_hasShrinkwrap":false},"1.0.3":{"name":"emailvalid","version":"1.0.3","description":"Email validation with more than 10K disposable/temporary email domains","repository":{"type":"git","url":"git+https://github.com/romainsimon/emailvalid.git"},"main":"index.js","scripts":{"test":"standard && nyc --reporter=html --reporter=text mocha \"./{,!(node_modules)/**/}*.spec.js\"","coverage":"nyc report --reporter=text-lcov | coveralls","lint":"standard","lint:fix":"standard --fix","add-domain":"node ./scripts/add","clean":"node ./scripts/clean"},"author":{"name":"Romain Simon","email":"contact@romainsimon.net"},"license":"MIT","keywords":["email","validation","disposable","throwaway","freemail","temporary"],"standard":{"env":{"mocha":true}},"dependencies":{},"devDependencies":{"chai":"^4.1.2","coveralls":"^3.0.2","mocha":"^5.2.0","mocha-lcov-reporter":"^1.3.0","nyc":"^12.0.2","standard":"^12.0.1"},"engines":{"node":">=10","npm":">=6"},"gitHead":"f578160fd4f9bc9c950e241a1145f421486bde09","bugs":{"url":"https://github.com/romainsimon/emailvalid/issues"},"homepage":"https://github.com/romainsimon/emailvalid#readme","_id":"emailvalid@1.0.3","_npmVersion":"6.4.1","_nodeVersion":"10.15.3","_npmUser":{"name":"romainsimon","email":"romain@datananas.com"},"dist":{"integrity":"sha512-ijYLD4z5fKDKz7luhWCDR2Ong1frzBCNoYKC+gLHExyY87p2MWb2koEwBWHf+D16Liw9k2jwsF1rUdIIRVlyQQ==","shasum":"e0989a8ab752e4d384891bb489dc089a79b1b731","tarball":"https://registry.npmjs.org/emailvalid/-/emailvalid-1.0.3.tgz","fileCount":13,"unpackedSize":375131,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfL+vqCRA9TVsSAnZWagAAE8AQAKNuoRKo+nuP1nRPGl1D\nRgsHnfwMj9fGlv/YEHUwBntLPJmC9HytwkCkcrUGUsaG7mYszkCaVQBXky1p\nvZFjEk7n7F1sz4vXTmuJmv1+3WMrQ3BYHD38RPBlscZ0a6Hn25nFDJ0oWJHG\n1LwljS/c8oEePKb5sTLeWCw2l1uvbiBXjvl0Rm+4FdNSy3FE9X+9q8ERM60+\nssPwD72Bxr7WnL3EkgzUb5coW/PH12IR6BWCqSGHEyypqVrpYnAX2pxzTj1N\ns2H+zOCtbZH0lh6BT1qnVJFIrNL2Ipj5nfOB3EYF8b0kvuy1qv0V5nD/3xCO\nVvrEMOGMRlF4f03d9AYwqbGFXo0DvIPFdj2WPx9aX0qpf8+pRXSqMAhW069/\n9aJstXbReaWo+lwRnDi8P4Qi5GtVKgGVsijRR9KrTOys+1mSDUVjlk9VjG4k\ng2typl/35UxLuxiay78lY18I0hHRRoVhwtT9xOQ1MMQFOxcnMmw2DJFAQSr0\nLMjlrVWHxywBe3a3mAEmgKTVSIwLtptAH3clSY06sVckF1NryxF1RNOPHsBC\ncAoc3fvcJpNR49IaJ0+m7LyA51QFJQ8/3uCKr8rDAN/H+vwJ/4vbfqmf4tSP\nwaOhs7q6NTuCby3xXX91didHPDOXzQrTTc/yTkEJerRS6PczlpwnHnNs27Py\nbXy+\r\n=wZZW\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIAahKVM8FovxWfVKs8H2XhBp4F5Lo5DqN62410iY1N/qAiEArdfXHMCjoLMOo5sPZkDCm3fkGdSKpqSoLJGzkfSZ82s="}]},"maintainers":[{"name":"romainsimon","email":"romain@datananas.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/emailvalid_1.0.3_1596976106229_0.7532147410446355"},"_hasShrinkwrap":false},"1.0.4":{"name":"emailvalid","version":"1.0.4","description":"Email validation with more than 10K disposable/temporary email domains","repository":{"type":"git","url":"git+https://github.com/romainsimon/emailvalid.git"},"main":"index.js","scripts":{"test":"standard && nyc --reporter=html --reporter=text mocha \"./{,!(node_modules)/**/}*.spec.js\"","coverage":"nyc report --reporter=text-lcov | coveralls","lint":"standard","lint:fix":"standard --fix","add-domain":"node ./scripts/add","clean":"node ./scripts/clean"},"author":{"name":"Romain Simon","email":"contact@romainsimon.net"},"license":"MIT","keywords":["email","validation","disposable","throwaway","freemail","temporary"],"standard":{"env":{"mocha":true}},"dependencies":{},"devDependencies":{"chai":"^4.1.2","coveralls":"^3.0.2","mocha":"^5.2.0","mocha-lcov-reporter":"^1.3.0","nyc":"^12.0.2","standard":"^12.0.1"},"engines":{"node":">=10","npm":">=6"},"gitHead":"b935f6f7e15a11d893685b6ef668d2c19e8e8214","bugs":{"url":"https://github.com/romainsimon/emailvalid/issues"},"homepage":"https://github.com/romainsimon/emailvalid#readme","_id":"emailvalid@1.0.4","_nodeVersion":"16.17.0","_npmVersion":"8.19.1","dist":{"integrity":"sha512-dwbUvREx9lb9e8eq7olzvmewNGgFpccQTvGTnJxRFUQEr6T8c0SIEYtMQmjEN6UMWVQm699F8ZXyw/31v8HX2Q==","shasum":"20ddc4141c5f8a96d0fa509ac0accd72833b56b2","tarball":"https://registry.npmjs.org/emailvalid/-/emailvalid-1.0.4.tgz","fileCount":16,"unpackedSize":378305,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIChG8bX1r8VjySQMPyO0XKyYO41EWd/Ltt2BX1hjIsdnAiEA8iA93ebSCYvKKfUc5qCuOQE1oX/4aXPvl7X9OeUHMXw="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJkT7n3ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmrwUA//RxEMsPr2rQRgNpfAmKgKQGUkwOXfR180bRiZIVZq23SMl0+h\r\nOlQvs7Eb9gzC+EIW2yaNnaOCTd9eqmVTXpD+dBU05tJD1EEK6bT0rLCKvN3I\r\nOkYBHbMl12A6RUhSL2hSAuwX+5jCr53B6vWYycZ5Uk7RFOI+9kzkLtCbDrPV\r\nhnM/bq4j3TZ+H+J0zMjice+WHNICjRxsAhuKruv4TjORiC0JxAM/yqTj6DGr\r\nESMktjcDo/vHYeySHHLrShYPkRL2fSJbC3JEPy/j+HhaKg01Vt3ooN2/WK5M\r\nEbsGAnKRBkdSGoXDlCle//GnR/wKrnwfj0owtpxUuywp7P1idBh9Zt50zI90\r\nrH+ZzZ/2K9XpkDbScGlIy6TnRy+hm9gVibt7fTHavRrhq0C40flkPkmWZ0lQ\r\nW+gAlKoW5eaIaqSWh8KwQUTtl+KSREQiZQRqgWTaCWVBeGyzNa72IXpi+0xn\r\nzlzH6QjFycnTHa64dLLm448hwwKqIqwEWBjJphNz1jsTnVOjT56wUkXg4cjH\r\nT1lg/2VNM/kn2D/OUoLKBu/yPB7yFB2UVcQr4zLrTHY8pdJkAVBDJLaDw7vR\r\nQciX700mHhuOLtvbKD46W1tHJxwTt7kN41MOgtxxmOXugI6p6hutm5GsZ17Y\r\nLubnCSlDWxyCCIHMZuDXdZ1oUbso5f1t0xI=\r\n=A4lj\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"romainsimon","email":"contact@romainsimon.net"},"directories":{},"maintainers":[{"name":"romainsimon","email":"contact@romainsimon.net"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/emailvalid_1.0.4_1682946551689_0.7191682030997284"},"_hasShrinkwrap":false}},"time":{"created":"2020-04-14T18:32:34.430Z","1.0.0":"2020-04-14T18:32:34.616Z","modified":"2023-05-01T13:09:12.019Z","1.0.1":"2020-04-14T19:07:39.327Z","1.0.2":"2020-04-14T19:42:30.442Z","1.0.3":"2020-08-09T12:28:26.360Z","1.0.4":"2023-05-01T13:09:11.888Z"},"maintainers":[{"name":"romainsimon","email":"contact@romainsimon.net"}],"description":"Email validation with more than 10K disposable/temporary email domains","keywords":["email","validation","disposable","throwaway","freemail","temporary"],"author":{"name":"Romain Simon","email":"contact@romainsimon.net"},"license":"MIT","readme":"

Email Validation

\n\nEmail Validation is a library that validates email addresses and checks againts more than 10K domains used for disposable emails
\nIf you want to **block disposable email addresses at signup**, or if you are a B2B company and want **only professional email adresses**, this is the solution for you :)
\n
\n\n
\n \n \"Build\n \n \"Test\n \n \n \"Standard\"\n \n
\n\n
\n\nThis library does multiple verifications:\n- Email format validation\n- Free email address (@gmail.com, @hotmail.com, @protonmail.com, ...)\n- Disposable email address (@maildrop.cc, @fakemail.net, @trashmail.com, ...)\n- Possible typos in popular email domains\n\nEmail Validation has **0 dependency, 100% coverage, and is [fully configurable](#configuration)**.\n\n\n## Table of Contents\n\n- [Installation](#installation)\n- [Usage](#usage)\n- [Configuration](#configuration)\n- [Result](#result)\n- [Contributions](#contributions)\n- [License](#license)\n\n## Installation\n\nInstall using [`npm`](https://www.npmjs.com/package/emailvalid):\n\n```bash\nnpm install emailvalid\n```\n\nor Yarn [`yarn`](https://yarnpkg.com/en/package/emailvalid):\n\n```bash\nyarn add emailvalid\n```\n\n## Usage\n\nEmail Validation is initialized with a list of default domains\n\n### Simple usage example\n\n```javascript\nconst EmailValidation = require('emailvalid')\nconst ev = new EmailValidation()\n\n// This email will be invalid because it is a free email\nconst result = ev.check('random@gmail.com')\nconsole.log(`${result.email} validity: ${result.valid}`)\n\n// This email will be invalid because it is a disposable email\nconst result2 = ev.check('iamadisposableemail@yopmail.com')\nconsole.log(`${result2.email} validity: ${result2.valid}`)\n\n// You can also check for possible typos\nconst result3 = ev.check('john@gmil.com')\nif (result3.typo) console.log(`Did you mean ${result3.typo}?`)\n\n```\n\nThe output will be an object with some information on the validity ([see result section](#result))\n\n\n### Configuration\n\nEmail Validation can be configured with more advanced options as an object:\n\n- `whitelist` _(Array)_ Add some email domains you want to whitelist (default is [])\n- `blacklist` _(Array)_ Add some email domains you want to blacklist (default is [])\n- `allowFreemail` _(Boolean)_ Allow free emails such as @gmail.com, ... (default is false)\n- `allowDisposable` _(Boolean)_ Allow disposable emails such as @trashmail.com, ... (default is false)\n\nYou can for example choose to allow freemails, and add a domain baddomain.com in addition to the preconfigured list\n\n#### Advanced configuration example\n\n```javascript\nconst EmailValidation = require('emailvalid')\nconst ev = new EmailValidation({ allowFreemail: true, blacklist: ['baddomain.com'] })\n\n// This one should have result.valid = true because we allowed free mails such as gmail.com\nev.check('random@gmail.com')\n\n// But this one is blacklisted now \nev.check('paul@baddomain.com')\n\n```\n\nOr if you want to disallow all free mails, except gmail.com :\n\n```javascript\nconst ev = new EmailValidation({ whitelist: ['gmail.com'] })\n\n```\n\nYou can check some examples in [`example.js`](https://github.com/romainsimon/emailvalid/blob/master/example.js)\n\n#### Updating options on the fly\n\nIn case you need to update options after initialization, you can do it on the fly with different methods:\n\n- `whitelist` _(Function)_ Add a new domain to the whitelist\n- `blacklist` _(Function)_ Add a new domain to the blacklist\n- `setOptions` _(Function)_ Changes the options\n\n\n```javascript\nconst EmailValidation = require('emailvalid')\nconst ev = new EmailValidation()\n\n// This adds a new domain as invalid\nev.blacklist('baddomain.com')\n\n// This marks a domain as valid\nev.whitelist('gooddomain.com')\n\n// This changes options to allow freemails\nev.setOptions({ allowFreemail: true })\n\n```\n\n\n## Result\n\nEmail Validation will output an object with the following information:\n\n- `email` _(String)_ Email in a standardized format (trimed and lowercased)\n- `domain` _(String)_ Domain from the email\n- `valid` _(Boolean)_ Is the email address valid?\n- `errors` _(Array)_ List of errors if any\n- `typo` _(String)_ Is there any possible typo in the email?\n\nErrors contains strings and can be one of :\n- `invalid` Email is not present of format is invalid\n- `disposable` Email is disposable (and not whitelisted or allowed in parameters)\n- `freemail` Email is a free mail (and not whitelisted or allowed in parameters)\n- `blacklisted` Email is blacklisted in parameters\n\n#### Example :\n\n```javascript\nconst EmailValidation = require('emailvalid')\nconst ev = new EmailValidation()\n\nconst result = ev.check('RANDOM@gmail.com')\nconsole.log(result)\n\n// This will return :\n// {\n// email: 'random@gmail.com',\n// domain: 'gmail.com'\n// valid: false,\n// errors: ['freemail'],\n// typo: null\n// {\n\n```\n\n## Contributions\n\nIf you need a simple way to add domains to the list, just run `yarn add-domain [DOMAIN] [CATEGORY]`\n\nFor example `yarn add-domain freemail gmail.com`\n\nThen feel free to create Pull Requests :)\n\n\n## Licence\n\n[MIT License](https://github.com/romainsimon/emailvalid/blob/master/LICENSE)\n","readmeFilename":"README.md","homepage":"https://github.com/romainsimon/emailvalid#readme","repository":{"type":"git","url":"git+https://github.com/romainsimon/emailvalid.git"},"bugs":{"url":"https://github.com/romainsimon/emailvalid/issues"}}