Node.js SDK

# npm
npm install @veilmail/sdk

# pnpm
pnpm add @veilmail/sdk

# yarn
yarn add @veilmail/sdk

import { VeilMail } from '@veilmail/sdk';

// Initialize the client
const client = new VeilMail('veil_live_xxxxx');

// Send an email
const email = await client.emails.send({
  from: 'hello@yourdomain.com',
  to: 'user@example.com',
  subject: 'Welcome!',
  html: '<h1>Welcome to our platform!</h1>',
});

console.log('Email sent:', email.id);

const client = new VeilMail({
  apiKey: 'veil_live_xxxxx',
  baseUrl: 'https://api.veilmail.xyz', // Optional, defaults to production
  timeout: 30000, // Optional, request timeout in ms
});

import type {
  // Email types
  Email,
  EmailStatus,
  SendEmailParams,

  // Domain types
  Domain,
  DomainStatus,

  // Template types
  Template,
  TemplateVariable,

  // Audience types
  Audience,
  Subscriber,
  SubscriberStatus,

  // Campaign types
  Campaign,
  CampaignStatus,
  CampaignStats,

  // Webhook types
  Webhook,
  WebhookEvent,

  // Common types
  PaginatedResponse,
  PaginationParams,
} from '@veilmail/sdk';

import {
  VeilMailError,
  AuthenticationError,
  ValidationError,
  NotFoundError,
  PiiDetectedError,
  RateLimitError,
  ServerError,
  TimeoutError,
  NetworkError,
} from '@veilmail/sdk';

try {
  await client.emails.send({ ... });
} catch (error) {
  if (error instanceof PiiDetectedError) {
    console.log('PII types detected:', error.piiTypes);
  } else if (error instanceof RateLimitError) {
    console.log('Retry after:', error.retryAfter, 'seconds');
  } else if (error instanceof VeilMailError) {
    console.log('Error:', error.code, error.message);
  }
}

const email = await client.emails.send({
  from: 'orders@yourdomain.com',
  to: 'customer@example.com',
  templateId: 'template_xxxxx',
  variables: {
    customerName: 'John Doe',
    orderNumber: 'ORD-12345',
    items: [
      { name: 'Product A', price: 29.99 },
      { name: 'Product B', price: 49.99 },
    ],
    total: 79.98,
  },
});

// Add a subscriber
const subscriber = await client.audiences.subscribers('audience_xxxxx').add({
  email: 'user@example.com',
  firstName: 'John',
  lastName: 'Doe',
  attributes: {
    plan: 'premium',
  },
});

// List active subscribers
const { data, hasMore } = await client.audiences.subscribers('audience_xxxxx').list({
  status: 'active',
  limit: 100,
});

// Remove a subscriber
await client.audiences.subscribers('audience_xxxxx').remove(subscriber.id);

// Create a campaign
const campaign = await client.campaigns.create({
  name: 'Monthly Newsletter',
  subject: 'Your December Update',
  from: 'news@yourdomain.com',
  audienceId: 'audience_xxxxx',
  templateId: 'template_xxxxx',
  variables: { month: 'December' },
});

// Schedule for later
await client.campaigns.schedule(campaign.id, {
  scheduledAt: '2024-12-01T09:00:00Z',
});

// Or send immediately
await client.campaigns.send(campaign.id);