emailr

Developer-friendly & type-safe Typescript SDK specifically catered to leverage emailr API.

Summary

Table of Contents

• emailr
  • SDK Installation
  • Requirements
  • SDK Example Usage
  • Authentication
  • Available Resources and Operations
  • Standalone functions
  • Retries
  • Error Handling
  • Server Selection
  • Custom HTTP Client
  • Debugging

SDK Installation

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

NPM

npm add emailr

PNPM

pnpm add emailr

Bun

bun add emailr

Yarn

yarn add emailr

[!NOTE] This package is published with CommonJS and ES Modules (ESM) support.

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { Emailr } from "emailr";

const emailr = new Emailr({
  bearerAuth: process.env["EMAILR_BEARER_AUTH"] ?? "",
});

async function run() {
  const result = await emailr.emails.send({
    from: "[email protected]",
    to: "[email protected]",
    subject: "Hello World",
    html: "<h1>Hello</h1>",
    text: "Hello",
    templateId: "123e4567-e89b-12d3-a456-426614174000",
    templateData: {
      "name": "John",
      "company": "Acme",
    },
    tags: {
      "campaign": "welcome",
      "source": "signup",
    },
    attachments: [
      {
        filename: "document.pdf",
        content: "JVBERi0xLjQKJe...",
        contentType: "application/pdf",
      },
    ],
    replyTo: {
      inReplyTo: "<[email protected]>",
      threadId: "123e4567-e89b-12d3-a456-426614174000",
      parentEmailId: "123e4567-e89b-12d3-a456-426614174000",
    },
    replyToEmail: "[email protected]",
    previewText: "Check out our latest updates...",
  });

  console.log(result);
}

run();

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

| Name | Type | Scheme | Environment Variable | | ------------ | ---- | ----------- | -------------------- | | bearerAuth | http | HTTP Bearer | EMAILR_BEARER_AUTH |

To authenticate with the API the bearerAuth parameter must be set when initializing the SDK client instance. For example:

import { Emailr } from "emailr";

const emailr = new Emailr({
  bearerAuth: process.env["EMAILR_BEARER_AUTH"] ?? "",
});

async function run() {
  const result = await emailr.emails.send({
    from: "[email protected]",
    to: "[email protected]",
    subject: "Hello World",
    html: "<h1>Hello</h1>",
    text: "Hello",
    templateId: "123e4567-e89b-12d3-a456-426614174000",
    templateData: {
      "name": "John",
      "company": "Acme",
    },
    tags: {
      "campaign": "welcome",
      "source": "signup",
    },
    attachments: [
      {
        filename: "document.pdf",
        content: "JVBERi0xLjQKJe...",
        contentType: "application/pdf",
      },
    ],
    replyTo: {
      inReplyTo: "<[email protected]>",
      threadId: "123e4567-e89b-12d3-a456-426614174000",
      parentEmailId: "123e4567-e89b-12d3-a456-426614174000",
    },
    replyToEmail: "[email protected]",
    previewText: "Check out our latest updates...",
  });

  console.log(result);
}

run();

Available Resources and Operations

ApiKeys

• create - Create API key
• list - List API keys
• revoke - Revoke API key

Billing

• postV1BillingCheckout
• postV1BillingPortal
• getV1BillingUsage
• postV1BillingWebhooks

Broadcasts

• create - Create broadcast
• list - List broadcasts
• send - Send broadcast
• get - Get broadcast

ContactSync

• postV1ContactSyncSupabase
• postV1ContactSyncWebhookSyncId
• getV1ContactSync
• deleteV1ContactSyncId

Contacts

• create - Create a contact
• list - List contacts
• bulkCreate - Bulk create contacts
• get - Get contact
• update - Update contact
• delete - Delete contact

Domains

• add - Add domain
• list - List domains
• verify - Verify domain
• getDnsStatus - Get DNS status
• update - Update domain
• delete - Delete domain

Emails

• send - Send an email
• get - Get email by ID
• list - List emails

Integrations

• getV1IntegrationsConnections
• getV1IntegrationsSupabaseAuthorize
• getV1IntegrationsSupabaseCallback
• deleteV1IntegrationsId
• getV1IntegrationsVercelAuthorize
• getV1IntegrationsVercelCallback

Logs

• list - Get email logs

Metrics

• getUsage - Get usage metrics
• getEmail - Get email metrics

Segments

• create - Create segment
• list - List segments
• addContact - Add contact to segment

Settings

• getOrganization - Get organization settings
• updateOrganization - Update organization settings
• getTeam - Get team members
• getUnsubscribe - Get unsubscribe settings
• updateUnsubscribe - Update unsubscribe settings

Smtp

• getSmtpCredentials - Get SMTP credentials

Templates

• create - Create a template
• list - List templates
• get - Get template
• update - Update template
• delete - Delete template

Topics

• getV1Topics
• postV1Topics
• putV1TopicsId
• deleteV1TopicsId

Unsubscribe

• getV1UnsubscribeOrganizationId
• postV1Unsubscribe

Webhooks

• create - Create webhook
• list - List webhooks
• toggle - Toggle webhook
• delete - Delete webhook
• getDeliveries - Get webhook deliveries

Standalone functions

All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check FUNCTIONS.md.

• apiKeysCreate - Create API key
• apiKeysList - List API keys
• apiKeysRevoke - Revoke API key
• billingGetV1BillingUsage
• billingPostV1BillingCheckout
• billingPostV1BillingPortal
• billingPostV1BillingWebhooks
• broadcastsCreate - Create broadcast
• broadcastsGet - Get broadcast
• broadcastsList - List broadcasts
• broadcastsSend - Send broadcast
• contactsBulkCreate - Bulk create contacts
• contactsCreate - Create a contact
• contactsDelete - Delete contact
• contactsGet - Get contact
• contactsList - List contacts
• contactsUpdate - Update contact
• contactSyncDeleteV1ContactSyncId
• contactSyncGetV1ContactSync
• contactSyncPostV1ContactSyncSupabase
• contactSyncPostV1ContactSyncWebhookSyncId
• domainsAdd - Add domain
• domainsDelete - Delete domain
• domainsGetDnsStatus - Get DNS status
• domainsList - List domains
• domainsUpdate - Update domain
• domainsVerify - Verify domain
• emailsGet - Get email by ID
• emailsList - List emails
• emailsSend - Send an email
• integrationsDeleteV1IntegrationsId
• integrationsGetV1IntegrationsConnections
• integrationsGetV1IntegrationsSupabaseAuthorize
• integrationsGetV1IntegrationsSupabaseCallback
• integrationsGetV1IntegrationsVercelAuthorize
• integrationsGetV1IntegrationsVercelCallback
• logsList - Get email logs
• metricsGetEmail - Get email metrics
• metricsGetUsage - Get usage metrics
• segmentsAddContact - Add contact to segment
• segmentsCreate - Create segment
• segmentsList - List segments
• settingsGetOrganization - Get organization settings
• settingsGetTeam - Get team members
• settingsGetUnsubscribe - Get unsubscribe settings
• settingsUpdateOrganization - Update organization settings
• settingsUpdateUnsubscribe - Update unsubscribe settings
• smtpGetSmtpCredentials - Get SMTP credentials
• templatesCreate - Create a template
• templatesDelete - Delete template
• templatesGet - Get template
• templatesList - List templates
• templatesUpdate - Update template
• topicsDeleteV1TopicsId
• topicsGetV1Topics
• topicsPostV1Topics
• topicsPutV1TopicsId
• unsubscribeGetV1UnsubscribeOrganizationId
• unsubscribePostV1Unsubscribe
• webhooksCreate - Create webhook
• webhooksDelete - Delete webhook
• webhooksGetDeliveries - Get webhook deliveries
• webhooksList - List webhooks
• webhooksToggle - Toggle webhook

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:

import { Emailr } from "emailr";

const emailr = new Emailr({
  bearerAuth: process.env["EMAILR_BEARER_AUTH"] ?? "",
});

async function run() {
  const result = await emailr.emails.send({
    from: "[email protected]",
    to: "[email protected]",
    subject: "Hello World",
    html: "<h1>Hello</h1>",
    text: "Hello",
    templateId: "123e4567-e89b-12d3-a456-426614174000",
    templateData: {
      "name": "John",
      "company": "Acme",
    },
    tags: {
      "campaign": "welcome",
      "source": "signup",
    },
    attachments: [
      {
        filename: "document.pdf",
        content: "JVBERi0xLjQKJe...",
        contentType: "application/pdf",
      },
    ],
    replyTo: {
      inReplyTo: "<[email protected]>",
      threadId: "123e4567-e89b-12d3-a456-426614174000",
      parentEmailId: "123e4567-e89b-12d3-a456-426614174000",
    },
    replyToEmail: "[email protected]",
    previewText: "Check out our latest updates...",
  }, {
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  console.log(result);
}

run();

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:

import { Emailr } from "emailr";

const emailr = new Emailr({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  bearerAuth: process.env["EMAILR_BEARER_AUTH"] ?? "",
});

async function run() {
  const result = await emailr.emails.send({
    from: "[email protected]",
    to: "[email protected]",
    subject: "Hello World",
    html: "<h1>Hello</h1>",
    text: "Hello",
    templateId: "123e4567-e89b-12d3-a456-426614174000",
    templateData: {
      "name": "John",
      "company": "Acme",
    },
    tags: {
      "campaign": "welcome",
      "source": "signup",
    },
    attachments: [
      {
        filename: "document.pdf",
        content: "JVBERi0xLjQKJe...",
        contentType: "application/pdf",
      },
    ],
    replyTo: {
      inReplyTo: "<[email protected]>",
      threadId: "123e4567-e89b-12d3-a456-426614174000",
      parentEmailId: "123e4567-e89b-12d3-a456-426614174000",
    },
    replyToEmail: "[email protected]",
    previewText: "Check out our latest updates...",
  });

  console.log(result);
}

run();

Error Handling

EmailrError is the base class for all HTTP error responses. It has the following properties:

| Property | Type | Description | | ------------------- | ---------- | --------------------------------------------------------------------------------------- | | error.message | string | Error message | | error.statusCode | number | HTTP response status code eg 404 | | error.headers | Headers | HTTP response headers | | error.body | string | HTTP body. Can be empty string if no body is returned. | | error.rawResponse | Response | Raw HTTP response | | error.data$ | | Optional. Some errors may contain structured data. See Error Classes. |

Example

import { Emailr } from "emailr";
import * as errors from "emailr/models/errors";

const emailr = new Emailr({
  bearerAuth: process.env["EMAILR_BEARER_AUTH"] ?? "",
});

async function run() {
  try {
    const result = await emailr.emails.send({
      from: "[email protected]",
      to: "[email protected]",
      subject: "Hello World",
      html: "<h1>Hello</h1>",
      text: "Hello",
      templateId: "123e4567-e89b-12d3-a456-426614174000",
      templateData: {
        "name": "John",
        "company": "Acme",
      },
      tags: {
        "campaign": "welcome",
        "source": "signup",
      },
      attachments: [
        {
          filename: "document.pdf",
          content: "JVBERi0xLjQKJe...",
          contentType: "application/pdf",
        },
      ],
      replyTo: {
        inReplyTo: "<[email protected]>",
        threadId: "123e4567-e89b-12d3-a456-426614174000",
        parentEmailId: "123e4567-e89b-12d3-a456-426614174000",
      },
      replyToEmail: "[email protected]",
      previewText: "Check out our latest updates...",
    });

    console.log(result);
  } catch (error) {
    // The base class for HTTP error responses
    if (error instanceof errors.EmailrError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);

      // Depending on the method different errors may be thrown
      if (error instanceof errors.ErrorT) {
        console.log(error.data$.error); // string
        console.log(error.data$.code); // string
        console.log(error.data$.details); // any
      }
    }
  }
}

run();

Error Classes

Primary error:

• EmailrError: The base class for HTTP error responses.

Network errors:

• ConnectionError: HTTP client was unable to make a request to a server.
• RequestTimeoutError: HTTP request timed out due to an AbortSignal signal.
• RequestAbortedError: HTTP request was aborted by the client.
• InvalidRequestError: Any input used to create a request is invalid.
• UnexpectedClientError: Unrecognised or unexpected error.

Inherit from EmailrError:

• ErrorT: Applicable to 44 of 64 methods.*
• BadRequestError: Invalid signature. Status code 400. Applicable to 1 of 64 methods.*
• PostV1BillingCheckoutUnauthorizedError: Unauthorized. Status code 401. Applicable to 1 of 64 methods.*
• PostV1BillingPortalUnauthorizedError: Unauthorized. Status code 401. Applicable to 1 of 64 methods.*
• GetV1BillingUsageUnauthorizedError: Unauthorized. Status code 401. Applicable to 1 of 64 methods.*
• GetV1TopicsUnauthorizedError: Unauthorized. Status code 401. Applicable to 1 of 64 methods.*
• PostV1TopicsUnauthorizedError: Unauthorized. Status code 401. Applicable to 1 of 64 methods.*
• PutV1TopicsIdUnauthorizedError: Unauthorized. Status code 401. Applicable to 1 of 64 methods.*
• DeleteV1TopicsIdUnauthorizedError: Unauthorized. Status code 401. Applicable to 1 of 64 methods.*
• PutV1TopicsIdNotFoundError: Topic not found. Status code 404. Applicable to 1 of 64 methods.*
• DeleteV1TopicsIdNotFoundError: Topic not found. Status code 404. Applicable to 1 of 64 methods.*
• GetV1UnsubscribeOrganizationIdNotFoundError: Organization or contact not found. Status code 404. Applicable to 1 of 64 methods.*
• PostV1UnsubscribeNotFoundError: Contact not found. Status code 404. Applicable to 1 of 64 methods.*
• ResponseValidationError: Type mismatch between the data returned from the server and the structure expected by the SDK. See error.rawValue for the raw value and error.pretty() for a nicely formatted multi-line string.

* Check the method documentation to see if the error is applicable.

Server Selection

Override Server URL Per-Client

The default server can be overridden globally by passing a URL to the serverURL: string optional parameter when initializing the SDK client instance. For example:

import { Emailr } from "emailr";

const emailr = new Emailr({
  serverURL: "https://api.emailr.dev",
  bearerAuth: process.env["EMAILR_BEARER_AUTH"] ?? "",
});

async function run() {
  const result = await emailr.emails.send({
    from: "[email protected]",
    to: "[email protected]",
    subject: "Hello World",
    html: "<h1>Hello</h1>",
    text: "Hello",
    templateId: "123e4567-e89b-12d3-a456-426614174000",
    templateData: {
      "name": "John",
      "company": "Acme",
    },
    tags: {
      "campaign": "welcome",
      "source": "signup",
    },
    attachments: [
      {
        filename: "document.pdf",
        content: "JVBERi0xLjQKJe...",
        contentType: "application/pdf",
      },
    ],
    replyTo: {
      inReplyTo: "<[email protected]>",
      threadId: "123e4567-e89b-12d3-a456-426614174000",
      parentEmailId: "123e4567-e89b-12d3-a456-426614174000",
    },
    replyToEmail: "[email protected]",
    previewText: "Check out our latest updates...",
  });

  console.log(result);
}

run();

Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native Fetch API. This client is a thin wrapper around fetch and provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle errors and response.

The HTTPClient constructor takes an optional fetcher argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures.

The following example shows how to use the "beforeRequest" hook to to add a custom header and a timeout to requests and how to use the "requestError" hook to log errors:

import { Emailr } from "emailr";
import { HTTPClient } from "emailr/lib/http";

const httpClient = new HTTPClient({
  // fetcher takes a function that has the same signature as native `fetch`.
  fetcher: (request) => {
    return fetch(request);
  }
});

httpClient.addHook("beforeRequest", (request) => {
  const nextRequest = new Request(request, {
    signal: request.signal || AbortSignal.timeout(5000)
  });

  nextRequest.headers.set("x-custom-header", "custom value");

  return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
  console.group("Request Error");
  console.log("Reason:", `${error}`);
  console.log("Endpoint:", `${request.method} ${request.url}`);
  console.groupEnd();
});

const sdk = new Emailr({ httpClient: httpClient });

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass a logger that matches console's interface as an SDK option.

[!WARNING] Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.

import { Emailr } from "emailr";

const sdk = new Emailr({ debugLogger: console });

You can also enable a default debug logger by setting an environment variable EMAILR_DEBUG to true.