resolve-email 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Bret Comnes
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,34 @@
+# resolve-email
+[![latest version](https://img.shields.io/npm/v/resolve-email.svg)](https://img.shields.io/npm/v/resolve-email.svg)
+[![Actions Status](https://github.com/bcomnes/resolve-email/workflows/tests/badge.svg)](https://github.com/bcomnes/resolve-email/actions)
+[![Coverage Status](https://coveralls.io/repos/github/bcomnes/resolve-email/badge.svg?branch=master)](https://coveralls.io/github/bcomnes/resolve-email?branch=master)
+[![downloads](https://img.shields.io/npm/dm/resolve-email.svg)](https://npmtrends.com/resolve-email)
+[![Socket Badge](https://socket.dev/api/badge/npm/package/resolve-email)](https://socket.dev/npm/package/resolve-email)
+
+Resolve the domain of a syntactically valid email address to see if there is even a chance of deliverability.
+
+```
+npm install resolve-email
+```
+
+## Usage
+
+``` js
+import { resolveEmail } from 'resolve-email'
+
+// Validate the email address before passing it in here:
+const results = await resolveEmail('person@gmailc.om')
+
+console.log(results)
+// results.emailResolves true/false
+// results.mxRecords [array of mx records and priorities]
+// results.error any errors that may have occurred.
+```
+
+## See also
+
+This module was adapted from [nodemailer/nodemailer-direct-transport](https://github.com/nodemailer/nodemailer-direct-transport/blob/v3.3.2/lib/direct-transport.js#L438)
+
+## License
+
+MIT

package/index.js

@@ -0,0 +1,64 @@
+import { isIP } from 'node:net'
+import { resolveMx, resolve4, resolve6 } from 'node:dns/promises'
+
+export async function _resolveMx (email, opts) {
+  opts = {
+    allowIps: false,
+    ...opts
+  }
+  const domain = (email.split('@').pop() || '').toLowerCase().trim().replace(/^\[(ipv6:)?|\]$/gi, '')
+
+  if (isIP(domain)) {
+    if (opts.allowIps) {
+      return [{
+        priority: 0,
+        exchange: domain
+      }]
+    } else {
+      throw new Error('An email address with an IP address for the domain was is disallowed')
+    }
+  }
+
+  try {
+    const resolved = await resolveMx(domain)
+    return resolved.sort((a, b) => (a?.priority ?? 0) - (b?.priority ?? 0))
+  } catch (err) {
+    if (!['ENODATA', 'ENOTFOUND'].includes(err.code)) {
+      throw err
+    }
+
+    try {
+      return await ipFallback(domain, resolve4)
+    } catch (err) {
+      if (!['ENODATA', 'ENOTFOUND'].includes(err.code)) {
+        throw err
+      }
+      return await ipFallback(domain, resolve6)
+    }
+  }
+}
+
+async function ipFallback (domain, resolver) {
+  const aList = await resolver(domain)
+
+  // return the first resolved IP with priority 0
+  return [...aList].map(entry => ({
+    priority: 0,
+    exchange: entry
+  })).slice(0, 1)
+}
+
+export async function resolveEmail (domain, opts) {
+  try {
+    const entries = await _resolveMx(domain, opts)
+    return {
+      emailResolves: entries.length > 0,
+      mxRecords: entries
+    }
+  } catch (err) {
+    return {
+      emailResolves: false,
+      error: err
+    }
+  }
+}

package/index.test.js

@@ -0,0 +1,22 @@
+import test from 'node:test'
+import assert from 'node:assert'
+import { resolveEmail } from './index.js'
+
+const inputs = [
+  {
+    in: 'bcomnes@gmail.com',
+    expect: true
+  },
+  {
+    in: 'bcomnes@gmailc.om',
+    expect: false
+  }
+]
+
+for (const i of inputs) {
+  test(`${i.in} ${i.expect ? 'resolves' : 'does not resolve'}`, async (t) => {
+    const results = await resolveEmail(i.in)
+
+    assert.strictEqual(results.emailResolves, i.expect, `${i.in} ${i.expect ? 'resolves' : 'does not resolve'}`)
+  })
+}

package/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "resolve-email",
+  "description": "Resolve the domain of an email address to see if it even has a chance of delivering",
+  "files": [
+    "*.js",
+    "lib/*.js"
+  ],
+  "version": "1.0.0",
+  "author": "Bret Comnes <bcomnes@gmail.com> (https://bret.io)",
+  "bugs": {
+    "url": "https://github.com/bcomnes/resolve-email/issues"
+  },
+  "dependencies": {},
+  "devDependencies": {
+    "standard": "^17.0.0",
+    "npm-run-all2": "^6.0.0",
+    "auto-changelog": "^2.0.0",
+    "gh-release": "^7.0.0",
+    "c8": "^8.0.0",
+    "dependency-cruiser": "^13.0.0"
+  },
+  "engines": {
+    "node": ">=18.0.0",
+    "npm": ">=8.0.0"
+  },
+  "homepage": "https://github.com/bcomnes/resolve-email",
+  "keywords": [],
+  "license": "MIT",
+  "type": "module",
+  "module": "index.js",
+  "exports": {
+    "import": "./index.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/bcomnes/resolve-email.git"
+  },
+  "scripts": {
+    "prepublishOnly": "git push --follow-tags && gh-release -y",
+    "test": "run-s test:*",
+    "test:deptree": "depcruise --validate .dependency-cruiser.json .",
+    "test:standard": "standard",
+    "test:node-test": "METRICS=0 c8 node --test --test-reporter spec",
+    "version": "run-s version:*",
+    "version:changelog": "auto-changelog -p --template keepachangelog auto-changelog --breaking-pattern 'BREAKING CHANGE:'",
+    "version:git": "git add CHANGELOG.md",
+    "deps": "depcruise --exclude '^node_modules' --output-type dot . | dot -T svg | depcruise-wrap-stream-in-html > dependency-graph.html"
+  },
+  "standard": {
+    "ignore": [
+      "dist"
+    ]
+  },
+  "funding": {
+    "type": "individual",
+    "url": "https://github.com/sponsors/bcomnes"
+  },
+  "c8": {
+    "reporter": [
+      "lcov",
+      "text"
+    ]
+  }
+}