JSPM

@strapi/provider-email-amazon-ses

0.0.0-next.614aaf36aaf7e94667b876f02949c3651d9715da
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 3814
  • Score
    100M100P100Q142111F
  • License SEE LICENSE IN LICENSE

Amazon SES provider for strapi email

Package Exports

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@strapi/provider-email-amazon-ses) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    @strapi/provider-email-amazon-ses

    Resources

    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.us-east-1.amazonaws.com',
          },
          settings: {
            defaultFrom: 'myemail@protonmail.com',
            defaultReplyTo: 'myemail@protonmail.com',
          },
        },
      },
      // ...
    });