@lacspace/email-verify 1.0.0 → 1.0.2

package/LICENSE

@@ -1,21 +1,51 @@
-MIT License
+Lacspace Free Licence
+Version 1.0, August 2026
 
 Copyright (c) 2026 Lacspace
 
-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:
+PREAMBLE
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+This software is published by Lacspace under the Lacspace Free Licence — a free,
+permissive licence that lets you use this software for any purpose, including in
+commercial products and services, at no cost. It grants the same freedoms as
+common permissive open-source licences; the only condition is that this notice
+travels with the software. The canonical, always-current text of this licence is
+maintained at https://lacspace.com/licenses/lacspace-free-1.0
+
+GRANT OF RIGHTS
+
+Permission is hereby granted, free of charge, to any person or organisation
+obtaining a copy of this software and its associated documentation and data 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 conditions below. These rights are
+granted for any purpose, personal or commercial, and are perpetual, worldwide,
+non-exclusive, and royalty-free.
+
+CONDITIONS
+
+The above copyright notice, this permission notice, and the name of this licence
+("Lacspace Free Licence") shall be included in all copies or substantial portions
+of the Software.
+
+TRADEMARKS
+
+This licence does not grant permission to use the trade names, trademarks, service
+marks, logos, or product names of Lacspace, except as required to reproduce the
+notice above or to describe the origin of the Software in a truthful manner.
+
+DISCLAIMER OF WARRANTY AND LIMITATION OF LIABILITY
 
 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.
+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.
+
+---
+
+The Lacspace Free Licence is a source-available, permissive licence and is not (as
+of this version) an OSI-approved licence. In substance it grants the same freedoms
+as the MIT Licence. Learn more at https://lacspace.com/licenses

package/README.md

@@ -0,0 +1,82 @@
+<div align="center">
+
+# @lacspace/email-verify
+
+**Does this mailbox actually exist? — best-effort deliverability checks (MX + SMTP probe).**
+
+[![npm version](https://img.shields.io/npm/v/@lacspace/email-verify?color=%23e11d48&label=npm)](https://www.npmjs.com/package/@lacspace/email-verify)
+[![install size](https://packagephobia.com/badge?p=@lacspace/email-verify)](https://packagephobia.com/result?p=@lacspace/email-verify)
+[![minzipped](https://img.shields.io/bundlephobia/minzip/@lacspace/email-verify?label=minzip)](https://bundlephobia.com/package/@lacspace/email-verify)
+[![types](https://img.shields.io/badge/types-included-blue)](https://www.npmjs.com/package/@lacspace/email-verify)
+[![license](https://img.shields.io/npm/l/@lacspace/email-verify?color=green)](https://github.com/lacspace/npm-packages/blob/main/LICENSE)
+
+</div>
+
+> Goes one step past syntax: resolves the domain's **MX records** and (optionally) runs a real **SMTP `RCPT TO` probe** to ask the receiving server whether the mailbox exists — **without ever sending a message**. Built on Node's `dns` + `net`.
+
+- 🔎 Syntax + disposable (via [`@lacspace/email-validate`](https://www.npmjs.com/package/@lacspace/email-validate))
+- 📇 MX record lookup, sorted by priority
+- 📡 Optional SMTP RCPT probe → `deliverable` / `undeliverable` / `unknown`
+- 🚫 No email is ever sent
+- 🟢 Node 18+ · zero **npm** dependencies (only our own `email-validate`)
+
+> ⚠️ **Read this.** Live SMTP verification is inherently unreliable. Many mail servers **greylist**, use **catch-all** (accept every address), or block probes outright — so `unknown` is common and a positive means *"likely deliverable"*, never a guarantee. Outbound port 25 is also blocked on many hosts (incl. most serverless/PaaS). Use it to catch obvious typos and dead domains, not as a hard gate.
+
+## Install
+
+```bash
+npm install @lacspace/email-verify      # or pnpm add / yarn add / bun add
+```
+
+## Usage
+
+```ts
+import { verifyEmail } from "@lacspace/email-verify";
+
+await verifyEmail("someone@gmail.com");
+// {
+//   email: "someone@gmail.com",
+//   valid: true,
+//   syntax: true,
+//   disposable: false,
+//   role: false,
+//   mxFound: true,
+//   mxRecords: [{ exchange: "gmail-smtp-in.l.google.com", priority: 5 }, …],
+//   smtp: "unknown"   // Gmail greylists probes — expected
+// }
+
+// MX-only (fast, reliable, no port-25 needed) — great default in cloud/serverless
+await verifyEmail(email, { checkSmtp: false });
+```
+
+## Lower-level helpers
+
+```ts
+import { resolveMx, smtpCheck } from "@lacspace/email-verify";
+
+await resolveMx("lacspace.com");
+// [{ exchange, priority }, …] (sorted best-first; [] if none)
+
+await smtpCheck("user@example.com", "mx.example.com", { timeout: 8000 });
+// "deliverable" | "undeliverable" | "unknown"
+```
+
+## Options
+
+| Option | Default | Description |
+| --- | --- | --- |
+| `checkSmtp` | `true` | run the live RCPT probe (set `false` for MX-only) |
+| `fromAddress` | `verify@<hostname>` | MAIL FROM used in the probe |
+| `timeout` | `10000` | per-connection timeout (ms) |
+| `extraDisposable` | — | extra throwaway domains |
+
+## The Lacspace MailKit
+
+| Package | For |
+| --- | --- |
+| [`@lacspace/mailer`](https://www.npmjs.com/package/@lacspace/mailer) | Send email over SMTP |
+| [`@lacspace/email-templates`](https://www.npmjs.com/package/@lacspace/email-templates) | Build responsive HTML emails |
+| [`@lacspace/email-validate`](https://www.npmjs.com/package/@lacspace/email-validate) | Validate & normalize addresses |
+| **`@lacspace/email-verify`** | MX + SMTP deliverability checks (this package) |
+
+<div align="center"><sub>Built with care by <a href="https://lacspace.com">Lacspace</a> · Lacspace Free Licence · <a href="https://github.com/lacspace/npm-packages">source</a></sub></div>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lacspace/email-verify",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Best-effort email deliverability checks for Node — syntax + disposable, MX record lookup and an optional SMTP RCPT probe (no mail sent). Zero npm dependencies.",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -37,7 +37,7 @@
     "typescript"
   ],
   "author": "Lacspace <contact@lacspace.com>",
-  "license": "MIT",
+  "license": "SEE LICENSE IN LICENSE",
   "homepage": "https://lacspace.com/packages",
   "repository": {
     "type": "git",
@@ -51,6 +51,6 @@
     "node": ">=18"
   },
   "dependencies": {
-    "@lacspace/email-validate": "^1.0.0"
+    "@lacspace/email-validate": "^1.0.1"
   }
 }