{"_id":"@apilayer/mailboxlayer","_rev":"1-64265c8607d6f922e1a76970ebaddb4a","name":"@apilayer/mailboxlayer","dist-tags":{"latest":"0.1.6"},"versions":{"0.1.6":{"name":"@apilayer/mailboxlayer","version":"0.1.6","author":{"name":"Samuel Oloruntoba","email":"github@kayandra.co","url":"https://kayandra.co"},"license":"MIT","dependencies":{"@types/node-fetch":"^2.5.0","node-fetch":"^2.5.0"},"gitHead":"e0a9510ba4e021cc2692311d4869e451bef33799","publishConfig":{"access":"public"},"description":"Mailboxlayer offers email validation & verification JSON API for Developers","_id":"@apilayer/mailboxlayer@0.1.6","_nodeVersion":"10.16.3","_npmVersion":"lerna/3.16.4/node@v10.16.3+x64 (linux)","dist":{"integrity":"sha512-g220VLmG8SV1MjAuDSXVcdaWNL1vMazqXgeSMI2yWq04x59wuE9xzHMsQFH8qI2vgOS0aP3QX+e+C91uXY+DYw==","shasum":"66c7d6a02f6a7525cebeb44e9bfe6e53aa6e65af","tarball":"https://registry.npmjs.org/@apilayer/mailboxlayer/-/mailboxlayer-0.1.6.tgz","fileCount":5,"unpackedSize":4190,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdkzKjCRA9TVsSAnZWagAAeQMP/AgMXzk5ls6SMts18Fyl\nfrWZv4Y/bRaGKX36pqlj9FPl9uVPFRXXNGob0JL+OEebMekuqxi7JopwPAwV\nBNcYW/HLXXzxcAOQ6L0fP1s4UBQa3RFVqiVLRX5o6AwDalpgRT1JZhnPm+8a\nawwo+8YlVvqmYh5/zt0sX/m8Vt7Q4jWYMGFrESmJXg+turUNYxD6DWGg8pyQ\nzNA9LpqVUVhk8/9nf7hFZa+PR6bQHObQv58HGto9ND40m/JwKuOCTYCJaYjJ\nIGcZhCzmgilShULSid937G26wE2w93eg15oQmOMe+P/RrBWjs5n2dBQT68H3\nOlYn5o51IuMdihCQgJUUsPMEL0Efu61T6uooVUr3rdp9OkT3WDPepjRZwsaM\ndQ74Bxw0y3Xf+OSwhyh7LzxHRNafXWQf+2u0FnM8gECMpho1jtLjjfaNUE/n\nm24GgtI17+Kf7J6oDZpv7oEqJnGPA8OVRgx4G7/eVJYcNZD33Rle1kypn7yQ\nSIUYNeHxIxxVGXLjAnZNQ8wBDDELhGdDkXizt1r2GdxUWwX/dg0p8gpvL0Yb\nEQMFvPRc/NKE9ZPL3jnPq7PUAWe85wEdQaGhnBM/Z3FmGgs2AVV0HMJbO42z\n0kM0weUaL4yB6ePlOukhQ+BE9YrjWPobKNc9q3rnBwKZlQIYH2Z7O17+Roji\nuICk\r\n=VAk1\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQC+koNtt3zBv1IbyVvt43OqCtFaG4P2TQFfg1L+hi0MxgIgXb+8hxtoRNpb7R8AfbVgv9j/FnAEazzGPVYz5Ee+NHA="}]},"maintainers":[{"name":"kayandra","email":"tag@kayandra.co"},{"name":"apilayer-p","email":"support@apilayer.com"}],"_npmUser":{"name":"kayandra","email":"tag@kayandra.co"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/mailboxlayer_0.1.6_1569927842883_0.7990236621157667"},"_hasShrinkwrap":false}},"time":{"created":"2019-10-01T11:04:02.536Z","0.1.6":"2019-10-01T11:04:03.008Z","modified":"2022-04-04T14:37:50.767Z"},"maintainers":[{"name":"kayandra","email":"tag@kayandra.co"},{"name":"apilayer-p","email":"support@apilayer.com"}],"description":"Mailboxlayer offers email validation & verification JSON API for Developers","author":{"name":"Samuel Oloruntoba","email":"github@kayandra.co","url":"https://kayandra.co"},"license":"MIT","readme":"# mailboxlayer-go\n\nMailboxlayer offers email validation & verification JSON API for Developers\n\n## Installation\n\nUsing npm\n\n```\nnpm require --save @apilayer/mailboxlayer\n```\n\nor yarn\n\n```\nyarn add @apilayer/mailboxlayer\n```\n\n## Getting Started\n\nHead over to [Mailboxlayer](https://mailboxlayer.com/) and\ncreate an account. Copy access key from dashboard.\n\n```javascript\nimport Mailboxlayer from '@apilayer/mailboxlayer'\n\nconst useHTTPs = true\nconst layer = new Mailboxlayer(\"<your-access-key>\", useHTTPs)\n```\n\n## `Check`\n\nCheck validates a supplied email address.\n\n**Signature:**\n\n```javascript\ncheck(email: string, config: Config): Promise<Response>\n```\n\n**Example:**\n\n```javascript\nconst response = layer.check(\"support@apilayer.com\", {\n\tsmtp: true, // perform SMTP check on the email\n\tcatch_all: true, // check if the server catches all emails\n})\n\nconsole.log('response:', response)\n```\n\n**Response:**\n\n```javascript\n{\n  \"email\": \"support@apilayer.com\",\n  \"did_you_mean\": \"\",\n  \"user\": \"support\",\n  \"domain\": \"apilayer.net\",\n  \"format_valid\": true,\n  \"mx_found\": true,\n  \"smtp_check\": true,\n  \"catch_all\": false,\n  \"role\": true,\n  \"disposable\": false,\n  \"free\": false,\n  \"score\": 0.8\n}\n```\n\n## License\n\n[MIT](/LICENSE)\n","readmeFilename":"README.md"}