strapi/packages/strapi-provider-email-sendgrid
Peter Etelej 318f20e826
Bump up minimum required Node to 10.16 (#7962)
Updated README docs & package.json `engine` versions to bump up the
minimum required Node version from `10.10` to `10.16` (or `10.16.0+`)

Strapi no longer supports `10.10` since it updated `sharp` to `0.26.0`
( https://github.com/strapi/strapi/pull/7729 ) which requires Node 10.16.0+
(See https://github.com/lovell/sharp/blob/master/docs/changelog.md#v0260---25th-august-2020 )

` yarn create strapi-app my-project --quickstart` on 10.10 fails with error
```
error sharp@0.26.0: The engine "node" is incompatible with this module. Expected version ">=10.16.0". Got "10.10.0"
error Found incompatible module.
```

Signed-off-by: Peter Etelej <peter@etelej.com>
2020-09-22 16:00:13 +02:00
..
2018-10-19 09:26:09 +02:00
2019-04-16 09:05:47 +02:00
2018-10-19 09:26:09 +02:00
2018-12-05 15:42:58 +01:00
2020-07-08 09:45:28 +02:00
2020-07-20 18:40:52 +02:00

strapi-provider-email-sendgrid

Resources

Prerequisites

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

Installation

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

# using npm
npm install strapi-provider-email-sendgrid --save

Configuration

Variable Type Description Required Default
provider string The name of the provider you use yes
providerOptions object Provider options yes
providerOptions.apiKey object Api key given to the function setApiKey. Please refer to @sendgrid/mail yes
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

Example

Path - config/plugins.js

module.exports = ({ env }) => ({
  // ...
  email: {
    provider: 'sendgrid',
    providerOptions: {
      apiKey: env('SENDGRID_API_KEY'),
    },
    settings: {
      defaultFrom: 'myemail@protonmail.com',
      defaultReplyTo: 'myemail@protonmail.com',
    },
  },
  // ...
});