killmenot / nodemailer-postmark-transport

Postmark transport for Nodemailer

nodemailer-postmark-transport

A Postmark transport for Nodemailer.

Requirements

version	Node.js	peerDependencies
6.x	18+	nodemailer >=6.x
5.x	12+	nodemailer >=4.x
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.

nodemailer-postmark-transport's Issues

Support for postmark message stream

Can we specify what MessageStream in postmark server we will use?

please add support for MessageStream

https://wildbit.github.io/postmark.js/classes/message.html#messagestream

thanks !

Add support for attachments

Add support for using multiple rows for header

https://nodemailer.com/message/custom-headers/

Add support for templates?

Templates are really a very strong to use Postmark for me, any way we can incorporate that into this?

Support for templateAlias

Would be nice to see support for templateAlias instead of templateId only.

Update postmark.js to v2.2.5 to benefit of the /docs 30 Mo removed

This is related to this issue ActiveCampaign/postmark.js#48

`sendEmailBatch` breaks the message order from Postmark

Hi,

The _requestFactory function splits the results from client calls into 2 arrays, accepted and rejected.

Although this is useful, it causes a problem when sending batch emails and trying to reconcile failed messages against the input payload. When a message fails, Postmark sends back the following JSON:

{
  "ErrorCode": 405,
  "Message": "details"
}

This does not contain any identifier to indicate the original message that failed. This is fine in single emails but a problem in batch emails where you may have both successes and failures.

Postmark docs say that the results will be ordered the same as the original messages and leaves it to the user to compare the input against the results to match up the responses with the original messages.

Unfortunately this order is lost in the following code of the _requestFactory:

      results.forEach((result) => {
        if (result.ErrorCode === 0) {
          accepted.push(result);
        } else {
          rejected.push(result);
        }
      });

      return callback(null, {
        messageId: (results[0] || {}).MessageID,
        accepted: accepted,
        rejected: rejected
      });

A simple fix would be to update the _requestFactory to return an extra field that contains the original results, e.g.:

  export interface SentMessageInfo {
    messageId?: string;
    accepted: Array<Models.MessageSendingResponse>;
    rejected: Array<Models.MessageSendingResponse>;
    originalResults: Array<Models.MessageSendingResponse>;
  }

Consumers can then access that array if they wish to match the input to the output. I need this code so will raise a PR.

Support for custom cid for attachments

sendEmailBatchWithTemplates support?

Are you planning to add support for sendEmailBatchWithTemplates?
I would like to use nodemailer for sending batch emails with templates. But as I see this package is not supporting this.

postmarkOptions implemented?

The readme mentions using postmarkOptions but I'm not seeing it anywhere in the library. I was hoping to be able to attach tags or metadata as per Postmark's API like so:

postmarkOptions: {
  Tag: "test-tag",
  Metadata: { "foo":"bar" }
}

Thanks for your time!

nodemailer 5.x support

Getting a deprecation warning when installing

Issues sometimes sending emails on vercel (serverless)

We basically ran into what we think is this issue in production https://stackoverflow.com/questions/65631481/nodemailer-in-vercel-not-sending-email-in-production However we do already use async/await, so I suspect that it was our usage of this library that's the issue.

Just thanks.

Just big thank you! It is working perfectly with superlogin.

Add type definitions for using this package with TypeScript.

Please add the type definitions to the DefinitelyTyped repository:

I ran the following command in console but type definations were not found for this package:

npm i --save-dev @types/nodemailer-postmark-transport

In the mean time, how to use this package with the TypeScript?

I'm getting the compilation error: error TS7016: Could not find a declaration file for module 'nodemailer-postmark-transport'.

replyTo field not working

Is replyTo supported with Postmark ? I have a basic message:

  var msg = {
    to: '[email protected]',  
    replyTo : '[email protected]',     
    subject:`Submission received`, 
    from : '"ABC Company" <[email protected]>', 
    html: `<p>Thank-you for your recent submission....</p>`

The message delivers fine with all above properties except there is no replyTo; when I hit reply the message recipient is [email protected] in this example it should be [email protected]