postmark

Postmark Node.js Library

Send emails with the greatest of ease! Postmark allows you to send your application's emails with high delivery rates, including bounce/spam processing and detailed statistics. In addition, Postmark can parse incoming emails which are forwarded back to your application.

Now your node.js application can send emails through Postmark. As the official Node.js library for Postmark, postmark.js has support for the entire REST API.

Requirements

Minimum supported Node version v18.0.0. The library uses the native Fetch API and has no runtime dependencies. If you use older Node versions for which active and security support ended, you will need to use older library versions (3.x.x for Node < 14, 4.x.x for Node < 18).

Note: The global Fetch API is stable from Node 21. On Node 18–20 it works but may log an ExperimentalWarning: The Fetch API is an experimental feature. This is emitted by Node itself, not by this library.

Proxies / custom fetch

Unlike axios, Node's built-in fetch (undici) does not read the HTTP_PROXY / HTTPS_PROXY / NO_PROXY environment variables. If you run behind a corporate egress proxy, supply your own fetch implementation via the fetch client option — for example one bound to an undici ProxyAgent dispatcher:

import { ServerClient } from "postmark";
import { ProxyAgent } from "undici";

const dispatcher = new ProxyAgent("http://proxy.internal:8080");

const client = new ServerClient("server-token", {
    fetch: (input, init) => fetch(input, { ...init, dispatcher }),
});

The same option can be used to inject a mock/instrumented fetch for testing or other transport customization.

Usage

Please see the wiki for quick start tutorial and detailed instructions about sending email at our documentation page. For details about Postmark API in general, please check out Postmark developer docs.

Installation

Installing postmark javascript library is super simple. Use the following command in your terminal:

npm install postmark

Migrating from older versions of the library

Please see wiki for more details.

Issues & Comments

Feel free to contact us if you encounter any issues with the library or Postmark API. Please leave all comments, bugs, requests and issues on the Issues page.

License

The Postmark JavaScript Library is licensed under the MIT license. Please refer to the LICENSE for more information.

Similar packages

Other packages similar to postmark

nodemailer

Nodemailer is a popular npm package for sending emails. Unlike Postmark, which is a service-specific client, Nodemailer is a general-purpose email sending library that can be used with various email services, including SMTP, AWS SES, and more.

sendgrid

SendGrid is another email service provider with an npm package for sending emails. Similar to Postmark, SendGrid offers functionalities for sending transactional emails, managing templates, and handling email events. However, SendGrid is known for its scalability and extensive API features.

mailgun-js

Mailgun-js is an npm package for interacting with the Mailgun email service. It provides similar functionalities to Postmark, such as sending emails, managing templates, and handling events. Mailgun is known for its powerful email validation and analytics features.