Strapi Email service provider for Postmark
npm install strapi-provider-email-postmarkStrapi email service for Postmark
You will need to have the plugin strapi-plugin-email installed in you Strapi project.
``using yarn
yarn add strapi-provider-email-postmark
Configuration
| 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 for more | yes | |
| settings | object | Settings | no | {} |
| settings.defaultMessageStream | string | Send through a specific message stream. Please refer to postmark docs 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 | {} |
$3
Path -
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
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: $3
Call the
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
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