Home/Tools/@tpmjs/tools-postmark

listSuppressions

@tpmjs/tools-postmark

List suppressed email addresses for a message stream.

Official
ops
v0.2.1
MIT

Interactive Playground

Test @tpmjs/tools-postmark (listSuppressions) with AI-powered execution

0/2000 characters

Installation & Usage

Install this tool and use it with the AI SDK

1. Install the package

npm install @tpmjs/tools-postmark
pnpm add @tpmjs/tools-postmark
yarn add @tpmjs/tools-postmark
bun add @tpmjs/tools-postmark
deno add npm:@tpmjs/tools-postmark

2. Import the tool

import { listSuppressions } from '@tpmjs/tools-postmark';

3. Use with AI SDK

import { generateText } from 'ai';
import { openai } from '@ai-sdk/openai';
import { listSuppressions } from '@tpmjs/tools-postmark';

const result = await generateText({
  model: openai('gpt-4o'),
  tools: { listSuppressions },
  prompt: 'Your prompt here...',
});

console.log(result.text);

Signature

(streamId: string, Origin?: string, EmailAddress?: string, SuppressionReason?: string) => Promise<unknown>

Tags

addresses
agent
email
list
message
ops
postmark
smtp
stream
suppressed
suppressions
tpmjs
transactional

Parameters

Available configuration options

Auto-extracted
streamId
Required
Type: string

Message stream ID.

SuppressionReason
Optional
Type: string

Filter by suppression reason.

Origin
Optional
Type: string

Filter by origin.

EmailAddress
Optional
Type: string

Filter by email address.

Schema extracted: 3/1/2026, 4:27:48 AM

README

ERROR: No README data found!

Statistics

Downloads/month

178

GitHub Stars

14

Quality Score

89%

Bundle Size

NPM Keywords

tpmjs
postmark
email
transactional
smtp
agent

Maintainers

thomasdavis(thomasalwyndavis@gmail.com)

Frameworks

vercel-ai
listSuppressions | TPMJS | TPMJS