Email

JavaScript
Python

Installing the SDK

Install the SDK

Bun
pnpm
npm
Yarn

bun add contiguity

pnpm add contiguity

npm install contiguity

yarn add contiguity

Initialize the Client

With API key
From env

import { Contiguity } from "contiguity";
const contiguity = new Contiguity("contiguity_sk_...your_key...");

import { Contiguity } from "contiguity";
// Reads CONTIGUITY_API_KEY or CONTIGUITY_TOKEN
const contiguity = new Contiguity();

Sending an email

Various email parameters can be configured in the Console such as tracking, custom domains, and more.Send with html, text, or both at the top level:

const res = await contiguity.email.send({
  to: ["user@example.com", "ops@example.com"],
  from: "Your App <no-reply@yourapp.com>",
  subject: "Welcome",
  html: "<p>Hello!</p>",
  text: "Hello!",
  reply_to: "support@yourapp.com",
  cc: "manager@example.com"
});

Response

string

Unique identifier for the sent email, used for tracking delivery status and analytics.

object

Request metadata including ID, timestamp, and API version.

For React Email (render a React component to HTML/text), use the top-level react option and see the JS SDK Email docs.

Installing the SDK

Install the SDK

pip install contiguity

Initialize the Client

import contiguity
client = contiguity.login("your_token_here")

You can also initialize it with the optional ‘debug’ flag:

client = contiguity.login("your_token_here", True)

Sending an email

Various email parameters can be configured in the Console such as tracking, custom domains, and more.

# HTML email
email_object = {
    "to": "example@example.com",
    "from": "Contiguity",
    "subject": "My first email!",
    "html": "<b>I sent an email using Contiguity</b>"
}

client.send.email(email_object)

Or, to send a plain text email:

# Plain text email
email_object = {
    "to": "example@example.com",
    "from": "Contiguity",
    "subject": "My first email!",
    "text": "I sent an email using Contiguity"
}

client.send.email(email_object)

Optionally, use replyTo and cc. At the moment, cc only allows one email address.

Parameters

email.send(params)

string | string[]

required

The recipient’s email address or an array of email addresses.

string

required

The sender’s email address. Can include a display name: "Your App <no-reply@yourapp.com>"

string

required

The email subject line.

string

HTML version of the email (JS: top-level; Python: top-level). Use with text and/or react (JS) as needed.

string

Plain text version of the email.

ReactNode

JS only. A React Email component; the SDK renders it to HTML and plain text. See JS SDK Email.

object

JS only, deprecated. Use top-level html, text, and react instead. Still supported: body: { text?, html?, react? }.

string

Email address for replies. If not specified, replies will go to the from address.

string | string[]

Carbon copy recipients. Can be a single email address or an array of addresses.

string | string[]

Blind carbon copy recipients. Can be a single email address or an array of addresses.

object[]

Custom email headers as an array of objects with name and value properties.

Show Header object structure

string

required

The header name (e.g., “X-Campaign”).

string

required

The header value.

Getting Started

SDK Documentation by Product

SDK Documentation by Language

Installing the SDK

Sending an email

Response

Installing the SDK

Sending an email

Parameters

email.send(params)

​Installing the SDK

​Sending an email

​Response

​Installing the SDK

​Sending an email

​Parameters

​email.send(params)

Installing the SDK

Sending an email

Response

Installing the SDK

Sending an email

Parameters

email.send(params)