aws-actionmailer-ses 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4fb4818425a87e651216f3e78bc6ce39ba3dd6c9974efff08c31c33ce81c4ab9
+  data.tar.gz: d4fedf6f6c76fa75753f8c57092909da068672f778dcf910c123c0b52c19d910
+SHA512:
+  metadata.gz: 436e8d83f48c8dad3457c642907af4094c961f764781a17907b6b69f0972255218b34e55d220afbc8b9844127af5bac74fa50254f79503a762a587f73b2e45cb
+  data.tar.gz: 7dd3b1eadad71f9e9241229c4e5d329e91d558868e1e48472d9a4ac2c09d8056b58e8c7a7d7ec6ee5c7e16cc81c94de6f8bfc8ab3d44a0ff152edf0e4aa670f6

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+0.1.0 (2024-11-16)
+------------------
+
+* Feature - Initial version of this gem.

data/LICENSE

@@ -0,0 +1,175 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.

data/VERSION

@@ -0,0 +1 @@
+0.1.0

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'aws-sdk-ses'
+
+module Aws
+  module ActionMailer
+    module SES
+      # Provides a delivery method for ActionMailer that uses Amazon Simple Email Service.
+      #
+      # Configure a delivery method with:
+      #
+      #     client_options = { region: 'us-west-2' }
+      #     ActionMailer::Base.add_delivery_method :ses, Aws::ActionMailer::SESMailer, **client_options
+      #
+      # Client options 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
+      #
+      # @see https://guides.rubyonrails.org/action_mailer_basics.html
+      class Mailer
+        # @param [Hash] options 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).
+        def initialize(options = {})
+          @client = Aws::SES::Client.new(options)
+          @client.config.user_agent_frameworks << 'aws-actionmailer-ses'
+        end
+
+        # Delivers a Mail::Message object. Called during mail delivery.
+        def deliver!(message)
+          params = {
+            raw_message: { data: message.to_s },
+            source: message.smtp_envelope_from, # defaults to From header
+            destinations: message.smtp_envelope_to # defaults to destinations (To,Cc,Bcc)
+          }
+          @client.send_raw_email(params).tap do |response|
+            message.header[:ses_message_id] = response.message_id
+          end
+        end
+
+        # @return [Hash]
+        def settings
+          {}
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require 'aws-sdk-sesv2'
+
+module Aws
+  module ActionMailer
+    module SESV2
+      # Provides a delivery method for ActionMailer that uses Amazon Simple Email Service V2.
+      #
+      # Configure a delivery method with:
+      #
+      #     client_options = { region: 'us-west-2' }
+      #     ActionMailer::Base.add_delivery_method :ses_v2, Aws::ActionMailer::SESV2Mailer, **client_options
+      #
+      # Client options 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
+      #
+      # @see https://guides.rubyonrails.org/action_mailer_basics.html
+      class Mailer
+        # @param [Hash] options Passes along initialization options to
+        #   [Aws::SESV2::Client.new](https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SESV2/Client.html#initialize-instance_method).
+        def initialize(options = {})
+          @client = Aws::SESV2::Client.new(options)
+          @client.config.user_agent_frameworks << 'aws-actionmailer-ses'
+        end
+
+        # Delivers a Mail::Message object. Called during mail delivery.
+        def deliver!(message)
+          params = { content: { raw: { data: message.to_s } } }
+          params[:from_email_address] = from_email_address(message)
+          params[:destination] = {
+            to_addresses: to_addresses(message),
+            cc_addresses: message.cc,
+            bcc_addresses: message.bcc
+          }
+
+          @client.send_email(params).tap do |response|
+            message.header[:ses_message_id] = response.message_id
+          end
+        end
+
+        # @return [Hash]
+        def settings
+          {}
+        end
+
+        private
+
+        # 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)
+        def from_email_address(message)
+          message.instance_variable_get(:@smtp_envelope_from) ? message.smtp_envelope_from : nil
+        end
+
+        # smtp_envelope_to will default to the full destinations (To, Cc, Bcc)
+        # SES v2 API prefers each component split out into a destination hash.
+        # When smtp_envelope_to was set, use it explicitly for to_address only.
+        def to_addresses(message)
+          message.instance_variable_get(:@smtp_envelope_to) ? message.smtp_envelope_to : message.to
+        end
+      end
+    end
+  end
+end

data/lib/aws-actionmailer-ses.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative 'aws/action_mailer/ses/mailer'
+require_relative 'aws/action_mailer/ses_v2/mailer'
+
+module Aws
+  module ActionMailer
+    module SES
+      VERSION = File.read(File.expand_path('../VERSION', __dir__)).strip
+    end
+
+    module SESV2
+      VERSION = File.read(File.expand_path('../VERSION', __dir__)).strip
+    end
+  end
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: aws-actionmailer-ses
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Amazon Web Services
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-11-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-ses
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.50.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.50.0
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-sesv2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.34.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.34.0
+- !ruby/object:Gem::Dependency
+  name: actionmailer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.0
+description: Amazon Simple Email Service as an ActionMailer delivery method
+email:
+- aws-dr-rubygems@amazon.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- VERSION
+- lib/aws-actionmailer-ses.rb
+- lib/aws/action_mailer/ses/mailer.rb
+- lib/aws/action_mailer/ses_v2/mailer.rb
+homepage: https://github.com/aws/aws-actionmailer-ses-ruby
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: ActionMailer integration with SES
+test_files: []