README.md

strapi-provider-email-postmark

Strapi email service for Postmark

Prerequisites

You will need to have the plugin strapi-plugin-email installed in you Strapi project.

Installation

# using yarn
yarn add strapi-provider-email-postmark

# using npm
npm i 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	{}

Example

Path - config/plugins.js

module.exports = ({ env }) => ({
  // ...
  email: {
    config: {
      provider: "strapi-provider-email-postmark",
      providerOptions: {
        apiKey: "your-postmark-api-key",
      },
      settings: {
        defaultMessageStream: "my-stream",
        defaultFrom: "[email protected]",
        defaultTo: "[email protected]",
        defaultReplyTo: "[email protected]",
        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: strapi/strapi#11879.

Additionally, the structure of plugins.js has changed:

• In v3: "email": {"provider": "", ...}
• In v4: "email": {"config": {"provider": "", ...}}

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: "[email protected]",
  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: "[email protected]",
  templateAlias: "code-your-own",
  variables: {
    name: "John"
  }
});

Licence

• MIT