packages/providers/email-sendgrid/README.md
# using yarn
yarn add @strapi/provider-email-sendgrid
# using npm
npm install @strapi/provider-email-sendgrid --save
| 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<string> | Default address or addresses the receiver is asked to reply to | no | undefined |
:warning: The Shipper Email (or defaultfrom) may also need to be changed in the
Email Templatestab on the admin panel for emails to send properly
Path - config/plugins.js
module.exports = ({ env }) => ({
// ...
email: {
config: {
provider: 'sendgrid',
providerOptions: {
apiKey: env('SENDGRID_API_KEY'),
},
settings: {
defaultFrom: '[email protected]',
defaultReplyTo: '[email protected]',
},
},
},
// ...
});