Back to Strapi

@strapi/provider-email-sendmail

packages/providers/email-sendmail/README.md

5.45.03.3 KB
Original Source

@strapi/provider-email-sendmail

Resources

Installation

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

# using npm
npm install @strapi/provider-email-sendmail --save

Configuration

VariableTypeDescriptionRequiredDefault
providerstringThe name of the provider you useyes
providerOptionsobjectWill be directly given to require('sendmail'). Please refer to sendmail doc.no{}
settingsobjectSettingsno{}
settings.defaultFromstringDefault sender mail addressnoundefined
settings.defaultReplyTostring | arrayDefault address or addresses the receiver is asked to reply tonoundefined
providerOptions.dkimobject | booleanDKIM parameters having two properties: { privateKey, keySelector }nofalse

: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

js
module.exports = ({ env }) => ({
  // ...
  email: {
    config: {
      provider: 'sendmail',
      settings: {
        defaultFrom: '[email protected]',
        defaultReplyTo: '[email protected]',
      },
    },
  },
  // ...
});

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

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

Path - config/plugins.js

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: '[email protected]',
      defaultReplyTo: '[email protected]',
    },
  },
  // ...
});