Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/laurenskling/strapi-provider-email-postmark
Postmark provider for strapi email
https://github.com/laurenskling/strapi-provider-email-postmark
Last synced: 3 days ago
JSON representation
Postmark provider for strapi email
- Host: GitHub
- URL: https://github.com/laurenskling/strapi-provider-email-postmark
- Owner: laurenskling
- Created: 2020-06-19T21:16:53.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-06-19T21:31:12.000Z (over 4 years ago)
- Last Synced: 2024-10-30T13:52:58.728Z (15 days ago)
- Language: JavaScript
- Size: 1.95 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# strapi-provider-email-sendgrid
## Resources
- [MIT License](LICENSE.md)
## Links
- [Strapi website](http://strapi.io/)
- [Strapi community on Slack](http://slack.strapi.io)
- [Strapi news on Twitter](https://twitter.com/strapijs)
## Prerequisites
You need to have the plugin `strapi-plugin-email` installed in you Strapi project.
## Installation
```bash
# using yarn
yarn add strapi-provider-email-postmark
# using npm
npm install strapi-provider-email-postmark --save
```
## Configuration
| Variable | Type | Description | Required | Default |
| ----------------------- | ----------------------- | ----------------------------------------------------------------------------------------------------------------------- | -------- | --------- |
| provider | string | The name of the provider you use | yes | |
| providerOptions | object | Provider options | yes | |
| providerOptions.apiKey | object | Api key given to the function setApiKey. Please refer to [@sendgrid/mail](https://www.npmjs.com/package/@sendgrid/mail) | yes | |
| settings | object | Settings | no | {} |
| settings.defaultFrom | string | Default sender mail address | no | undefined |
| settings.defaultTo | string | Default receiver mail address | no | undefined |
| settings.defaultReplyTo | string | Default address receiver is asked to reply to | no | undefined |
### Example
**Path -** `config/plugins.js`
```js
module.exports = ({ env }) => ({
// ...
email: {
provider: 'postmark',
providerOptions: {
apiKey: env('POSTMARK_API_KEY'),
},
settings: {
defaultFrom: '[email protected]',
defaultTo: '[email protected]',
defaultReplyTo: '[email protected]',
},
},
// ...
});
```