strapi/packages/providers/email-sendgrid

@strapi/provider-email-sendgrid

Resources

• LICENSE

Links

• Strapi website
• Strapi documentation
• Strapi community on Discord
• Strapi news on Twitter

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

⚠️ 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

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