{"_id":"@teachable/email-validator","_rev":"64-d1eb6e17562482426d89f42cc57d8992","name":"@teachable/email-validator","dist-tags":{"latest":"1.0.1"},"versions":{"1.0.0":{"name":"@teachable/email-validator","version":"1.0.0","description":"A client side validator for email addresses.","main":"./build/bundle.js","scripts":{"build":"yarn clean && yarn rollup","build:dev":"rollup -c ./rollup.config.js -w","clean":"rimraf ./build","lint":"eslint public","release":"yarn build && npm publish --access public","rollup":"rollup -c ./rollup.config.js","test":"jest"},"author":"","license":"ISC","dependencies":{"mailcheck":"^1.1.1"},"devDependencies":{"@babel/core":"^7.4.4","@babel/preset-env":"^7.4.4","eslint":"^5.16.0","jest":"^24.8.0","rollup":"^1.12.3","rollup-plugin-babel":"^4.3.2","rollup-plugin-commonjs":"^10.0.0","rollup-plugin-node-resolve":"^5.0.0"},"gitHead":"b094efcc23bc50b0718bbec538d91f9503de03cc","_id":"@teachable/email-validator@1.0.0","_npmVersion":"6.2.0","_nodeVersion":"10.9.0","_npmUser":{"name":"madeline-leclair","email":"madelineleclair@gmail.com"},"dist":{"integrity":"sha512-SihrKe5nG/8W9PwiAiE13rjB88Gb+Te3U3VKC7Xm+cq264buIhlRssFBrxv1Kdo4DNlXSnDwuq2fkV/NVyBh9A==","shasum":"2c366c397b1b18f4ad810e58f34099495fb2e72d","tarball":"https://registry.npmjs.org/@teachable/email-validator/-/email-validator-1.0.0.tgz","fileCount":4,"unpackedSize":27003,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJc/pxwCRA9TVsSAnZWagAAHCwQAJzheeuUhwjx56CowmVV\nMmaFlhck/vZGkYlOC6odq5YiW6WQAjTTq8NF5hNw4H5pm3fS3vSBB7tlHsOY\nw0w3KoZjagQ3iWaAmeKOV1FS+dUfMlKGG9COrScIDN/fK6YL4vxh0xAHzSAV\ntNR/fd9toxliIO/HcZC20NMW+gvdog07IQWoShwR30QNIKBw5nt+1V1CM469\nLHsHF7x9uDa65dxYuXieV6W443N4yiqZMct1M37SQCrUJQc7zPQEtEBEfelP\nZ2puC2vUl+uYN5R7q5Gow6kW35OOoN+Khvds471e1cLm17xmgE9WH+AhVzpY\nxwUN3nnEJuf/mqYRmyymKleNC84s/rDpojCqFPFVTzMRWg5P1f7pU/OPFO9W\nN16m17YBXMbUOi5UaUN1Zu/A5Cb4aaS5LGyjQQ6PpHExnKEAvMq9i/P5rWti\nx2aVEc88Qiwwy4AXUT9PFUTfjq766+s8tQGHprqJqwLxsOmDOKaPiPpGDMB6\ncjho+7ie/kBDS1MVADv8FJv+9qHpy6oSOKv+Td6tEZ9JeiS+D8sEGBTkCFMs\nKeEjHE+99IluGatBYpwKG1+lksbc/I61EuU9bRs7lB8zOzVKt+IgqVlVvP5e\n10n74H5VCGC6PnNwSl2HNBGZ7tGiAkUIaG+S86bjL+gckpfyWm+3JskHStwU\n2IX9\r\n=nzdk\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIDFmpShRWT6hmjDxp8d6fyukkgaBHMfbuitqnSFgUwFWAiAvhWR7ZN1zJN8at/qnCyF/CxhWb5ousdqAMQNxfsa+LA=="}]},"maintainers":[{"name":"madeline-leclair","email":"madelineleclair@gmail.com"},{"name":"michael_sterling","email":"michael@teachable.com"},{"name":"supster","email":"supatra.indhara@gmail.com"},{"name":"richburke","email":"rich.burke.dev@gmail.com"},{"name":"tris1111","email":"tris1111@gmail.com"},{"name":"robb-veltman","email":"robb.veltman@gmail.com"},{"name":"peterjteachable","email":"peter.jaffe@teachable.com"},{"name":"rubybrewsday","email":"poage.michael.cu@gmail.com"},{"name":"teachable-dev","email":"dev@teachable.com"},{"name":"spbsamuel","email":"spbsamuel@gmail.com"},{"name":"lizp","email":"lizzzp1@gmail.com"},{"name":"noahpryor","email":"noah@noahpryor.com"},{"name":"mikefey","email":"mikefey@protonmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/email-validator_1.0.0_1560190064106_0.30531982163057103"},"_hasShrinkwrap":false},"1.0.1":{"name":"@teachable/email-validator","version":"1.0.1","description":"A client side validator for email addresses.","main":"./build/bundle.js","scripts":{"build":"yarn clean && yarn rollup","build:dev":"rollup -c ./rollup.config.js -w","clean":"rimraf ./build","lint":"eslint public","release":"yarn build && npm publish --access public","rollup":"rollup -c ./rollup.config.js","test":"jest"},"author":"","license":"ISC","dependencies":{"mailcheck":"^1.1.1"},"devDependencies":{"@babel/core":"^7.4.4","@babel/preset-env":"^7.4.4","eslint":"^5.16.0","jest":"^24.8.0","rollup":"^1.12.3","rollup-plugin-babel":"^4.3.2","rollup-plugin-commonjs":"^10.0.0","rollup-plugin-node-resolve":"^5.0.0"},"gitHead":"aebed03fe396bc7f1edf561a31beef817ae3782e","_id":"@teachable/email-validator@1.0.1","_npmVersion":"6.2.0","_nodeVersion":"10.9.0","_npmUser":{"name":"madeline-leclair","email":"madelineleclair@gmail.com"},"dist":{"integrity":"sha512-9wfiCBx6IvXgsogUJvyDd25yvv/wIA+za5rjT8bxJH7wLQ8Kf/lqfVa66MLQPA44ahp426MnWRmUu23BiSE5yw==","shasum":"faa89fad919ab053c4146be578b72a0ce4900859","tarball":"https://registry.npmjs.org/@teachable/email-validator/-/email-validator-1.0.1.tgz","fileCount":4,"unpackedSize":27580,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdAQwdCRA9TVsSAnZWagAAmFIP/3RikntCDjaB+keDVTE+\nGwNGtNxm8wOLiSWAsXIBcYFyJiThD0PIRFyTwegi1MbW/JWKdonwtgVf7yz9\npO8lAwNn5OXprvtQL2gy2STUZHVUDyPkDTRLoElgwcDda0VbtUDjfdCLFuqH\ngT2usgBSE7yrHQEv/1I60M0WhPm2v9UZpDhcAhA/ghbGaf5IH4Itojh83ms0\nGBmTF79AL+2Wib9oJFcIn+O2UCn5tp0Ba7hbOa9jNl+amW6k7r6LzbtPSOjl\nOv36HX1AED3wgSRiDFomYkj1NGqnyR8OhFf5fGLlB3jA3w9j9HQFoj6sm0/h\nWoiMOeh3SpZaZDEwdSF9PILXoYG9npS9GLoZc8xeRu6+B3ghIrRlypBzsru6\nGNZ3/Pf1HilpfW1snEzBATVy6ffnEllwuPSQVvD1cRJ/1G/YgJVyKKmcZlqP\n7fKKh2DbgKtn+E76JmEzrbPDEJ77t1EB/AwkD711a2wPDRx5cWlCjhDAKlhS\nFgeN+iFoOFMzA7S2avHmkXzmwhQ5n30rVTXx4/mJrE+emY4X3iXCI5GPGPjc\nPrbP15K/jzjrMAiNiX+KY0vsWl8VdN8E76lPjIFfG/QWtHBnQ+D4IxVqjbub\nZ2Iynk5d0ifhs2jsDeM/nn546ZIuxJO0ALRKB6CcDcHoi7Eb1OJkzHM4USll\n3SFh\r\n=LCBj\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIH8wMtRcWzAiy3PSzlYFNN39pLPDGqLuUOp79zGkxFgcAiEAy3jevTTCP9Zr0IX/uOskLIRJ1e0/usxPelYJepifhtM="}]},"maintainers":[{"name":"lizp","email":"lizzzp1@gmail.com"},{"name":"madeline-leclair","email":"madelineleclair@gmail.com"},{"name":"michael_sterling","email":"michael@teachable.com"},{"name":"mikefey","email":"mikefey@protonmail.com"},{"name":"noahpryor","email":"noah@noahpryor.com"},{"name":"peterjteachable","email":"peter.jaffe@teachable.com"},{"name":"richburke","email":"rich.burke.dev@gmail.com"},{"name":"robb-veltman","email":"robb.veltman@gmail.com"},{"name":"rubybrewsday","email":"poage.michael.cu@gmail.com"},{"name":"spbsamuel","email":"spbsamuel@gmail.com"},{"name":"supster","email":"supatra.indhara@gmail.com"},{"name":"teachable-dev","email":"dev@teachable.com"},{"name":"tris1111","email":"tris1111@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/email-validator_1.0.1_1560349724590_0.7383295048323117"},"_hasShrinkwrap":false}},"time":{"created":"2019-06-10T18:07:43.911Z","1.0.0":"2019-06-10T18:07:44.281Z","modified":"2023-09-18T15:32:22.387Z","1.0.1":"2019-06-12T14:28:44.679Z"},"maintainers":[{"email":"jay@teachable.com","name":"jaylane"},{"email":"richard.hunt@teachable.com","name":"risteardofiaich"},{"email":"esteban.valverde@teachable.com","name":"teachabletiqui"},{"email":"jon.bichar@gmail.com","name":"ghostropic"},{"email":"dev@teachable.com","name":"teachable-dev"},{"email":"rhoen.pa@gmail.com","name":"rhoen"},{"email":"alison.buki@gmail.com","name":"abuki"},{"email":"nate.kidwell@teachable.com","name":"unteachable"},{"email":"krismcodes@gmail.com","name":"osermay"},{"email":"huangmelissas@gmail.com","name":"melissahuang"},{"email":"reid@teachable.com","name":"reidcooperteachable"},{"email":"emily.m.a.marin@gmail.com","name":"emam97"},{"email":"anna.sim@teachable.com","name":"annahsim"}],"description":"A client side validator for email addresses.","license":"ISC","readme":"# Email Validator\n\n`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](https://github.com/mailcheck/mailcheck).\n\n### Installation\n\nTo install `Email Validator` use yarn or request it via a script tag in the browser:\n\n#### Script\n\n`<script src=\"https://unpkg.com/@teachable/email-validator@1.0.1/build/legacy-browser-bundle.js\"></script>`\n\nThe script tag will fetch version 1.0.1 of `Email Validator`. When loaded with a script tag, `EmailValidator` is made available on the window.\n\n#### Yarn\n\n`yarn add @teachable/email-validator`\n\nOnce added, you can access the `EmailValidator` with:\n\n`import { EmailValidator } from '@teachable/email-validator';`\n\n### Checking for a suggestion\nTo see if an email looks valid, use `checkForSuggestion`.\n\n```javascript\nEmailValidator.checkForSuggestion('madeline@teachable.con')\n```\n\nThe method returns an object, indicating whether or not the email looks valid. For emails that look invalid, the methods returns an object containing:\n\n```javascript\n{\n  suggestion: true,\n  error: \"Did you mean madeline@teachable.com?\",\n  errorWithButton: \"Did you mean <button>madeline@teachable.com</button>?\",\n  suggestedEmail: \"madeline@teachable.com\"\n}\n```\n\nFor valid emails or emails with no suggestions, the method returns an object containing:\n\n```javascript\n{ suggestion: false, error: \"\", errorWithButton: \"\", suggestedEmail: \"\" }\n```\n\n### Custom error messages\n\nBy 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.\n\n```javascript\nEmailValidator.checkForSuggestion('madeline@teachable.con', \"Are you sure you didn't mean %{suggested_email}?\")\n```\n\n```javascript\n{\n  suggestion: true,\n  error: \"Are you sure you didn't mean madeline@teachable.com?\",\n  errorWithButton: \"Are you sure you didn't mean <button>madeline@teachable.com</button>?\",\n  suggestedEmail: \"madeline@teachable.com\"\n}\n```\n\nAll 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.\n","readmeFilename":"README.md"}