Strapi plugin logo for SendGrid

SendGrid
Made by Strapi badge
Made by Strapi

SendGrid provider for Strapi

@strapi/provider-email-sendgrid

Resources

Links

Installation

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

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

Configuration

VariableTypeDescriptionRequiredDefault
providerstringThe name of the provider you useyes
providerOptionsobjectProvider optionsyes
providerOptions.apiKeyobjectApi key given to the function setApiKey. Please refer to @sendgrid/mailyes
settingsobjectSettingsno{}
settings.defaultFromstringDefault sender mail addressnoundefined
settings.defaultReplyTostring | arrayDefault address or addresses the receiver is asked to reply tonoundefined

: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

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

Install now

npm install @strapi/provider-email-sendgrid

Last updated

8 days ago

Strapi Version

Supports V3

Author

github profile image for Strapi Solutions SAS
Strapi Solutions SAS

Related plugin

Email

Useful links