Node.js SDK

Node.js email checker SDK. Install, configure, verify emails with JavaScript. Code examples included.

EmailVerify 官方 Node.js SDK 提供了一种简单高效的方式,将邮箱验证集成到您的 Node.js 应用程序中。

安装

npm install @emailverify/node
# 或
yarn add @emailverify/node
# 或
pnpm add @emailverify/node

快速开始

import { EmailVerify } from '@emailverify/node';

const client = new EmailVerify({
  apiKey: process.env.EMAILVERIFY_API_KEY,
});

// 验证单个邮箱
const result = await client.verify('user@example.com');
console.log(result.status); // 'valid'、'invalid'、'unknown' 或 'accept_all'

配置

客户端选项

const client = new EmailVerify({
  apiKey: 'your-api-key',

  // 可选配置
  timeout: 30000,           // 请求超时时间（毫秒）（默认: 30000）
  retries: 3,               // 重试次数（默认: 3）
  baseUrl: 'https://api.emailverify.ai', // 自定义 API URL
});

环境变量

我们建议将 API 密钥存储在环境变量中:

# .env
EMAILVERIFY_API_KEY=your_api_key_here

import { EmailVerify } from '@emailverify/node';

const client = new EmailVerify({
  apiKey: process.env.EMAILVERIFY_API_KEY,
});

单个邮箱验证

基本验证

const result = await client.verify('user@example.com');

console.log({
  email: result.email,
  status: result.status,
  score: result.score,
  deliverable: result.result.deliverable,
  disposable: result.result.disposable,
  role: result.result.role,
});

带选项的验证

const result = await client.verify('user@example.com', {
  smtpCheck: true,      // 启用 SMTP 验证
  timeout: 5000,        // 此请求的自定义超时时间
});

响应结构

interface VerificationResult {
  email: string;
  status: 'valid' | 'invalid' | 'unknown' | 'accept_all';
  result: {
    deliverable: boolean | null;
    valid_format: boolean;
    valid_domain: boolean;
    valid_mx: boolean;
    disposable: boolean;
    role: boolean;
    catchall: boolean;
    free: boolean;
    smtp_valid: boolean | null;
  };
  score: number;
  reason: string | null;
}

批量验证

提交批量任务

const emails = [
  'user1@example.com',
  'user2@example.com',
  'user3@example.com',
];

const job = await client.verifyBulk(emails);
console.log(`Job ID: ${job.id}`);
console.log(`Status: ${job.status}`);

检查任务状态

const status = await client.getBulkJobStatus(job.id);

console.log({
  id: status.id,
  status: status.status,      // 'pending'、'processing'、'completed'、'failed'
  total: status.total,
  processed: status.processed,
  valid: status.valid,
  invalid: status.invalid,
});

获取结果

// 等待任务完成
const results = await client.getBulkJobResults(job.id);

for (const result of results) {
  console.log(`${result.email}: ${result.status}`);
}

Webhook 通知

无需轮询,可以配置 Webhook 在任务完成时接收通知:

const job = await client.verifyBulk(emails, {
  webhookUrl: 'https://your-domain.com/webhooks/emailverify',
});

额度管理

检查可用额度

const credits = await client.getCredits();

console.log({
  available: credits.available,
  used: credits.used,
  total: credits.total,
});

错误处理

错误类型

import {
  EmailVerify,
  EmailVerifyError,
  AuthenticationError,
  RateLimitError,
  ValidationError,
} from '@emailverify/node';

try {
  const result = await client.verify('invalid-email');
} catch (error) {
  if (error instanceof AuthenticationError) {
    console.error('API 密钥无效');
  } else if (error instanceof RateLimitError) {
    console.error(`访问频率受限。请在 ${error.retryAfter} 秒后重试`);
  } else if (error instanceof ValidationError) {
    console.error(`输入无效: ${error.message}`);
  } else if (error instanceof EmailVerifyError) {
    console.error(`API 错误: ${error.message}`);
  }
}

重试逻辑

SDK 会自动使用指数退避重试失败的请求:

const client = new EmailVerify({
  apiKey: process.env.EMAILVERIFY_API_KEY,
  retries: 5,                    // 最大重试次数
  retryDelay: 1000,              // 初始延迟时间（毫秒）
  retryMaxDelay: 30000,          // 重试之间的最大延迟
});

框架集成

Express.js

import express from 'express';
import { EmailVerify } from '@emailverify/node';

const app = express();
const client = new EmailVerify({
  apiKey: process.env.EMAILVERIFY_API_KEY,
});

app.post('/api/verify-email', async (req, res) => {
  const { email } = req.body;

  try {
    const result = await client.verify(email);

    if (result.status === 'invalid') {
      return res.status(400).json({
        valid: false,
        message: '请输入有效的电子邮件地址',
      });
    }

    if (result.result.disposable) {
      return res.status(400).json({
        valid: false,
        message: '不允许使用一次性邮箱',
      });
    }

    res.json({ valid: true, result });
  } catch (error) {
    res.status(500).json({ error: '验证失败' });
  }
});

Fastify

import Fastify from 'fastify';
import { EmailVerify } from '@emailverify/node';

const fastify = Fastify();
const client = new EmailVerify({
  apiKey: process.env.EMAILVERIFY_API_KEY,
});

fastify.post('/verify', async (request, reply) => {
  const { email } = request.body;
  const result = await client.verify(email);
  return result;
});

Next.js API Route

// pages/api/verify.js
import { EmailVerify } from '@emailverify/node';

const client = new EmailVerify({
  apiKey: process.env.EMAILVERIFY_API_KEY,
});

export default async function handler(req, res) {
  if (req.method !== 'POST') {
    return res.status(405).json({ error: '不允许的方法' });
  }

  const { email } = req.body;

  try {
    const result = await client.verify(email);
    res.status(200).json(result);
  } catch (error) {
    res.status(500).json({ error: '验证失败' });
  }
}

完整示例

用户注册时的邮箱验证

import { EmailVerify } from '@emailverify/node';

const client = new EmailVerify({
  apiKey: process.env.EMAILVERIFY_API_KEY,
});

async function validateRegistrationEmail(email) {
  const result = await client.verify(email);

  // 拒绝无效邮箱
  if (result.status === 'invalid') {
    return {
      valid: false,
      reason: 'invalid_email',
      message: '此电子邮件地址无效',
    };
  }

  // 拒绝一次性邮箱
  if (result.result.disposable) {
    return {
      valid: false,
      reason: 'disposable',
      message: '请使用永久电子邮件地址',
    };
  }

  // 警告关于角色邮箱
  if (result.result.role) {
    return {
      valid: true,
      warning: 'role_based',
      message: '建议使用个人电子邮件',
    };
  }

  // 接受有效邮箱
  return {
    valid: true,
    score: result.score,
  };
}

// 使用示例
const validation = await validateRegistrationEmail('user@example.com');
if (!validation.valid) {
  console.error(validation.message);
}

TypeScript 支持

SDK 内置 TypeScript 类型定义:

import {
  EmailVerify,
  VerificationResult,
  BulkJob,
  ClientOptions
} from '@emailverify/node';

const options: ClientOptions = {
  apiKey: process.env.EMAILVERIFY_API_KEY!,
  timeout: 30000,
};

const client = new EmailVerify(options);

const result: VerificationResult = await client.verify('user@example.com');