Creating custom email providers

Page summary:

Build a custom email provider by exporting a Node.js module with a send() function. Use it locally in your project or publish it to npm to share with the community.

Strapi's Email feature delegates sending to a provider, a Node.js module that implements a standard interface. When no official or community provider meets your needs, you can create your own.

Provider interface

To implement a custom provider you must create a Node.js module. The module must export an init function that returns a send function:

JavaScript

module.exports = {
  init: (providerOptions = {}, settings = {}) => {
    return {
      send: async options => {},
    };
  },
};

TypeScript

export default {
  init: (providerOptions = {}, settings = {}) => {
    return {
      send: async options => {},
    };
  },
};

Inside the send function you have access to:

• providerOptions — the values passed under providerOptions in /config/plugins.js|ts.
• settings — the values passed under settings in /config/plugins.js|ts.
• options — the options passed when calling send() from a controller or service.

You can review the Strapi-maintained providers for reference implementations.

Publishing and using your provider

After creating your provider you can either publish it to npm or use it locally within your project.

Publishing to npm

Publish your provider to npm to make it available to the Strapi community. Once published, install and configure it like any other provider (see Configuring providers).

Using a local provider

To use a custom provider without publishing it to npm:

1. Create a providers folder at the root of your Strapi application.
2. Create your provider inside it (e.g., providers/strapi-provider-email-custom).
3. Update package.json to point the dependency to the local path:

{
  "dependencies": {
    "strapi-provider-email-custom": "file:providers/strapi-provider-email-custom"
  }
}

4. Update /config/plugins.js|ts to configure the provider.
5. Run yarn or npm install to link the local package.