Copy page

Guides

Node.js

1. Installation

Install the SDK via your preferred package manager:

2. Send your first email

Initialize the client with your API token:

Code
import { Lettermint } from "lettermint";

const lettermint = new Lettermint({
    apiToken: "your-api-token"
});

Send your first email:

Code
const response = await lettermint.email
  .from('John Doe <john@yourdomain.com>')
  .to('recipient@example.com')
  .subject('Hello from Lettermint')
  .text('This is a test email sent using the Lettermint Node.js SDK.')
  .send();

console.log(`Email sent with ID: ${response.message_id}`);

3. Email Features

Basic Email

Send a simple text or HTML email:

Code
const response = await lettermint.email
    .from('John Doe <john@yourdomain.com>')
    .to('recipient@example.com')
    .subject('Your account is ready!')
    .html('<h1>Welcome!</h1><p>Thanks for signing up.</p>')
    .text('Welcome! Thanks for signing up.')
    .send();

Multiple Recipients

Send to multiple recipients using CC and BCC:

Code
const response = await lettermint.email
    .from('John Doe <john@yourdomain.com>')
    .to('user1@example.com', 'user2@example.com')
    .cc('manager@yourdomain.com')
    .bcc('archive@yourdomain.com')
    .subject('Monthly Newsletter')
    .html('<h1>This Month\'s Updates</h1>')
    .send();

Custom Headers and Reply-To

Add custom headers and set reply-to addresses:

Code
const response = await lettermint.email
    .from('support@yourdomain.com')
    .to('customer@example.com')
    .replyTo('help@yourdomain.com')
    .subject('Support Ticket #12345')
    .headers({
        'X-Priority': '1',
        'X-Ticket-ID': '12345'
    })
    .html('<p>Your support ticket has been updated.</p>')
    .send();

Metadata

Add metadata for tracking and webhook payloads:

Code
const response = await lettermint.email
    .from('notifications@yourdomain.com')
    .to('user@example.com')
    .subject('Order Confirmation')
    .metadata({
        'order_id': '12345',
        'customer_id': 'cust_789',
        'campaign': 'order_confirmation'
    })
    .html('<p>Your order has been confirmed.</p>')
    .send();

Tags

Categorize emails for filtering and analytics:

Code
const response = await lettermint.email
    .from('alerts@yourdomain.com')
    .to('admin@example.com')
    .subject('System Alert')
    .tag('system-alerts')
    .html('<p>Critical system alert detected.</p>')
    .send();

Route Selection

Direct emails to specific routes within your project:

Code
const response = await lettermint.email
    .from('notifications@yourdomain.com')
    .to('user@example.com')
    .subject('Welcome!')
    .route('transactional')
    .html('<p>Welcome to our platform.</p>')
    .send();

File Attachments

Attach files to your emails:

Code
import fs from 'fs';

// Read file content
const fileContent = fs.readFileSync('/path/to/document.pdf');
const base64Content = fileContent.toString('base64');

const response = await lettermint.email
    .from('invoices@yourdomain.com')
    .to('customer@example.com')
    .subject('Your Invoice')
    .html('<p>Please find your invoice attached.</p>')
    .attach('invoice.pdf', base64Content)
    .send();

4. Response

Code
const response = await lettermint.email
    .from('John Doe <john@yourdomain.com>')
    .to('recipient@example.com')
    .subject('Test')
    .text('Hello!')
    .send();

console.log(`Email sent with ID: ${response.message_id}`);
console.log(`Status: ${response.status}`);

Next Steps