@mailflurry/node

Official Node.js client library for the MailFlurry outbound deliverability and transactional ESP platform.

Installation

Install using npm:

npm install @mailflurry/node

Getting Started

Initialize the client with your live developer API key (which must start with sk_live_):

import { MailFlurry } from '@mailflurry/node';

const client = new MailFlurry({
  apiKey: 'sk_live_your_api_key_here',
  baseUrl: 'https://mailflurry.com' // Optional: defaults to mailflurry.com
});

Resource Usage

1. Managing Sending Domains

Register a new domain to retrieve DKIM/SPF DNS targets, and verify it:

// Register domain
const domain = await client.domains.create('workspace_id_123', 'mycompany.com');
console.log('TXT Host:', domain.dkimRecordName);
console.log('TXT Value:', domain.dkimRecordValue);

// Verify domain once DNS updates
const verification = await client.domains.verify(domain.id);
console.log('Verified Status:', verification.dkimVerified);

2. Sending & Managing Campaigns

// Create bulk or targeted dispatch campaign
const campaign = await client.campaigns.create({
  workspaceId: 'workspace_id_123',
  name: 'Monthly Tech Updates',
  subject: 'What is new in MTA architectures',
  content: '<h1>Hello Developers</h1><p>Our Redis priorities queues are faster...</p>',
  senderEmail: '[email protected]',
  recipients: ['[email protected]', '[email protected]']
});
console.log('Campaign Queued ID:', campaign.id);

// Retrieve real-time stats
const details = await client.campaigns.details('workspace_id_123', campaign.id);
console.log('Opens Count:', details.opensCount);
console.log('Clicks Count:', details.clicksCount);

License

MIT