Nano Particle Matrix

    strapi-provider-email-sendgrid

    3.6.11 • Public • Published

    strapi-provider-email-sendgrid


    Deprecation Warning ⚠️

    Hello! We have some news to share,

    We’ve decided it’ll soon be time to end the support for strapi-provider-email-sendgrid.

    After years of iterations, Strapi is going to V4 and we won’t maintain V3 packages when it’ll reach its end-of-support milestone (~end of Q3 2022).

    If you’ve been using strapi-provider-email-sendgrid and have migrated to V4 (or if you want to), you can find the equivalent and updated version of this package at this URL and with the following name on NPM: @strapi/provider-email-sendgrid.

    If you’ve contributed to the development of this package, thank you again for that! We hope to see you on the V4 soon.

    The Strapi team


    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

    ⚠️ 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: {
        provider: 'sendgrid',
        providerOptions: {
          apiKey: env('SENDGRID_API_KEY'),
        },
        settings: {
          defaultFrom: 'myemail@protonmail.com',
          defaultReplyTo: 'myemail@protonmail.com',
        },
      },
      // ...
    });

    Install

    npm i strapi-provider-email-sendgrid

    Homepage

    strapi.io

    DownloadsWeekly Downloads

    1,795

    Version

    3.6.11

    License

    SEE LICENSE IN LICENSE

    Unpacked Size

    6.76 kB

    Total Files

    4

    Last publish

    Collaborators

    • alexandrebodin
    • aurelsicoko
    • pierreburgy
    • lauriejim
    • hichamelbsi
    • petersg83
    • convly