Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/marshallswain/feathers-postmark
A Postmark API service adapter for FeathersJS
https://github.com/marshallswain/feathers-postmark
Last synced: 3 months ago
JSON representation
A Postmark API service adapter for FeathersJS
- Host: GitHub
- URL: https://github.com/marshallswain/feathers-postmark
- Owner: marshallswain
- License: mit
- Created: 2017-04-03T16:34:23.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2023-10-10T14:13:55.000Z (over 1 year ago)
- Last Synced: 2024-06-20T15:55:17.611Z (7 months ago)
- Language: JavaScript
- Size: 598 KB
- Stars: 7
- Watchers: 2
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/contributing.md
- License: LICENSE
Awesome Lists containing this project
- awesome-feathersjs - feathers-postmark - A [Postmark](https://postmarkapp.com/) API service adapter for FeathersJS (Plugins / Email and SMS)
README
# feathers-postmark
[](https://greenkeeper.io/)
[](https://travis-ci.org/feathersjs/feathers-postmark)
[](https://codeclimate.com/github/feathersjs/feathers-postmark/coverage)
[](https://david-dm.org/feathersjs/feathers-postmark)
[](https://www.npmjs.com/package/feathers-postmark)
> A Postmark API service adapter for FeathersJS
## Installation
```
npm install feathers-postmark --save
```
[
](https://postmarkapp.com/)
## Documentation
The `feathers-postmark` service adapter creates services that send transactional email through [Postmark](https://postmarkapp.com/).
### Configuration
Like all Feathers service adapters, the `postmark` adapter is a function that receives an object as options and returns a class implementing the Feathers `service interface`.
### `postmark(options)`
- `options` `{Object}`
- `key` `{String}` - Your Postmark API key. Set it to `POSTMARK_API_TEST` for testing purposes. Required.
Once you have passed your Postmark API `key` in the `options`, the service is ready to be `use`d in your application:
```js
const postmark = require('feathers-postmark');
const options = {
key: 'POSTMARK_API_TEST'
};
app.use('messages', postmark(options));
app.service('messages').hooks({
before: {
create: [
// Use hooks in feathers-hooks-common to protect your service from outside access.
disallow('external')
]
}
});
```
### `service.create(data[, params]) -> promise`
The `create` method will send the provided `data` through the [Postmark Email API](http://developer.postmarkapp.com/developer-api-email.html#send-email).
- `data` `{PostmarkEmail | Array}` - Supports any of the options available in the Postmark [Email API body format](http://developer.postmarkapp.com/developer-api-email.html#send-email).
#### Send a single message
If the payload of data is in the format of a PostmarkEmail Object, as shown in the example, below, the [sendEmail](http://wildbit.github.io/postmark.js/Client.html#sendEmail) method of the `postmark` client will be used.
```js
const message = {
"From": "[email protected]",
"To": "[email protected]",
"Cc": "[email protected]",
"Bcc": "[email protected]",
"Subject": "Test",
"Tag": "Invitation",
"HtmlBody": "Hello",
"TextBody": "Hello",
"ReplyTo": "[email protected]",
"Headers": [
{
"Name": "CUSTOM-HEADER",
"Value": "value"
}
],
"TrackOpens": true,
"TrackLinks": "None",
"Attachments": [
{
"Name": "readme.txt",
"Content": "dGVzdCBjb250ZW50",
"ContentType": "text/plain"
},
{
"Name": "report.pdf",
"Content": "dGVzdCBjb250ZW50",
"ContentType": "application/octet-stream"
}
]
};
app.service('my-postmark-service').create(message);
```
#### Send a Templated Message
If your message includes a `TemplateId` property, the [sendEmailWithTemplate](http://wildbit.github.io/postmark.js/Client.html#sendEmailWithTemplate) method of the `postmark` client will be used. The message data can include any of the [PostmarkTemplateMessage](http://wildbit.github.io/postmark.js/global.html#PostmarkTemplateMessage) properties.
#### Send a Batch Message
If the `data` passed to `create` is an array, the data will be passed to the [sendEmailBatch](http://wildbit.github.io/postmark.js/Client.html#sendEmailBatch) method of the `postmark` client.
## Complete Example
Here's an example of a Feathers server that uses `feathers-postmark`.
```js
const feathers = require('feathers');
const rest = require('feathers-rest');
const hooks = require('feathers-hooks');
const bodyParser = require('body-parser');
const errorHandler = require('feathers-errors/handler');
const postmark = require('feathers-postmark');
// Initialize the application
const app = feathers()
.configure(rest())
.configure(hooks())
// Needed for parsing bodies (login)
.use(bodyParser.json())
.use(bodyParser.urlencoded({ extended: true }))
// Initialize your feathers plugin
.use('messages', postmark({key: 'POSTMARK_API_TEST'})
.use(errorHandler());
app.listen(3030);
console.log('Feathers app started on 127.0.0.1:3030');
```
## License
Copyright (c) 2016
Licensed under the [MIT license](LICENSE).