strapi-provider-email-postmark
Version:
Strapi Email service provider for Postmark
93 lines (72 loc) • 4.54 kB
Markdown
[](http://strapi.io/) email service for [Postmark](https://postmarkapp.com/)
You will need to have the plugin `strapi-plugin-email` installed in you Strapi project.
```
yarn add strapi-provider-email-postmark
npm i strapi-provider-email-postmark
```
| Variable | Type | Description | Required | Default |
| ----------------------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | --------- |
| provider | string | The name of the provider you use | yes | |
| providerOptions | object | Provider options | yes | |
| providerOptions.apiKey | string | Postmark API key. Please refer to [postmark docs](https://www.npmjs.com/package/postmark) for more | yes | |
| settings | object | Settings | no | {} |
| settings.defaultMessageStream | string | Send through a specific message stream. Please refer to [postmark docs](https://postmarkapp.com/support/article/1207-how-to-create-and-send-through-message-streams) for more | no | undefined |
| settings.defaultFrom | string | Default sender mail address | no | undefined |
| settings.defaultTo | string | Default receiver mail address | no | undefined |
| settings.defaultReplyTo | string | Default address the receiver is asked to reply to | no | undefined |
| settings.defaultVariables | object | Default set of variables to be used in template emails | no | {} |
Path - `config/plugins.js`
```javascript
module.exports = ({ env }) => ({
// ...
email: {
config: {
provider: "strapi-provider-email-postmark",
providerOptions: {
apiKey: "your-postmark-api-key",
},
settings: {
defaultMessageStream: "my-stream",
defaultFrom: "john.doe@ijs.to",
defaultTo: "john.doe@ijs.to",
defaultReplyTo: "code@ijs.to",
defaultVariables: {
sentBy: 'strapi',
},
},
}
},
// ...
});
```
**IMPORTANT:** With Strapi v4, you have to set `email.config.provider` to "strapi-provider-email-postmark", instead of "postmark". This is intended in Strapi v4: https://github.com/strapi/strapi/issues/11879.
Additionally, the structure of `plugins.js` has changed:
- In v3: `"email": {"provider": "", ...}`
- In v4: `"email": {"config": {"provider": "", ...}}`
Call the `send` function on the email service, as you would for any strapi email service.
```javascript
await strapi.plugins.email.services.email.send({
to: "john.doe@ijs.to",
text: "Hello John"
});
```
To send an email via a template, set `templateId` or `templateAlias` (and `variables`) to use the `sendEmailWithTemplate` method.
```javascript
await strapi.plugins.email.services.email.send({
to: "john.doe@ijs.to",
templateAlias: "code-your-own",
variables: {
name: "John"
}
});
```
- [MIT](https://github.com/ijsto/strapi-provider-email-postmark/blob/master/LICENSE.md)