Node.js SDK

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

O SDK oficial do EmailVerify para Node.js fornece uma maneira simples e eficiente de integrar verificação de e-mail nas suas aplicações Node.js.

Instalação

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

Início Rápido

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

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

// Verificar um único e-mail
const result = await client.verify('user@example.com');
console.log(result.status); // 'valid', 'invalid', 'unknown' ou 'accept_all'

Configuração

Opções do Cliente

const client = new EmailVerify({
  apiKey: 'sua-chave-de-api',

  // Configurações opcionais
  timeout: 30000,           // Timeout da solicitação em ms (padrão: 30000)
  retries: 3,               // Número de tentativas (padrão: 3)
  baseUrl: 'https://api.emailverify.ai', // URL personalizada da API
});

Variáveis de Ambiente

Recomendamos armazenar sua chave de API em variáveis de ambiente:

# .env
EMAILVERIFY_API_KEY=sua_chave_de_api_aqui

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

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

Verificação de E-mail Individual

Verificação Básica

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,
});

Verificação com Opções

const result = await client.verify('user@example.com', {
  smtpCheck: true,      // Habilitar verificação SMTP
  timeout: 5000,        // Timeout personalizado para esta solicitação
});

Estrutura da Resposta

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;
}

Verificação em Lote

Enviar um Trabalho em Lote

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

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

Verificar Status do Trabalho

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,
});

Obter Resultados

// Aguardar conclusão do trabalho
const results = await client.getBulkJobResults(job.id);

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

Notificações por Webhook

Em vez de polling, configure um webhook para receber notificações quando o trabalho for concluído:

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

Gerenciamento de Créditos

Verificar Créditos Disponíveis

const credits = await client.getCredits();

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

Tratamento de Erros

Tipos de Erro

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

try {
  const result = await client.verify('email-invalido');
} catch (error) {
  if (error instanceof AuthenticationError) {
    console.error('Chave de API inválida');
  } else if (error instanceof RateLimitError) {
    console.error(`Limite de taxa atingido. Tente novamente após ${error.retryAfter} segundos`);
  } else if (error instanceof ValidationError) {
    console.error(`Entrada inválida: ${error.message}`);
  } else if (error instanceof EmailVerifyError) {
    console.error(`Erro da API: ${error.message}`);
  }
}

Lógica de Tentativas

O SDK tenta automaticamente solicitações falhadas com backoff exponencial:

const client = new EmailVerify({
  apiKey: process.env.EMAILVERIFY_API_KEY,
  retries: 5,                    // Máximo de tentativas
  retryDelay: 1000,              // Atraso inicial em ms
  retryMaxDelay: 30000,          // Atraso máximo entre tentativas
});

Integração com Frameworks

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: 'Por favor, insira um endereço de e-mail válido',
      });
    }

    if (result.result.disposable) {
      return res.status(400).json({
        valid: false,
        message: 'E-mails descartáveis não são permitidos',
      });
    }

    res.json({ valid: true, result });
  } catch (error) {
    res.status(500).json({ error: 'Falha na verificação' });
  }
});

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

Rota de API Next.js

// 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: 'Método não permitido' });
  }

  const { email } = req.body;

  try {
    const result = await client.verify(email);
    res.status(200).json(result);
  } catch (error) {
    res.status(500).json({ error: 'Falha na verificação' });
  }
}

Exemplo Completo

Registro de Usuário com Verificação de E-mail

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

  // Rejeitar e-mails inválidos
  if (result.status === 'invalid') {
    return {
      valid: false,
      reason: 'invalid_email',
      message: 'Este endereço de e-mail é inválido',
    };
  }

  // Rejeitar e-mails descartáveis
  if (result.result.disposable) {
    return {
      valid: false,
      reason: 'disposable',
      message: 'Por favor, use um endereço de e-mail permanente',
    };
  }

  // Avisar sobre e-mails baseados em função
  if (result.result.role) {
    return {
      valid: true,
      warning: 'role_based',
      message: 'É recomendado usar um e-mail pessoal',
    };
  }

  // Aceitar e-mails válidos
  return {
    valid: true,
    score: result.score,
  };
}

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

Suporte a TypeScript

O SDK inclui definições de TypeScript prontas para uso:

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