| 1 | <a href="https://postmarkapp.com">
|
| 2 | <img src="https://github.com/wildbit/postmark.js/raw/master/postmark.png" alt="Postmark Logo" title="Postmark" width="120" height="120" align="right">
|
| 3 | </a>
|
| 4 |
|
| 5 | # Postmark Node.js Library
|
| 6 | [](https://travis-ci.org/wildbit/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 | ## Usage
|
| 17 |
|
| 18 | Please see the [wiki](https://github.com/wildbit/postmark.js/wiki) for quick start tutorial and detailed instructions about sending email at our [documentation page](https://wildbit.github.io/postmark.js/).
|
| 19 | For details about Postmark API in general, please check out [Postmark developer docs](https://postmarkapp.com/developer).
|
| 20 |
|
| 21 | ### Installation
|
| 22 |
|
| 23 | Installing `postmark` javascript library is super simple. Use the following command in your terminal:
|
| 24 |
|
| 25 | ```bash
|
| 26 | npm install postmark
|
| 27 | ```
|
| 28 |
|
| 29 | ## Migrating from version 1x
|
| 30 |
|
| 31 | Please see [wiki](https://github.com/wildbit/postmark.js/wiki/Migrating-from-1.x-to-2.x-version) for more details.
|
| 32 |
|
| 33 | ## Issues & Comments
|
| 34 |
|
| 35 | Feel free to contact us if you encounter any issues with the library or Postmark API.
|
| 36 | Please leave all comments, bugs, requests and issues on the Issues page.
|
| 37 |
|
| 38 | ## License
|
| 39 |
|
| 40 | The Postmark JavaScript Library is licensed under the **MIT** license. Please refer to the [LICENSE](https://github.com/wildbit/postmark.js/blob/master/LICENSE) for more information.
|