mailguard

Tiny, dependency-free JavaScript/TypeScript client for the MailGuard email-verification API.

Stop fake, mistyped, and disposable emails at signup with one call: syntax + MX checks, disposable/role detection, a "did you mean gmail.com?" typo suggestion, and a 0–100 deliverability score.

• ✅ Zero dependencies: just the platform fetch
• ✅ Works in Node 18+, Bun, Deno, Cloudflare Workers, and the browser
• ✅ Fully typed
• ✅ Free tier, no card: grab a key

📦 npm · 🐙 Source on GitHub

Install

npm install mailguard

Quick start

import { MailGuard } from "mailguard";

const mg = new MailGuard("mg_yourkey");

const result = await mg.verify("[email protected]");
console.log(result.status);        // "risky"
console.log(result.score);         // 75
console.log(result.did_you_mean);  // "gmail.com"

Gate a signup form

if (await mg.isDeliverable(email)) {
  // proceed
} else {
  // ask the user to double-check their address
}

Verify a list

const { results } = await mg.verifyBatch([
  "[email protected]",
  "[email protected]",
  "[email protected]",
]);

API

new MailGuard(apiKey, options?) / new MailGuard(options)

const mg = new MailGuard("mg_yourkey", {
  baseUrl: "https://self-hosted-instance.workers.dev", // optional — only if you self-host; defaults to the hosted API
  timeoutMs: 10000,                                     // optional
  fetch: customFetch,                                   // optional
});

Methods

| Method | Returns | |---|---| | verify(email) | Promise<VerifyResult> | | verifyBatch(emails) | Promise<BatchResult> (max 100) | | isDeliverable(email) | Promise<boolean> (true only when status === "deliverable") |

VerifyResult

interface VerifyResult {
  email: string;
  normalized: string;
  status: "deliverable" | "risky" | "undeliverable" | "unknown";
  score: number; // 0–100
  checks: {
    syntax: boolean;
    mx_found: boolean;
    disposable: boolean;
    role: boolean;
    free_provider: boolean;
  };
  did_you_mean: string | null;
  reasons: string[];
}

Errors

Non-2xx responses and network/timeout failures throw a MailGuardError:

import { MailGuard, MailGuardError } from "mailguard";

try {
  await mg.verify("[email protected]");
} catch (err) {
  if (err instanceof MailGuardError) {
    console.error(err.status, err.code, err.message); // e.g. 429 "quota_exceeded" "..."
  }
}

Contributing & issues

Source, issues, and pull requests: github.com/ahughes1994/MailGuard.SDK.

License

MIT © Anthony Hughes