yujunjun/strapi
1
0
Fork 0
mirror of https://github.com/strapi/strapi.git synced 2025-07-24 09:25:25 +00:00
Code Issues Packages Projects Releases Wiki Activity
strapi/packages/providers/email-amazon-ses/README.md

2.6 KiB
Raw Permalink Blame History

@strapi/provider-email-amazon-ses

Resources

Links

Installation

# using yarn
yarn add @strapi/provider-email-amazon-ses

# using npm
npm install @strapi/provider-email-amazon-ses --save

Configuration

Variable Type Description Required Default
provider string The name of the provider you use yes
providerOptions object Will be directly given to createClient function. Please refer to node-ses doc. 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: 'amazon-ses',
      providerOptions: {
        key: env('AWS_SES_KEY'),
        secret: env('AWS_SES_SECRET'),
        amazon: `https://email.${env('AWS_SES_REGION', 'us-east-1')}.amazonaws.com`, // https://docs.aws.amazon.com/general/latest/gr/ses.html
      },
      settings: {
        defaultFrom: 'myemail@protonmail.com',
        defaultReplyTo: 'myemail@protonmail.com',
      },
    },
  },
  // ...
});

Path - .env

AWS_SES_KEY=
AWS_SES_SECRET=
AWS_SES_REGION=