Email SDK Reference

Send transactional HTML emails to one or many recipients with the InsForge TypeScript SDK, including CC, BCC, reply-to, and Custom SMTP support.

npm

npm install @insforge/sdk@latest

import { createClient } from '@insforge/sdk';

const insforge = createClient({
  baseUrl: 'https://your-app.insforge.app',
  anonKey: 'your-anon-key'  // Optional: for public/unauthenticated requests
});

Find the anon key with npx @insforge/cli secrets get ANON_KEY, or in the dashboard: click Install and open API Keys.

emails.send()

Send custom HTML emails to one or more recipients.

Parameters

• to (string | string[], required) - Recipient email(s), max 50 recipients
• subject (string, required) - Email subject line, max 500 characters
• html (string, required) - HTML content of the email
• cc (string | string[], optional) - CC recipient(s), max 50 recipients
• bcc (string | string[], optional) - BCC recipient(s), max 50 recipients
• from (string, optional) - Display name shown next to the sender address, max 100 characters (ignored when Custom SMTP is enabled)
• replyTo (string, optional) - Reply-to email address, must be a valid email address

By default, emails are sent from noreply@<your-project>.send.insforge.dev, a per-project subdomain that InsForge Cloud provisions and verifies for you, so no domain setup is required. The from field only sets the display name shown next to that address; on the default provider you cannot change the address or domain. To send from your own domain, configure Custom SMTP. When Custom SMTP is enabled the from field is ignored entirely, and the sender name and email are taken from your SMTP configuration to prevent spoofing through your server.

Returns

{
  data: {} | null,  // Empty object on success
  error: Error | null
}

Example

const { data, error } = await insforge.emails.send({
  to: ['[e-mail]', '[e-mail]'],
  cc: '[e-mail]',
  from: 'Acme Support Team',
  subject: 'Team Update',
  html: '<h1>Weekly Update</h1><p>Here are this week\'s highlights...</p>',
  replyTo: '[e-mail]'
});

if (error) {
  console.error('Failed to send email:', error.message);
  return;
}

console.log('Email sent successfully');