aws-actionmailer-ses 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5155bf8bc7c5caf160e77e7768a0029fe7514e7d33d9ab14544072e64bb96cf
-  data.tar.gz: a281ec02f365a903eade4ef008fde838b5748100211b3e2fa37aac1909d9dcff
+  metadata.gz: e84d63cd92cc606c4436f3f34e07e79c422b3a46f05b405ae7f2b774431781f1
+  data.tar.gz: b02a20505f08ecc019dd160be181eafb9b1a64567bc7abce2f8a9b26c06e631f
 SHA512:
-  metadata.gz: c865beacd6615da65f966d7e89cf145bf301d72babec69915c7a1e74c277048d2005c86634857156f71088a37898623c8349a90f5cddd77ce20c1a38735f9ae3
-  data.tar.gz: 2d4ebed009cc45470df4b4ab9c2258dbc8737ec00b885c34abc7b0f570165cb26f01b597c737e4cef5b206563442333f1bc02c2fac4725b78a8a7a23648e68ab
+  metadata.gz: fee74b70ebd190204cb83abd71e6e04b04f1495dc40f36b68fc746eaebb0c35feb48d681fb89bc185000c4c9aca48333882bf454889a8aed0cf2318f522a043e
+  data.tar.gz: 58692d241e18004f35b1054ceb9f28c73defb91e7f807e01dd464edde5c79bb3196bc1d9dff82bf2d2a0049df5c6e6560ac35fa238c86289691f88b13c5e3d53

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+1.2.0 (2026-05-21)
+------------------
+
+* Feature - Add support for `configuration_set_name` (#11), `email_tags` (#8), and `list_management_options` in SES V2 delivery settings.
+
+1.1.0 (2026-03-31)
+------------------
+
+* Feature - Support injecting a preconstructed client via `:ses_client` and `:sesv2_client` options.
+
 1.0.0 (2024-11-21)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.2.0

data/lib/aws/action_mailer/ses/mailer.rb

@@ -7,22 +7,31 @@ module Aws
     module SES
       # Provides a delivery method for ActionMailer that uses Amazon Simple Email Service.
       #
-      # Delivery settings are used to construct a new Aws::SES::Client instance.
+      # Delivery settings are used to construct a new `Aws::SES::Client` instance.
       # Once you have a delivery method, you can configure your Rails environment to use it:
       #
       #     config.action_mailer.delivery_method = :ses
       #     config.action_mailer.ses_settings = { region: 'us-west-2' }
       #
+      # Alternatively, you could pass the client itself.
+      #
+      # The passed in client will be prioritized regardless of other `:ses_settings` given.
+      #
       # @see https://guides.rubyonrails.org/action_mailer_basics.html
       class Mailer
         attr_reader :settings
 
-        # @param [Hash] settings Passes along initialization options to
-        #   [Aws::SES::Client.new](https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SES/Client.html#initialize-instance_method).
+        # @param [Hash] settings
+        #   Passes along initialization options to [Aws::SES::Client.new](https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SES/Client.html#initialize-instance_method).
+        #   You may pass `:ses_client` with a preconstructed {Aws::SES::Client} to reuse
+        #   an existing instance (e.g. to avoid credential resolution on every delivery).
+        #   When provided, the injected client is used and all other options are ignored.
         def initialize(settings = {})
           @settings = settings
-          @client = Aws::SES::Client.new(settings)
-          @client.config.user_agent_frameworks << 'aws-actionmailer-ses'
+          client_settings = settings.dup
+          @client = client_settings.delete(:ses_client) || Aws::SES::Client.new(client_settings)
+
+          update_user_agent
         end
 
         # Delivers a Mail::Message object. Called during mail delivery.
@@ -36,6 +45,14 @@ module Aws
             message.header[:ses_message_id] = response.message_id
           end
         end
+
+        private
+
+        def update_user_agent
+          return if @client.config.user_agent_frameworks.include?('aws-actionmailer-ses')
+
+          @client.config.user_agent_frameworks << 'aws-actionmailer-ses'
+        end
       end
     end
   end

data/lib/aws/action_mailer/ses_v2/mailer.rb

@@ -7,26 +7,77 @@ module Aws
     module SESV2
       # Provides a delivery method for ActionMailer that uses Amazon Simple Email Service V2.
       #
-      # Delivery settings are used to construct a new Aws::SESV2::Client instance.
       # Once you have a delivery method, you can configure your Rails environment to use it:
       #
       #     config.action_mailer.delivery_method = :ses_v2
       #     config.action_mailer.ses_v2_settings = { region: 'us-west-2' }
       #
+      # You may also pass a preconstructed client:
+      #
+      #     sesv2_client = Aws::SESV2::Client.new(region: 'us-west-2')
+      #     config.action_mailer.ses_v2_settings = { sesv2_client: sesv2_client }
+      #
+      # == SendEmail Options
+      #
+      # Settings in {SEND_EMAIL_KEYS} are forwarded directly to the
+      # {https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SESV2/Client.html#send_email-instance_method SendEmail}
+      # API call rather than to the client constructor. They can be configured at
+      # any level:
+      #
+      #     # Global (all emails)
+      #     config.action_mailer.ses_v2_settings = {
+      #       region: 'us-west-2',
+      #       configuration_set_name: 'Production'
+      #     }
+      #
+      #     # Per-mailer class
+      #     class MarketingMailer < ApplicationMailer
+      #       default delivery_method_options: {
+      #         configuration_set_name: 'Marketing',
+      #         list_management_options: { contact_list_name: 'Promos', topic_name: 'Weekly' }
+      #       }
+      #     end
+      #
       # @see https://guides.rubyonrails.org/action_mailer_basics.html
       class Mailer
+        SEND_EMAIL_KEYS = %i[
+          configuration_set_name
+          email_tags
+          list_management_options
+        ].freeze
+
         attr_reader :settings
 
-        # @param [Hash] settings Passes along initialization settings to
-        #   [Aws::SESV2::Client.new](https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SESV2/Client.html#initialize-instance_method).
+        # @param [Hash] settings
+        #   Passes along initialization settings to [Aws::SESV2::Client.new](https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SESV2/Client.html#initialize-instance_method).
+        #   You may pass `:sesv2_client` with a preconstructed {Aws::SESV2::Client} to reuse
+        #   an existing instance (e.g. to avoid credential resolution on every delivery).
+        #   When provided, the injected client is used and all other options are ignored.
+        #
+        #   The following keys are extracted from settings and forwarded as parameters
+        #   to the [SendEmail](https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SESV2/Client.html#send_email-instance_method)
+        #   API call (they are not passed to the client constructor):
+        #
+        #   * `:configuration_set_name` - The name of the configuration set to use for this message.
+        #   * `:email_tags` - A list of message tags ({Types::MessageTag} hashes).
+        #   * `:list_management_options` - A {Types::ListManagementOptions} hash for SES
+        #     subscription management.
+        #
         def initialize(settings = {})
           @settings = settings
-          @client = Aws::SESV2::Client.new(settings)
-          @client.config.user_agent_frameworks << 'aws-actionmailer-ses'
+          @send_email_params = {}
+          client_settings = settings.dup
+          SEND_EMAIL_KEYS.each do |key|
+            value = client_settings.delete(key)
+            @send_email_params[key] = value if value
+          end
+          @client = client_settings.delete(:sesv2_client) || Aws::SESV2::Client.new(client_settings)
+
+          update_user_agent
         end
 
         # Delivers a Mail::Message object. Called during mail delivery.
-        def deliver!(message)
+        def deliver!(message) # rubocop:disable Metrics/MethodLength
           params = { content: { raw: { data: message.to_s } } }
           params[:from_email_address] = from_email_address(message)
           params[:destination] = {
@@ -34,6 +85,7 @@ module Aws
             cc_addresses: message.cc,
             bcc_addresses: message.bcc
           }
+          params.merge!(@send_email_params)
 
           @client.send_email(params).tap do |response|
             message.header[:ses_message_id] = response.message_id
@@ -42,6 +94,12 @@ module Aws
 
         private
 
+        def update_user_agent
+          return if @client.config.user_agent_frameworks.include?('aws-actionmailer-ses')
+
+          @client.config.user_agent_frameworks << 'aws-actionmailer-ses'
+        end
+
         # smtp_envelope_from will default to the From address *without* sender names.
         # By omitting this param, SESv2 will correctly use sender names from the mail headers.
         # We should only use smtp_envelope_from when it was explicitly set (instance variable set)

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: aws-actionmailer-ses
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Amazon Web Services
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-21 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-ses
@@ -81,8 +80,10 @@ files:
 homepage: https://github.com/aws/aws-actionmailer-ses-ruby
 licenses:
 - Apache-2.0
-metadata: {}
-post_install_message:
+metadata:
+  source_code_uri: https://github.com/aws/aws-actionmailer-ses-ruby
+  changelog_uri: https://github.com/aws/aws-actionmailer-ses-ruby/blob/main/CHANGELOG.md
+  documentation_uri: https://docs.aws.amazon.com/sdk-for-ruby/aws-actionmailer-ses/api/
 rdoc_options: []
 require_paths:
 - lib
@@ -97,8 +98,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key:
+rubygems_version: 4.0.6
 specification_version: 4
 summary: ActionMailer integration with SES
 test_files: []