npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@keix/nodemailer-postmark-transport

v4.0.1

Published

Postmark transport for Nodemailer

Downloads

53

Readme

nodemailer-postmark-transport

A Postmark transport for Nodemailer.

Build Status Coverage Status Dependency Status devDependencies Status peerDependencies Status npm version Known Vulnerabilities Codacy Badge

Requirements

| version | Node.js | peerDependencies | |----------|:--------:|:------------------:| | 4.x | 10+ | nodemailer >=4.x | | 3.x | 8+ | nodemailer >=4.x | | 2.x | 6+ | nodemailer >=4.x | | >=1.3 <2 | 4+ | | | <1.3 | 0.10+ | |

Migrating from version 1.x

Please see CHANGELOG for more details.

Install

npm install nodemailer-postmark-transport

Examples

Quickstart

'use strict';

const nodemailer = require('nodemailer');
const postmarkTransport = require('nodemailer-postmark-transport');
const transport = nodemailer.createTransport(postmarkTransport({
  auth: {
    apiKey: 'key'
  }
}));
const mail = {
  from: '[email protected]',
  to: '[email protected]',
  subject: 'Hello',
  text: 'Hello',
  html: '<h1>Hello</h1>'
};

// callback style
transport.sendMail(mail, function (err, info) {
  if (err) {
    console.error(err);
  } else {
    console.log(info);
  }
});

// async/await style
try {
  const info = await transport.sendMail(mail);
  console.log(info);
} catch (err) {
  console.error(err);
}

Using Postmark templates feature

Read about Postmark templates here: Special delivery: Postmark templates. Read more about template alias here: How do I use a template alias?

'use strict';

const nodemailer = require('nodemailer');
const postmarkTransport = require('nodemailer-postmark-transport');
const transport = nodemailer.createTransport(postmarkTransport({
  auth: {
    apiKey: 'key'
  }
}));

// using templateId
let mail = {
  from: '[email protected]',
  to: '[email protected]',
  templateId: 1234,
  templateModel: {
    foo: 'bar'
  }
};

// using templateAlias
let mail = {
  from: '[email protected]',
  to: '[email protected]',
  templateAlias: 'buzz',
  templateModel: {
    foo: 'bar'
  }
};

transport.sendMail(mail, function (err, info) {
  if (err) {
    console.error(err);
  } else {
    console.log(info);
  }
});

Using attachments

References to nodemailer attachments docs and Postmark attachments docs

'use strict';

const nodemailer = require('nodemailer');
const postmarkTransport = require('nodemailer-postmark-transport');
const transport = nodemailer.createTransport(postmarkTransport({
  auth: {
    apiKey: 'key'
  }
}));
const mail = {
  from: '[email protected]',
  to: '[email protected]',
  subject: 'Hello',
  text: 'Hello, This email contains attachments',
  html: '<h1>Hello, This email contains attachments</h1>',
  attachments: [
    {
      path: 'data:text/plain;base64,aGVsbG8gd29ybGQ=',
      cid: 'cid:molo.txt'
    }
  ]
};

transport.sendMail(mail, function (err, info) {
  if (err) {
    console.error(err);
  } else {
    console.log(info);
  }
});

Access to Postmark.js client

You can find more details about Postmark.js in documentation here

'use strict';

const nodemailer = require('nodemailer');
const postmarkTransport = require('nodemailer-postmark-transport');
const transporter = postmarkTransport({
  auth: {
    apiKey: 'key'
  }
});
const transport = nodemailer.createTransport(transporter);

// transporter.client -> reference to Postmark.js client
// transport.mailer.transporter.client -> reference to Postmark.js client

Provide Postmark.js client with custom client options

Postmark.js library allows to specify configuration options for its server client. You can get more details about possible values here and default values here

'use strict';

const nodemailer = require('nodemailer');
const postmarkTransport = require('nodemailer-postmark-transport');
const transport = nodemailer.createTransport(postmarkTransport({
  auth: {
    apiKey: 'key'
  },
  postmarkOptions: {
    timeout: 60
  }
}));

Contributors

List of project's contributors!

License

The MIT License (MIT)

Copyright (c) Alexey Kucherenko

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.