postmark

What is postmark?

Postmark is an npm package that provides a simple and efficient way to send emails through the Postmark email service. It offers functionalities for sending transactional emails, managing email templates, and handling email events.

What are postmark's main functionalities?

Send Email

This feature allows you to send a simple email using the Postmark service. You need to initialize the Postmark client with your server API token and then use the `sendEmail` method to send an email.

const postmark = require('postmark');
const client = new postmark.ServerClient('your-server-api-token');

client.sendEmail({
  'From': '[e-mail]',
  'To': '[e-mail]',
  'Subject': 'Test Email',
  'TextBody': 'Hello from Postmark!'
});

Send Email with Template

This feature allows you to send an email using a predefined template. You need to specify the template ID and provide the template model data.

const postmark = require('postmark');
const client = new postmark.ServerClient('your-server-api-token');

client.sendEmailWithTemplate({
  'From': '[e-mail]',
  'To': '[e-mail]',
  'TemplateId': 123456,
  'TemplateModel': {
    'name': 'John Doe',
    'product_name': 'Awesome Product'
  }
});

Get Email Delivery Statistics

This feature allows you to retrieve email delivery statistics from Postmark. The `getDeliveryStatistics` method returns various metrics related to email delivery.

const postmark = require('postmark');
const client = new postmark.ServerClient('your-server-api-token');

client.getDeliveryStatistics().then((stats) => {
  console.log(stats);
});

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.

README

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.

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 version 1x

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.