| 1 | <a href="https://postmarkapp.com">
|
| 2 | <img src="https://github.com/ActiveCampaign/postmark.js/raw/main/postmark.png" alt="Postmark Logo" title="Postmark" width="120" height="120" align="right">
|
| 3 | </a>
|
| 4 |
|
| 5 | # Postmark Node.js Library
|
| 6 | [](https://circleci.com/gh/ActiveCampaign/postmark.js)
|
| 7 | [](http://www.opensource.org/licenses/MIT)
|
| 8 | [](https://badge.fury.io/js/postmark)
|
| 9 |
|
| 10 | Send emails with the greatest of ease! [Postmark](http://www.postmarkapp.com) allows you to send your application's emails with high delivery rates, including bounce/spam processing and detailed statistics.
|
| 11 | In addition, Postmark can parse incoming emails which are forwarded back to your application.
|
| 12 |
|
| 13 | Now your node.js application can send emails through [Postmark](http://www.postmarkapp.com).
|
| 14 | As the official Node.js library for Postmark, postmark.js has support for the entire REST API.
|
| 15 |
|
| 16 | ## Requirements
|
| 17 |
|
| 18 | Minimum supported [Node](https://endoflife.date/nodejs) version `v14.0.0`. If you use older Node versions for which
|
| 19 | [active and security support ended](https://endoflife.date/nodejs) , you will need to use older library versions (3.x.x).
|
| 20 |
|
| 21 | ## Usage
|
| 22 |
|
| 23 | Please see the [wiki](https://github.com/ActiveCampaign/postmark.js/wiki) for quick start tutorial and detailed instructions about sending email at our [documentation page](https://ActiveCampaign.github.io/postmark.js/).
|
| 24 | For details about Postmark API in general, please check out [Postmark developer docs](https://postmarkapp.com/developer).
|
| 25 |
|
| 26 | ### Installation
|
| 27 |
|
| 28 | Installing `postmark` javascript library is super simple. Use the following command in your terminal:
|
| 29 |
|
| 30 | ```bash
|
| 31 | npm install postmark
|
| 32 | ```
|
| 33 |
|
| 34 | ## Migrating from older versions of the library
|
| 35 |
|
| 36 | Please see [wiki](https://github.com/ActiveCampaign/postmark.js/wiki/Migrating-from-older-version) for more details.
|
| 37 |
|
| 38 | ## Issues & Comments
|
| 39 |
|
| 40 | Feel free to contact us if you encounter any issues with the library or Postmark API.
|
| 41 | Please leave all comments, bugs, requests and issues on the Issues page.
|
| 42 |
|
| 43 | ## License
|
| 44 |
|
| 45 | The Postmark JavaScript Library is licensed under the **MIT** license. Please refer to the [LICENSE](https://github.com/ActiveCampaign/postmark.js/blob/main/LICENSE) for more information.
|