| 1 | # Postmark.js -- Simple Email Sending
|
| 2 |
|
| 3 | Send emails with the greatest of ease! Now your node.js application can send emails through [Postmark](http://www.postmarkapp.com) using their HTTP API. To send any email, including attachments, all you need to do is this:
|
| 4 |
|
| 5 | <pre>
|
| 6 | var postmark = require("postmark")("YOURAPIKEY");
|
| 7 | postmark.send({
|
| 8 | "From": "donotreply@example.com",
|
| 9 | "To": "target@example.us",
|
| 10 | "Subject": "Test",
|
| 11 | "TextBody": "Test Message"
|
| 12 | });
|
| 13 | </pre>
|
| 14 |
|
| 15 | Replace YOURAPIKEY with the API key provided by Postmark and you are good to go! Your message must be provided in the format specified in the (Postmark API)[http://developer.postmarkapp.com/developer-build.html#message-format] and will be verified. If you provide the object in a manner not as specified (including case sensitivity), an exception will be thrown. If there is an issue with the submission it will be thrown as an exception as well with information necessary for you to understand what went wrong.
|
| 16 |
|
| 17 | Enjoy sending.
|
| 18 |
|
| 19 |
|
| 20 | ### Special Thanks
|
| 21 | * [Postmark](http://www.postmarkapp.com)
|
| 22 | * [Request Library from @mikeal](http://github.com/mikeal/node-utils/tree/master/request/)
|
| 23 |
|
| 24 | ## License
|
| 25 |
|
| 26 | (The MIT License)
|
| 27 |
|
| 28 | Copyright (c) 2010 Chris Williams
|
| 29 |
|
| 30 | Permission is hereby granted, free of charge, to any person obtaining
|
| 31 | a copy of this software and associated documentation files (the
|
| 32 | 'Software'), to deal in the Software without restriction, including
|
| 33 | without limitation the rights to use, copy, modify, merge, publish,
|
| 34 | distribute, sublicense, and/or sell copies of the Software, and to
|
| 35 | permit persons to whom the Software is furnished to do so, subject to
|
| 36 | the following conditions:
|
| 37 |
|
| 38 | The above copyright notice and this permission notice shall be
|
| 39 | included in all copies or substantial portions of the Software.
|
| 40 |
|
| 41 | THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
|
| 42 | EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
| 43 | MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
| 44 | IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
| 45 | CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
| 46 | TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
| 47 | SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| \ | No newline at end of file |