mirror of
https://github.com/strapi/strapi.git
synced 2025-08-01 05:17:14 +00:00
59 lines
2.5 KiB
Markdown
59 lines
2.5 KiB
Markdown
# @strapi/provider-email-sendgrid
|
|
|
|
## Resources
|
|
|
|
- [LICENSE](LICENSE)
|
|
|
|
## Links
|
|
|
|
- [Strapi website](https://strapi.io/)
|
|
- [Strapi documentation](https://docs.strapi.io)
|
|
- [Strapi community on Discord](https://discord.strapi.io)
|
|
- [Strapi news on Twitter](https://twitter.com/strapijs)
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
# 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](https://www.npmjs.com/package/@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 Templates` tab on the admin panel for emails to send properly
|
|
|
|
### Example
|
|
|
|
**Path -** `config/plugins.js`
|
|
|
|
```js
|
|
module.exports = ({ env }) => ({
|
|
// ...
|
|
email: {
|
|
config: {
|
|
provider: 'sendgrid',
|
|
providerOptions: {
|
|
apiKey: env('SENDGRID_API_KEY'),
|
|
},
|
|
settings: {
|
|
defaultFrom: 'myemail@protonmail.com',
|
|
defaultReplyTo: 'myemail@protonmail.com',
|
|
},
|
|
},
|
|
},
|
|
// ...
|
|
});
|
|
```
|