Package Exports

@strapi/provider-email-sendmail
@strapi/provider-email-sendmail/dist/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/provider-email-sendmail) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@strapi/provider-email-sendmail

Resources

LICENSE

Installation

# using yarn
yarn add @strapi/provider-email-sendmail

# using npm
npm install @strapi/provider-email-sendmail --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('sendmail')`. Please refer to sendmail doc.	no	{}
settings	object	Settings	no	{}
settings.defaultFrom	string	Default sender mail address	no	undefined
settings.defaultReplyTo	string \| array	Default address or addresses the receiver is asked to reply to	no	undefined
providerOptions.dkim	object \| boolean	DKIM parameters having two properties: { privateKey, keySelector }	no	false

⚠️ 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: 'sendmail',
      settings: {
        defaultFrom: 'myemail@protonmail.com',
        defaultReplyTo: 'myemail@protonmail.com',
      },
    },
  },
  // ...
});

Example with DKIM

Using DKIM (DomainKeys Identified Mail) can prevent emails from being considered as spam. More details about this subject can be found in the discussion on the Strapi forum: Unsolved problem: emails goes to spam!

Generate the keys using OpenSSL

openssl genrsa -out dkim-private.pem 1024
openssl rsa -in dkim-private.pem -pubout -out dkim-public.pem

Path - config/plugins.js

module.exports = ({ env }) => ({
  // ...
  email: {
    provider: 'sendmail',
    providerOptions: {
      dkim: {
        privateKey: 'replace-with-dkim-private-key',
        keySelector: 'abcd', // the same as the one set in DNS txt record, use online dns lookup tools to be sure that is retreivable
      },
    },
    settings: {
      defaultFrom: 'myemail@protonmail.com',
      defaultReplyTo: 'myemail@protonmail.com',
    },
  },
  // ...
});