mirror of
https://github.com/strapi/strapi.git
synced 2025-08-06 15:53:11 +00:00
strapi-provider-email-sendgrid
Resources
Links
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',
},
},
// ...
});