Quickstart Guide

import { Sendly } from '@sendlyapp/sdk'

// Option 1: Pass the API key directly
const client = new Sendly('se_your_api_key')

// Option 2: Use an environment variable
// Set SENDLY_API_KEY in your .env file
const client = new Sendly()

const response = await client.emails.send({
  from: 'noreply@yourdomain.com',
  to: 'user@example.com',
  subject: 'Hello!',
  text: 'This is your first email with Sendly',
  html: '<h1>Hello!</h1><p>This is your first email with Sendly</p>'
})

console.log('Email sent:', response.id)

// Create a domain
const domain = await client.domains.create({
  domain: 'mail.yourdomain.com'
})

// Verify the domain (follow the DNS instructions)
await client.domains.verify(domain.id)

// Use the domain for sending
await client.emails.send({
  from: 'noreply@mail.yourdomain.com',
  to: 'user@example.com',
  subject: 'Email from your domain',
  html: '<p>Content here</p>'
})

// Send with tracking
const response = await client.emails.send({
  from: 'noreply@yourdomain.com',
  to: 'user@example.com',
  subject: 'Tracked email',
  html: '<p>Content</p>',
  tracking: {
    open: true,
    click: true
  }
})

// Check the status
const email = await client.emails.get(response.id)
console.log(`Status: ${email.status}`) // DELIVERED, BOUNCED, FAILED, etc.

try {
  await client.emails.send({
    from: 'noreply@yourdomain.com',
    to: 'user@example.com',
    subject: 'Email',
    html: '<p>Content</p>'
  })
} catch (error) {
  if (error instanceof SendlyError) {
    console.error(`Error ${error.status}: ${error.message}`)
  } else {
    console.error('Unexpected error:', error)
  }
}