4.4.5 • Published 2 years ago

@joshmeads/strapi-provider-email-postmark v4.4.5

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

@joshmeads/strapi-provider-email-postmark

Based upon @strapi/provider-email-sendgrid

Resources

Links

Installation

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

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

Configuration

VariableTypeDescriptionRequiredDefault
providerstringThe name of the provider you useyes
providerOptionsobjectWill be directly given to require('postmark'). Please refer to postmark doc.yes{}
providerOptions.serverTokenstringYour Postmark server token / api keyyes{}
settingsobjectSettingsno{}
settings.defaultFromstringDefault sender mail addressnoundefined
settings.defaultSubjectstringDefault subject linenoundefined
settings.defaultTostringDefault recipient mail addressnoundefined
settings.defaultReplyTostringDefault reply mail addressnoundefined
settings.defaultTagstringDefault applied tag in Postmark Dashboardnoundefined
settings.defaultTrackOpensbooleanTrack opens by Defaultnoundefined
settings.defaultTrackLinksstringTrack links by Default Valid ENUM Optionsnoundefined
settings.defaultMessageStreamstringDefault message stream to usenoundefined
settings.defaultTemplateModelItemsobjectIf using a template these items will exist on the model unless overwritten.noundefined

: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", "myemail@protonmail.com"),
        defaultTo: env("POSTMARK_DEFAULT_TO", "myemail@protonmail.com"),
        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"
        ),
      },
    },
  },
  // ...
});