Back to Strapi

@strapi/provider-email-amazon-ses

packages/providers/email-amazon-ses/README.md

5.45.02.6 KB
Original Source

@strapi/provider-email-amazon-ses

Resources

Installation

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

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

Configuration

VariableTypeDescriptionRequiredDefault
providerstringThe name of the provider you useyes
providerOptionsobjectWill be directly given to createClient function. Please refer to node-ses doc.yes
settingsobjectSettingsno{}
settings.defaultFromstringDefault sender mail addressnoundefined
settings.defaultReplyTostring | array<string>Default 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

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: '[email protected]',
        defaultReplyTo: '[email protected]',
      },
    },
  },
  // ...
});

Path - .env

env
AWS_SES_KEY=
AWS_SES_SECRET=
AWS_SES_REGION=