Node.js

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');