Overview & Concepts – Intelliprint UK Postal Mail & Hybrid Mail API

import Intelliprint from 'intelliprint';

// Initialize with your API key
const ip = Intelliprint('your-api-key-here');

// Or set as environment variable
const ip = Intelliprint(process.env.INTELLIPRINT_API_KEY);

const printJob = await ip.prints.create({
  testmode: true,  // This is a test - won't be charged or sent
  content: 'Your letter content here',
  recipients: [{ /* ... */ }]
});

// Create and confirm in one step
const printJob = await ip.prints.create({
  content: '<h1>Hello</h1>',
  recipients: [{address: {/* ... */}}],
  confirmed: true  // Send immediately
});

// Step 1: Create draft
const draft = await ip.prints.create({
  content: '<h1>Hello</h1>',
  recipients: [{address: {/* ... */}}]
  // confirmed defaults to false
});

// Step 2: Review, then confirm later
const confirmed = await ip.prints.update(draft.id, {
  confirmed: true
});

const printJob = await ip.prints.create({
  content: '<h1>Invoice</h1>',
  recipients: [{address: {/* ... */}}],
  
  // Store custom metadata
  metadata: {
    customer_id: '12345',
    invoice_number: 'INV-2025-001',
    department: 'Finance',
    internal_reference: 'Q1-Campaign'
  },
  
  confirmed: true
});

// Retrieve later
console.log(printJob.metadata.customer_id);  // '12345'

const printJob = await ip.prints.create({
  content: '<h1>Confidential: Salary Review</h1>',
  recipients: [{address: {/* ... */}}],
  
  // Mark as confidential
  confidential: true,
  
  confirmed: true
});

// This job is now hidden from other dashboard users

const printJob = await ip.prints.create({
  content: '<h1>Important Letter</h1>',
  recipients: [{address: {/* ... */}}],
  
  // Request confirmation email
  confirmation_email: true,
  
  confirmed: true
});

// Account owner will receive an email confirmation

// Create mailing list with validation
const mailingList = await ip.mailing_lists.create({
  name: 'Validated Campaign List',
  recipients: [
    {address: {line: '10 Downing Street, London', postcode: 'SW1A 2AA', country: 'GB'}},
    {address: {line: 'Invalid Address', postcode: 'XX1 1XX', country: 'GB'}}
  ],
  
  // Request address validation
  address_validation: {
    requested: true
  }
});

// Check validation status
console.log('Validation completed:', mailingList.address_validation.completed);
console.log('Passed:', mailingList.address_validation.recipients.passed);
console.log('Failed:', mailingList.address_validation.recipients.failed);