Package Exports
- @strapi-community/provider-email-postmark
- @strapi-community/provider-email-postmark/lib/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@strapi-community/provider-email-postmark) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
@strapi-community/provider-email-postmark
Strapi email service for Postmark
Installation
# using yarn
yarn add @strapi-community/provider-email-postmark
# using npm
npm i @strapi-community/provider-email-postmarkConfiguration
| 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 | {} |
Example
Path - config/plugins.js
module.exports = ({ env }) => ({
// ...
email: {
config: {
provider: "@strapi-community/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',
},
},
}
},
// ...
});Usage
Call the send function on the email service, as you would for any strapi email service.
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.
await strapi.plugins.email.services.email.send({
to: "john.doe@ijs.to",
templateAlias: "code-your-own",
variables: {
name: "John"
}
});