📋 Lists module Inbound API

Manage account-level lists.

Add List Entry method

Add an entry to an account-level blocklist or safelist.

Usage

modular.ts

import { MailChannelsClient, Lists } from 'mailchannels-sdk'

const mailchannels = new MailChannelsClient('your-api-key')
const lists = new Lists(mailchannels)

const { data, error } = await lists.addListEntry({
  listName: 'safelist',
  item: 'name@domain.com'
})

full.ts

import { MailChannels } from 'mailchannels-sdk'

const mailchannels = new MailChannels('your-api-key')

const { data, error } = await mailchannels.lists.addListEntry({
  listName: 'safelist',
  item: 'name@domain.com'
})

Params

• options ListEntryOptions required: Add list entry options.
  • listName "blocklist" | "safelist" | "blacklist" | "whitelist" required: The list to add the item to.
  • item string required: The item to add to the list. This can be a domain, email address, or IP address.

Response

• data ListEntry | null nullable
  • action "blocklist" | "safelist" guaranteed
  • item string guaranteed
  • type "domain" | "email_address" | "ip_address" guaranteed
• error ErrorResponse | null nullable: Error information if the operation failed.
  • message string guaranteed: A human-readable description of the error.
  • statusCode number | null nullable: The HTTP status code from the API, or null if the error is not related to an HTTP request.

List Entries method

Get account-level list entries.

Usage

modular.ts

import { MailChannelsClient, Lists } from 'mailchannels-sdk'

const mailchannels = new MailChannelsClient('your-api-key')
const lists = new Lists(mailchannels)

const { data, error } = await lists.listEntries('safelist')

full.ts

import { MailChannels } from 'mailchannels-sdk'

const mailchannels = new MailChannels('your-api-key')

const { data, error } = await mailchannels.lists.listEntries('safelist')

Params

• listName "blocklist" | "safelist" | "blacklist" | "whitelist" required: The name of the list to fetch.

Response

• data ListEntry[] | null nullable
  • action "blocklist" | "safelist" guaranteed
  • item string guaranteed
  • type "domain" | "email_address" | "ip_address" guaranteed
• error ErrorResponse | null nullable: Error information if the operation failed.
  • message string guaranteed: A human-readable description of the error.
  • statusCode number | null nullable: The HTTP status code from the API, or null if the error is not related to an HTTP request.

Delete List Entry method

Delete item from account-level list.

Usage

modular.ts

import { MailChannelsClient, Lists } from 'mailchannels-sdk'

const mailchannels = new MailChannelsClient('your-api-key')
const lists = new Lists(mailchannels)

const { success, error } = await lists.deleteListEntry({
  listName: 'safelist',
  item: 'name@domain.com'
})

full.ts

import { MailChannels } from 'mailchannels-sdk'

const mailchannels = new MailChannels('your-api-key')

const { success, error } = await mailchannels.lists.deleteListEntry({
  listName: 'safelist',
  item: 'name@domain.com'
})

Params

• options ListEntryOptions required: Add list entry options.
  • listName "blocklist" | "safelist" | "blacklist" | "whitelist" required: The name of the list to remove an entry from.
  • item string required: The list entry which should be removed. This can be a domain, email address, or IP address.

Response

• success boolean guaranteed: Whether the operation was successful.
• error ErrorResponse | null nullable: Error information if the operation failed.
  • message string guaranteed: A human-readable description of the error.
  • statusCode number | null nullable: The HTTP status code from the API, or null if the error is not related to an HTTP request.

Type declarations

class Lists {
  constructor (protected mailchannels: MailChannelsClient);
  async addListEntry (options: ListEntryOptions): Promise<ListEntryResponse>;
  async listEntries (listName: ListNames): Promise<ListEntriesResponse>;
  async deleteListEntry (options: ListEntryOptions): Promise<SuccessResponse>;
}

All type declarations

Response type declarations

interface ErrorResponse {
  message: string;
  statusCode: number | null;
}

type DataResponse<T> = {
  data: T;
  error: null;
} | {
  data: null;
  error: ErrorResponse;
};

List Entry type declarations

type ListNames = "blocklist" | "safelist" | "blacklist" | "whitelist";

interface ListEntryOptions {
  listName: ListNames;
  item: string;
}

interface ListEntry {
  action: Extract<ListNames, "blocklist" | "safelist">;
  item: string;
  type: "domain" | "email_address" | "ip_address";
}

type ListEntryResponse = DataResponse<ListEntry>;

type ListEntriesResponse = DataResponse<ListEntry[]>;

Source

Source • Playground • Docs