@joshmeads/strapi-provider-email-postmark

Based upon @strapi/provider-email-sendgrid

Resources

• LICENSE

Links

• PostmarkApp
• Strapi website
• Strapi documentation
• Strapi community on Discord
• Strapi news on Twitter

Installation

# using yarn
yarn add @joshmeads/strapi-provider-email-postmark

# using npm
npm install @joshmeads/strapi-provider-email-postmark --save

Configuration

| Variable | Type | Description | Required | Default | | ---------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------- | -------- | --------- | | provider | string | The name of the provider you use | yes | | | providerOptions | object | Will be directly given to require('postmark'). Please refer to postmark doc. | yes | {} | | providerOptions.serverToken | string | Your Postmark server token / api key | yes | {} | | settings | object | Settings | no | {} | | settings.defaultFrom | string | Default sender mail address | no | undefined | | settings.defaultSubject | string | Default subject line | no | undefined | | settings.defaultTo | string | Default recipient mail address | no | undefined | | settings.defaultReplyTo | string | Default reply mail address | no | undefined | | settings.defaultTag | string | Default applied tag in Postmark Dashboard | no | undefined | | settings.defaultTrackOpens | boolean | Track opens by Default | no | undefined | | settings.defaultTrackLinks | string | Track links by Default Valid ENUM Options | no | undefined | | settings.defaultMessageStream | string | Default message stream to use | no | undefined | | settings.defaultTemplateModelItems | object | If using a template these items will exist on the model unless overwritten. | no | undefined |

:warning: The Shipper Email (or defaultfrom) may also need to be changed in the Email Templates tab on the admin panel for emails to send properly

Example

Path - config/plugins.js

module.exports = ({ env }) => ({
  // ...
  email: {
    config: {
      provider: "@joshmeads/strapi-provider-email-postmark",
      providerOptions: {
        serverToken: env("POSTMARK_SERVER_TOKEN"),
      },
      settings: {
        defaultFrom: env("POSTMARK_DEFAULT_FROM", "[email protected]"),
        defaultTo: env("POSTMARK_DEFAULT_TO", "[email protected]"),
        defaultReplyTo: env("POSTMARK_DEFAULT_REPLY_TO"),
        defaultSubject: env("POSTMARK_DEFAULT_SUBJECT"),
        defaultTag: env("POSTMARK_DEFAULT_TAG"),
        defaultTrackOpens: env.bool("POSTMARK_DEFAULT_TRACK_OPENS"),
        defaultTrackLinks: env("POSTMARK_DEFAULT_TRACK_LINKS"),
        defaultMessageStream: env("POSTMARK_DEFAULT_MESSAGE_STREAM"),
        defaultTemplateModelItems: env.json(
          "POSTMARK_DEFAULT_TEMPLATE_MODEL_ITEMS"
        ),
      },
    },
  },
  // ...
});