Email Domains

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();

Managing Email Domains

Use your own custom domains to send emails, improving deliverability and maintaining brand consistency.

List All Domains

View all domains currently registered with your account.

const res = await contiguity.domains.list();

Response

object[]

Array of all domains registered with your account, including their verification status and configuration details.

object

Request metadata including ID, timestamp, and API version.

Get Domain Details

Get detailed information about a specific domain, including verification status and DNS records.

const res = await contiguity.domains.get({ 
  domain: "example.com" 
});

Response

string

Current verification status of the domain (e.g., “verified”, “pending”, “failed”).

object[]

Array of DNS records required for domain verification and email sending.

object

Detailed verification status for each DNS record type (DKIM, SPF, DMARC).

object

Request metadata including ID, timestamp, and API version.

Register a Domain

Add a new domain to your account for sending emails.

const res = await contiguity.domains.register({ 
  domain: "example.com", 
  region: "us-east-1", 
  custom_return_path: "mail" 
});

Response

string

Registration status of the domain (e.g., “registered”, “pending_verification”).

object[]

Array of DNS records that must be added to your domain’s DNS settings for verification.

Show DNS Record Properties

string

Type of DNS record (e.g., “CNAME”, “TXT”, “MX”).

string

DNS record name/host that should be added.

string

DNS record value that should be set.

object

Request metadata including ID, timestamp, and API version.

You can also register a domain with minimal configuration:

const res = await contiguity.domains.register({ 
  domain: "example.com"
});

Delete a Domain

Remove a domain from your account when it’s no longer needed.

const res = await contiguity.domains.delete({ 
  domain: "example.com" 
});

Response

boolean

Indicates whether the domain was successfully deleted.

string

Confirmation message about the deletion status.

object

Request metadata including ID, timestamp, and API version.

Parameters

domains.list()

No parameters required. Returns all registered domains.

domains.get(params)

string

required

The domain name to get details for (e.g., “example.com”).

domains.register(params)

string

required

The domain name to register (e.g., “example.com”). Must be a valid domain you own.

string

AWS region for domain setup. Common options: "us-east-1", "us-west-2", "eu-west-1". Defaults to "us-east-1" if not specified.

string

Custom return path subdomain for bounce handling. If set to "mail", bounce emails will be handled at mail.yourdomain.com.

domains.delete(params)

string

required

The domain name to delete from your account (e.g., “example.com”).

Using Custom Domains

Once your domain is verified, you can use it to send emails with your brand:

// Send email from your custom domain
const res = await contiguity.email.send({
  to: "user@example.com",
  from: "Your App <hello@yourdomain.com>", // Use your verified domain
  subject: "Welcome to our platform!",
  html: "<h1>Welcome!</h1><p>Thanks for joining us.</p>",
  text: "Welcome! Thanks for joining us.",
  reply_to: "support@yourdomain.com"
});

Domain Verification

After registering a domain, you’ll need to:

Add DNS records provided in the registration response to your domain’s DNS settings
Verify ownership by ensuring the DNS records are properly configured
Wait for verification which typically takes a few minutes to complete

The verification status can be checked using the domains.get() method.

Make sure to add all required DNS records (DKIM, SPF, DMARC) to ensure optimal email deliverability and to prevent your emails from being marked as spam.

Deleting a domain will immediately stop all email sending from that domain. Make sure to update your email configurations before removing a domain.

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)

Managing Email Domains

# Python SDK examples coming soon

Parameters

Python SDK documentation coming soon.

Getting Started

SDK Documentation by Product

SDK Documentation by Language

Installing the SDK

Managing Email Domains

List All Domains

Response

Get Domain Details

Response

Register a Domain

Response

Delete a Domain

Response

Parameters

domains.list()

domains.get(params)

domains.register(params)

domains.delete(params)

Using Custom Domains

Domain Verification

Installing the SDK

Managing Email Domains

Parameters

​Installing the SDK

​Managing Email Domains

​List All Domains

​Response

​Get Domain Details

​Response

​Register a Domain

​Response

​Delete a Domain

​Response

​Parameters

​domains.list()

​domains.get(params)

​domains.register(params)

​domains.delete(params)

​Using Custom Domains

​Domain Verification

​Installing the SDK

​Managing Email Domains

​Parameters

Installing the SDK

Managing Email Domains

List All Domains

Response

Get Domain Details

Response

Register a Domain

Response

Delete a Domain

Response

Parameters

domains.list()

domains.get(params)

domains.register(params)

domains.delete(params)

Using Custom Domains

Domain Verification

Installing the SDK

Managing Email Domains

Parameters