Postmark plugin

• A send cannot be recalled. email.send and email.sendBatch deliver real mail. A server in Sandbox mode accepts sends without delivering them, but that is a server setting rather than a request flag.
• A 200 batch is not a success. email.sendBatch answers HTTP 200 with one result per message, and each carries its own ErrorCode. 0 means sent, and anything else means that message failed while the others may have gone out.
• The sender must be verified. From needs a confirmed Sender Signature or a verified domain, or the send is rejected with code 300.
• A body is required. Supply TextBody, HtmlBody, or both; the plugin rejects a message with neither before it is sent.
• Attachments are base64. Give each one a Name, a Content and a ContentType, and set ContentID to reference it as cid: from the HTML.
• Paging is by offset. List routes take Count and Offset (100 and 0 when left out) and return TotalCount; page while the offset is below it. Note that the bounces route spells its parameters in lowercase, which this plugin maps for you.
• Stats are limited. The overview accepts a window no older than a year, and the stats API needs the plan that includes it.
• Retries. A 429 is retried three times by Corsair’s request layer, which waits for a Retry-After when Postmark sends one. A 5xx or a dropped connection is retried only on reads; a send is never replayed.
• Webhooks. Postmark posts delivery, bounce and inbound events to a URL you register, but this plugin does not handle inbound deliveries.

• 19 typed API operations

Setup

npm install corsair @corsair-dev/postmark better-sqlite3
npm install --save-dev @types/better-sqlite3

yarn add corsair @corsair-dev/postmark better-sqlite3
yarn add --dev @types/better-sqlite3

pnpm install corsair @corsair-dev/postmark better-sqlite3
pnpm install --save-dev @types/better-sqlite3

bun add corsair @corsair-dev/postmark better-sqlite3
bun add --dev @types/better-sqlite3

import Database from 'better-sqlite3';
import { createCorsair } from 'corsair';
import { postmark } from '@corsair-dev/postmark';

export const corsair = createCorsair({
	plugins: [
		postmark(),
	],
	database: new Database('corsair.db'),
	kek: process.env.CORSAIR_KEK!,
	multiTenancy: true,
	hub: {
		projectApiKey: process.env.CORSAIR_API_KEY!,
		signingSecret: process.env.CORSAIR_SIGNING_SECRET!,
	},
});

postmark()

const { connectUrl } = await corsair.manage.connect.createLink({
	plugin: 'postmark',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl

Example API calls

const tenant = corsair.withTenant('acme');
await tenant.postmark.api.server.get({});

const tenant = corsair.withTenant('acme');
await tenant.postmark.api.templates.create({
	Name: 'Welcome Email',
	Alias: 'onboarding-v1',
	Subject: 'Hello, from {{company.name}}',
	HtmlBody: '<html><body>Hello {{name}}</body></html>',
});

What’s next