mail_plugger 1.0.0.beta1 → 1.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8f511638e18d76bc9e3c85d7fc7b0869765e64116b1118558560ed6b87eae69
-  data.tar.gz: 673381bb010b20fdba29dab25ed09b2dccb6c5b2c95e44a90e0f3524d75b40bc
+  metadata.gz: c47f868eab003c41513627ce740e0d61ab9628a97ba4fd896181254ce957ad92
+  data.tar.gz: 5212e247ab3e9372e10c403edd9d680109e67aa07cf07d2cb2e2d92a3a2d8b59
 SHA512:
-  metadata.gz: b566e670154a0ffdd282b0d9ebaf297e797fb687e3192ddcea92e3e3810edc5f82b180cab8a57e469929f1fd531b3e217dc2b7990840277af7fbc9a731c92ee0
-  data.tar.gz: 21c9c007a6923fa03f5b5e1f536ad2a7ec2ff64d323c37e3ba3404ebeb3eef46350d29d1ec16de5935992f77d18ba2ff53b46413ade6f25fde5991059b032b7a
+  metadata.gz: d79e80294fffb6b85ad0cb7838b03595d1c695d058feea40640d677e93609095a3b3162d95a2918798c8afc07b8e7d828f79b03019410fd59136d20fce904de8
+  data.tar.gz: 401581be7d293bf54d5e133a65d8b793dbf31c36823a96c7080b5f6f3e965f376b9e84c7296272241f245832d665b6c7ca437a86fac9ea55ee7e150bb087cad4

data/.rubocop.yml

@@ -15,6 +15,9 @@ Metrics/BlockLength:
   Exclude:
     - spec/**/*
 
+Metrics/CyclomaticComplexity:
+  Max: 15
+
 Metrics/MethodLength:
   Max: 20
 

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Change log
 
+## 1.0.0.rc1 (2021-01-13)
+
+* Change description and fix changelog_uri in gemspec file.
+* Add/Change documentations.
+* Update gems.
+* Change `MailPlugger.plug_in` and `MailPlugger::MailHelper.delivery_options` methods to accept strings and symbols.
+* Change `MailPlugger::MailHelper.delivery_data` method that we can retrieve massage object as well.
+* Check hash keys in `MailPlugger::MailHelper.delivery_system` method, so now if we are add wrong `delivey_system` then we are getting a meaningful error message.
+* Change `MailPlugger::MailHelper.extract_attachments` method. If an attachment is inline then the hash contains the `filename` and `cid` as well.
+* Add/Change tests.
+* Change `MailPlugger::MailHelper.delivery_option` that returns with indifferent hash
+
 ## 1.0.0.beta1 (2021-01-02)
 
 * Implement MailPlugger methods and functionality. See [README.md](https://github.com/norbertszivos/mail_plugger/blob/main/README.md)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mail_plugger (1.0.0.beta1)
+    mail_plugger (1.0.0.rc1)
       mail (~> 2.5)
 
 GEM
@@ -43,16 +43,16 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.1)
-    rubocop (1.7.0)
+    rubocop (1.8.0)
       parallel (~> 1.10)
-      parser (>= 2.7.1.5)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
       rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (1.3.0)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.0)
       parser (>= 2.7.1.5)
     rubocop-performance (1.9.2)
       rubocop (>= 0.90.0, < 2.0)
@@ -61,14 +61,14 @@ GEM
       rubocop (~> 1.0)
       rubocop-ast (>= 1.1.0)
     ruby-progressbar (1.11.0)
-    simplecov (0.20.0)
+    simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.2)
     thor (1.0.1)
-    unicode-display_width (1.7.0)
+    unicode-display_width (2.0.0)
     webmock (3.11.0)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
@@ -89,4 +89,4 @@ DEPENDENCIES
   webmock (~> 3.0)
 
 BUNDLED WITH
-   2.2.3
+   2.2.4

data/README.md

@@ -1,5 +1,7 @@
 # M<img src="https://github.com/norbertszivos/mail_plugger/blob/main/images/mail_plugger.png" height="25" />ilPlugger
 
+[![Gem Version](https://badge.fury.io/rb/mail_plugger.svg)](https://badge.fury.io/rb/mail_plugger)
+[![MIT license](https://img.shields.io/badge/license-MIT-brightgreen)](LICENSE.txt)
 [![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop-hq/rubocop)
 [![Build Status](https://travis-ci.com/norbertszivos/mail_plugger.svg?branch=main)](https://travis-ci.com/norbertszivos/mail_plugger)
 [![Maintainability](https://api.codeclimate.com/v1/badges/bd2cda43214c111d8d16/maintainability)](https://codeclimate.com/github/norbertszivos/mail_plugger/maintainability)
@@ -25,9 +27,20 @@ Or install it yourself as:
 
 ## Usage
 
-[Use MailPlugger in a Ruby script or IRB console](https://github.com/norbertszivos/mail_plugger/blob/main/docs/usage_in_script_or_console.md)
-
-[Use MailPlugger in Ruby on Rails](https://github.com/norbertszivos/mail_plugger/blob/main/docs/usage_in_ruby_on_rails.md)
+- [How to use MailPlugger.plug_in method](https://github.com/norbertszivos/mail_plugger/blob/main/docs/usage_of_plug_in_method.md)
+- [How to use MailPlugger::DeliveryMethod class](https://github.com/norbertszivos/mail_plugger/blob/main/docs/usage_of_delivery_method.md)
+- [How to use MailPlugger in a Ruby script or IRB console](https://github.com/norbertszivos/mail_plugger/blob/main/docs/usage_in_script_or_console.md)
+- [How to use MailPlugger in Ruby on Rails](https://github.com/norbertszivos/mail_plugger/blob/main/docs/usage_in_ruby_on_rails.md)
+  - [How to add API specific options to the mailer method in Ruby on Rails](https://github.com/norbertszivos/mail_plugger/blob/main/docs/usage_of_secial_options_in_ruby_on_rails.md)
+  - [How to add attachments to the mailer method in Ruby on Rails](https://github.com/norbertszivos/mail_plugger/blob/main/docs/usage_of_attachments_in_ruby_on_rails.md)
+  - [How to use more delivey systems in Ruby on Rails](https://github.com/norbertszivos/mail_plugger/blob/main/docs/usage_of_more_delivery_system_in_ruby_on_rails.md)
+  - [How to use one delivey system with more send methods in Ruby on Rails](https://github.com/norbertszivos/mail_plugger/blob/main/docs/usage_of_one_delivery_system_with_more_send_methods_in_ruby_on_rails.md)
+  - [How to use AWS SES with MailPlugger in Ruby on Rails](https://github.com/norbertszivos/mail_plugger/blob/main/docs/usage_of_aws_ses_in_ruby_on_rails.md)
+  - [How to use SparkPost with MailPlugger in Ruby on Rails](https://github.com/norbertszivos/mail_plugger/blob/main/docs/usage_of_sparkpost_in_ruby_on_rails.md)
+  - [How to use SendGrid with MailPlugger in Ruby on Rails](https://github.com/norbertszivos/mail_plugger/blob/main/docs/usage_of_sendgrid_in_ruby_on_rails.md)
+  - [How to use Mandrill with MailPlugger in Ruby on Rails](https://github.com/norbertszivos/mail_plugger/blob/main/docs/usage_of_mandrill_in_ruby_on_rails.md)
+  - [How to use Postmark with MailPlugger in Ruby on Rails](https://github.com/norbertszivos/mail_plugger/blob/main/docs/usage_of_postmark_in_ruby_on_rails.md)
+  - [How to use Mailgun with MailPlugger in Ruby on Rails](https://github.com/norbertszivos/mail_plugger/blob/main/docs/usage_of_mailgun_in_ruby_on_rails.md)
 
 ## Development
 

data/docs/usage_in_ruby_on_rails.md

@@ -1,4 +1,4 @@
-## Use MailPlugger in Ruby on Rails
+# How to use MailPlugger in Ruby on Rails
 
 After to add `mail_plugger` gem and the gem of API of the mail provider, create `config/initializers/mail_plugger.rb` file and add something similar.
 
@@ -95,7 +95,7 @@ TestMailer.send_test.deliver_now
 #  Rendered test_mailer/send_test.text.erb within layouts/mailer (0.5ms)
 #TestMailer#send_test: processed outbound mail in 62.2ms
 # >>> settings: {:api_key=>"12345"}
-# >>> options: {:from=>["from@example.com"], :to=>["to@example.com"], :subject=>"Test email", :text_part=>"Test email body\n\n", :html_part=>"<!DOCTYPE html>\n<html>\n  <head>\n    <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n    <style>\n      /* Email styles need to be inline */\n    </style>\n  </head>\n\n  <body>\n    <p>Test email body</p>\n\n  </body>\n</html>\n"}
+# >>> options: {"from"=>["from@example.com"], "to"=>["to@example.com"], "subject"=>"Test email", "text_part"=>"Test email body\n\n", "html_part"=>"<!DOCTYPE html>\n<html>\n  <head>\n    <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n    <style>\n      /* Email styles need to be inline */\n    </style>\n  </head>\n\n  <body>\n    <p>Test email body</p>\n\n  </body>\n</html>\n"}
 # >>> generate_mail_hash: {:to=>[{:email=>"to@example.com"}], :from=>{:email=>"from@example.com"}, :subject=>"Test email", :content=>[{:type=>"text/plain", :value=>"Test email body\n\n"}, {:type=>"text/html; charset=UTF-8", :value=>"<!DOCTYPE html>\n<html>\n  <head>\n    <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n    <style>\n      /* Email styles need to be inline */\n    </style>\n  </head>\n\n  <body>\n    <p>Test email body</p>\n\n  </body>\n</html>\n"}]}
 #Sent mail to to@example.com (12.2ms)
 #Date: Sat, 02 Jan 2021 15:08:53 +0100
@@ -151,7 +151,7 @@ TestMailer.send_test.deliver_now!
 #  Rendered test_mailer/send_test.text.erb within layouts/mailer (0.0ms)
 #TestMailer#send_test: processed outbound mail in 20.9ms
 # >>> settings: {:api_key=>"12345"}
-# >>> options: {:from=>["from@example.com"], :to=>["to@example.com"], :subject=>"Test email", :text_part=>"Test email body\n\n", :html_part=>"<!DOCTYPE html>\n<html>\n  <head>\n    <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n    <style>\n      /* Email styles need to be inline */\n    </style>\n  </head>\n\n  <body>\n    <p>Test email body</p>\n\n  </body>\n</html>\n"}
+# >>> options: {"from"=>["from@example.com"], "to"=>["to@example.com"], "subject"=>"Test email", "text_part"=>"Test email body\n\n", "html_part"=>"<!DOCTYPE html>\n<html>\n  <head>\n    <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n    <style>\n      /* Email styles need to be inline */\n    </style>\n  </head>\n\n  <body>\n    <p>Test email body</p>\n\n  </body>\n</html>\n"}
 # >>> generate_mail_hash: {:to=>[{:email=>"to@example.com"}], :from=>{:email=>"from@example.com"}, :subject=>"Test email", :content=>[{:type=>"text/plain", :value=>"Test email body\n\n"}, {:type=>"text/html; charset=UTF-8", :value=>"<!DOCTYPE html>\n<html>\n  <head>\n    <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n    <style>\n      /* Email styles need to be inline */\n    </style>\n  </head>\n\n  <body>\n    <p>Test email body</p>\n\n  </body>\n</html>\n"}]}
 #=> #<Mail::Message:61140, Multipart: true, Headers: <From: from@example.com>, <To: to@example.com>, <Subject: Test email>, <Mime-Version: 1.0>, <Content-Type: multipart/alternative; boundary="--==_mimepart_5ff082bd7aab5_10afcebb4503a4"; charset=UTF-8>>
 ```
@@ -176,7 +176,7 @@ TestMailer.send_test.deliver_now!
 #  Rendered test_mailer/send_test.text.erb within layouts/mailer (0.4ms)
 #TestMailer#send_test: processed outbound mail in 37.0ms
 # >>> settings: {:api_key=>"12345"}
-# >>> options: {:from=>["from@example.com"], :to=>["to@example.com"], :subject=>"Test email", :text_part=>"Test email body\n\n", :html_part=>"<!DOCTYPE html>\n<html>\n  <head>\n    <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n    <style>\n      /* Email styles need to be inline */\n    </style>\n  </head>\n\n  <body>\n    <p>Test email body</p>\n\n  </body>\n</html>\n"}
+# >>> options: {"from"=>["from@example.com"], "to"=>["to@example.com"], "subject"=>"Test email", "text_part"=>"Test email body\n\n", "html_part"=>"<!DOCTYPE html>\n<html>\n  <head>\n    <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n    <style>\n      /* Email styles need to be inline */\n    </style>\n  </head>\n\n  <body>\n    <p>Test email body</p>\n\n  </body>\n</html>\n"}
 # >>> generate_mail_hash: {:to=>[{:email=>"to@example.com"}], :from=>{:email=>"from@example.com"}, :subject=>"Test email", :content=>[{:type=>"text/plain", :value=>"Test email body\n\n"}, {:type=>"text/html; charset=UTF-8", :value=>"<!DOCTYPE html>\n<html>\n  <head>\n    <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n    <style>\n      /* Email styles need to be inline */\n    </style>\n  </head>\n\n  <body>\n    <p>Test email body</p>\n\n  </body>\n</html>\n"}]}
 #=> {:response=>"OK"}
 ```

data/docs/usage_in_script_or_console.md

@@ -1,4 +1,4 @@
-## Use MailPlugger in a Ruby script or IRB console
+# How to use MailPlugger in a Ruby script or IRB console
 
 First you should be able to `require 'mail'` and `require 'mail_plugger'` to get started.
 
@@ -61,7 +61,7 @@ message = Mail.new(from: 'from@example.com', to: 'to@example.com', subject: 'Tes
 
 MailPlugger::DeliveryMethod.new.deliver!(message)
 # >>> settings: {:api_key=>"12345"}
-# >>> options: {:from=>["from@example.com"], :to=>["to@example.com"], :subject=>"Test email", :body=>"Test email body"}
+# >>> options: {"from"=>["from@example.com"], "to"=>["to@example.com"], "subject"=>"Test email", "body"=>"Test email body"}
 # >>> generate_mail_hash: {:to=>[{:email=>"to@example.com"}], :from=>{:email=>"from@example.com"}, :subject=>"Test email", :content=>[{:type=>"text/plain", :value=>"Test email body"}]}
 # => {:response=>"OK"}
 ```
@@ -74,7 +74,7 @@ message = Mail.new(from: 'from@example.com', to: 'to@example.com', subject: 'Tes
 
 MailPlugger::DeliveryMethod.new(delivery_options: %i[from to subject body], client: TestApiClientClass).deliver!(message)
 # >>> settings: {:api_key=>"12345"}
-# >>> options: {:from=>["from@example.com"], :to=>["to@example.com"], :subject=>"Test email", :body=>"Test email body"}
+# >>> options: {"from"=>["from@example.com"], "to"=>["to@example.com"], "subject"=>"Test email", "body"=>"Test email body"}
 # >>> generate_mail_hash: {:to=>[{:email=>"to@example.com"}], :from=>{:email=>"from@example.com"}, :subject=>"Test email", :content=>[{:type=>"text/plain", :value=>"Test email body"}]}
 # => {:response=>"OK"}
 ```
@@ -90,7 +90,7 @@ mail.delivery_method MailPlugger::DeliveryMethod, { delivery_options: %i[from to
 
 mail.deliver
 # >>> settings: {:api_key=>"12345"}
-# >>> options: {:from=>["from@example.com"], :to=>["to@example.com"], :subject=>"Test email", :body=>"Test email body"}
+# >>> options: {"from"=>["from@example.com"], "to"=>["to@example.com"], "subject"=>"Test email", "body"=>"Test email body"}
 # >>> generate_mail_hash: {:to=>[{:email=>"to@example.com"}], :from=>{:email=>"from@example.com"}, :subject=>"Test email", :content=>[{:type=>"text/plain", :value=>"Test email body"}]}
 # => #<Mail::Message:1960, Multipart: false, Headers: <From: from@example.com>, <To: to@example.com>, <Subject: Test email>>
 
@@ -98,7 +98,7 @@ mail.deliver
 
 mail.deliver!
 # >>> settings: {:api_key=>"12345"}
-# >>> options: {:from=>["from@example.com"], :to=>["to@example.com"], :subject=>"Test email", :body=>"Test email body"}
+# >>> options: {"from"=>["from@example.com"], "to"=>["to@example.com"], "subject"=>"Test email", "body"=>"Test email body"}
 # >>> generate_mail_hash: {:to=>[{:email=>"to@example.com"}], :from=>{:email=>"from@example.com"}, :subject=>"Test email", :content=>[{:type=>"text/plain", :value=>"Test email body"}]}
 # => #<Mail::Message:1960, Multipart: false, Headers: <From: from@example.com>, <To: to@example.com>, <Subject: Test email>>
 ```
@@ -114,7 +114,7 @@ mail.delivery_method MailPlugger::DeliveryMethod, { delivery_options: %i[from to
 
 mail.deliver
 # >>> settings: {:api_key=>"12345"}
-# >>> options: {:from=>["from@example.com"], :to=>["to@example.com"], :subject=>"Test email", :body=>"Test email body"}
+# >>> options: {"from"=>["from@example.com"], "to"=>["to@example.com"], "subject"=>"Test email", "body"=>"Test email body"}
 # >>> generate_mail_hash: {:to=>[{:email=>"to@example.com"}], :from=>{:email=>"from@example.com"}, :subject=>"Test email", :content=>[{:type=>"text/plain", :value=>"Test email body"}]}
 # => #<Mail::Message:1960, Multipart: false, Headers: <From: from@example.com>, <To: to@example.com>, <Subject: Test email>>
 
@@ -122,7 +122,7 @@ mail.deliver
 
 mail.deliver!
 # >>> settings: {:api_key=>"12345"}
-# >>> options: {:from=>["from@example.com"], :to=>["to@example.com"], :subject=>"Test email", :body=>"Test email body"}
+# >>> options: {"from"=>["from@example.com"], "to"=>["to@example.com"], "subject"=>"Test email", "body"=>"Test email body"}
 # >>> generate_mail_hash: {:to=>[{:email=>"to@example.com"}], :from=>{:email=>"from@example.com"}, :subject=>"Test email", :content=>[{:type=>"text/plain", :value=>"Test email body"}]}
 # => {:response=>"OK"}
 ```
@@ -144,7 +144,7 @@ mail.delivery_method MailPlugger::DeliveryMethod
 
 mail.deliver
 # >>> settings: {:api_key=>"12345"}
-# >>> options: {:from=>["from@example.com"], :to=>["to@example.com"], :subject=>"Test email", :body=>"Test email body"}
+# >>> options: {"from"=>["from@example.com"], "to"=>["to@example.com"], "subject"=>"Test email", "body"=>"Test email body"}
 # >>> generate_mail_hash: {:to=>[{:email=>"to@example.com"}], :from=>{:email=>"from@example.com"}, :subject=>"Test email", :content=>[{:type=>"text/plain", :value=>"Test email body"}]}
 # => #<Mail::Message:1960, Multipart: false, Headers: <From: from@example.com>, <To: to@example.com>, <Subject: Test email>>
 
@@ -152,7 +152,7 @@ mail.deliver
 
 mail.deliver!
 # >>> settings: {:api_key=>"12345"}
-# >>> options: {:from=>["from@example.com"], :to=>["to@example.com"], :subject=>"Test email", :body=>"Test email body"}
+# >>> options: {"from"=>["from@example.com"], "to"=>["to@example.com"], "subject"=>"Test email", "body"=>"Test email body"}
 # >>> generate_mail_hash: {:to=>[{:email=>"to@example.com"}], :from=>{:email=>"from@example.com"}, :subject=>"Test email", :content=>[{:type=>"text/plain", :value=>"Test email body"}]}
 # => {:response=>"OK"}
 ```

data/docs/usage_of_attachments_in_ruby_on_rails.md

@@ -0,0 +1,110 @@
+# How to add attachments to the mailer method in Ruby on Rails
+
+Let's use mailer method which was defined [here](https://github.com/norbertszivos/mail_plugger/blob/main/docs/usage_in_ruby_on_rails.md).
+
+Change the API and `MailPlugger.plug_in` method in `config/initializers/mail_plugger.rb`.
+
+```ruby
+# NOTE: This is just an example for testing...
+class TestApiClientClass
+  def initialize(options = {})
+    @settings = { api_key: '12345' }
+    @options = options
+  end
+
+  def deliver
+    # e.g. API.new(@settings).client.post(generate_mail_hash)
+    puts " >>> settings: #{@settings.inspect}"
+    puts " >>> options: #{@options.inspect}"
+    puts " >>> generate_mail_hash: #{generate_mail_hash.inspect}"
+    { response: 'OK' }
+  end
+
+  private
+
+  def generate_mail_hash
+    {
+      to: generate_recipients,
+      from: {
+        email: @options[:from].first
+      },
+      subject: @options[:subject],
+      content: [
+        {
+          type: 'text/plain',
+          value: @options[:text_part]
+        },
+        {
+          type: 'text/html; charset=UTF-8',
+          value: @options[:html_part]
+        }
+      ],
+      attachments: generate_attachments
+    }
+  end
+
+  def generate_recipients
+    @options[:to].map do |to|
+      {
+        email: to
+      }
+    end
+  end
+
+  def generate_attachments
+    @options[:attachments].map do |attachment|
+      hash = {
+          filename: attachment[:filename],
+          type: attachment[:type],
+          content: attachment[:content]
+        }
+      hash.merge!(content_id: attachment[:cid]) if attachment.has_key?(:cid)
+
+      hash
+    end
+  end
+end
+
+MailPlugger.plug_in('test_api_client') do |api|
+  api.delivery_options = %i[from to subject text_part html_part attachments]
+  api.delivery_settings = { return_response: true }
+  api.client = TestApiClientClass
+end
+```
+
+Let's change `app/mailers/test_mailer.rb` file.
+
+```ruby
+class TestMailer < ApplicationMailer
+  default from: 'from@example.com'
+
+  def send_test
+    attachments['image1.png'] = File.read('/path/to/image1.png')
+    attachments.inline['image2.png'] = File.read('/path/to/image2.png')
+
+    mail subject: 'Test email', to: 'to@example.com'
+  end
+end
+```
+
+Then change `app/views/test_mailer/send_test.html.erb` and add inline attachment.
+
+```erb
+<p>Test email body</p>
+<%= image_tag attachments['image2.png'].url %>
+```
+
+In the `rails console` we can try it out.
+
+```ruby
+TestMailer.send_test.deliver_now!
+#  Rendering test_mailer/send_test.html.erb within layouts/mailer
+#  Rendered test_mailer/send_test.html.erb within layouts/mailer (4.6ms)
+#  Rendering test_mailer/send_test.text.erb within layouts/mailer
+#  Rendered test_mailer/send_test.text.erb within layouts/mailer (0.3ms)
+#TestMailer#send_test: processed outbound mail in 47.5ms
+# >>> settings: {:api_key=>"12345"}
+# >>> options: {"from"=>["from@example.com"], "to"=>["to@example.com"], "subject"=>"Test email", "text_part"=>"Test email body\n\n", "html_part"=>"<!DOCTYPE html>\n<html>\n  <head>\n    <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n    <style>\n      /* Email styles need to be inline */\n    </style>\n  </head>\n\n  <body>\n    <p>Test email body</p>\n<img src=\"cid:5ffdd449d282a_163e2ef9c62c0@server.local.mail\" />\n\n  </body>\n</html>\n", "attachments"=>[{"filename"=>"image1.png", "type"=>"image/png", "content"=>"iVBORw0KGgoAAAANSUhEUgAAALQAAABdCAMAAAA7WLggg==\n"}, {"cid"=>"5ffdd449d282a_163e2ef9c62c0@server.local.mail", "filename"=>"image2.png", "type"=>"image/png", "content"=>"iVBORw0KGgoAAAANSUhEUgAAAAggg==\n"}]}
+# >>> generate_mail_hash: {:to=>[{:email=>"to@example.com"}], :from=>{:email=>"from@example.com"}, :subject=>"Test email", :content=>[{:type=>"text/plain", :value=>"Test email body\n\n"}, {:type=>"text/html; charset=UTF-8", :value=>"<!DOCTYPE html>\n<html>\n  <head>\n    <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n    <style>\n      /* Email styles need to be inline */\n    </style>\n  </head>\n\n  <body>\n    <p>Test email body</p>\n<img src=\"cid:5ffdd449d282a_163e2ef9c62c0@server.local.mail\" />\n\n  </body>\n</html>\n"}], :attachments=>[{:filename=>"image1.png", :type=>"image/png", :content=>"iVBORw0KGgoAAAANSUhEUgAAALQAAABdCAMAAAA7WLggg==\n"}, {:filename=>"image2.png", :type=>"image/png", :content=>"iVBORw0KGgoAAAANSUhEUgAAAAggg==\n", :content_id=>"5ffdd449d282a_163e2ef9c62c0@server.local.mail"}]}
+#=> {:response=>"OK"}
+```

data/docs/usage_of_aws_ses_in_ruby_on_rails.md

@@ -0,0 +1,136 @@
+# How to use AWS SES with MailPlugger in Ruby on Rails
+
+**Please note that these examples were not tested, but I believe it should work.**
+
+Let's use mailer method which was defined [here](https://github.com/norbertszivos/mail_plugger/blob/main/docs/usage_in_ruby_on_rails.md).
+
+Add `aws-sdk-gem` to the `Gemfile`.
+
+```ruby
+gem 'aws-sdk-ses'
+```
+
+Then run `bundle install` command to deploy the gem.
+
+## Send Email
+
+Change the API and `MailPlugger.plug_in` method in `config/initializers/mail_plugger.rb`.
+
+```ruby
+class AwsSesApiClient
+  def initialize(options = {})
+    @credentials = Aws::Credentials.new(ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'])
+    @region = ENV['AWS_DEFAULT_REGION']
+    @options = options
+  end
+
+  def deliver
+    Aws::SES::Client.new(credentials: @credentials, region: @region).send_email(generate_mail_hash)
+  end
+
+  private
+
+  def generate_mail_hash
+    {
+      source: @options[:from].first,
+      destination: {
+        to_addresses: @options[:to]
+      },
+      message: {
+        subject: {
+          charset: 'UTF-8',
+          data: @options[:subject]
+        },
+        body: {
+          text: {
+            charset: 'UTF-8',
+            data: @options[:text_part]
+          },
+          html: {
+            charset: 'UTF-8',
+            data: @options[:html_part]
+          }
+        }
+      },
+      tags: [
+        {
+          name: @options[:message_obj].delivery_handler.to_s,
+          value: @options[:tag]
+        }
+      ],
+      configuration_set_name: @options[:configuration_set_name]
+    }
+  end
+end
+
+MailPlugger.plug_in('aws_ses') do |api|
+  api.delivery_options = %i[from to subject text_part html_part message_obj tag configuration_set_name]
+  api.delivery_settings = { return_response: true }
+  api.client = AwsSesApiClient
+end
+```
+
+Then modify the mailer method a little bit.
+
+```ruby
+class TestMailer < ApplicationMailer
+  default from: 'from@example.com'
+
+  def send_test
+    mail subject: 'Test email', to: 'to@example.com', delivery_system: 'aws_ses', tag: 'send_test', configuration_set_name: "#{Rails.env}_events_tracking"
+  end
+end
+```
+
+## Send Raw Email
+
+Change the API and `MailPlugger.plug_in` method in `config/initializers/mail_plugger.rb`.
+
+```ruby
+class AwsSesApiClient
+  def initialize(options = {})
+    @credentials = Aws::Credentials.new(ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'])
+    @region = ENV['AWS_DEFAULT_REGION']
+    @options = options
+  end
+
+  def deliver
+    Aws::SES::Client.new(credentials: @credentials, region: @region).send_raw_email(generate_mail_hash)
+  end
+
+  private
+
+  def generate_mail_hash
+    {
+      raw_message: {
+        data: @options[:message_obj].to_s
+      },
+      tags: [
+        {
+          name:  @options[:message_obj].delivery_handler.to_s,
+          value: @options[:tag]
+        }
+      ],
+      configuration_set_name: @options[:configuration_set_name]
+    }
+  end
+end
+
+MailPlugger.plug_in('aws_ses') do |api|
+  api.delivery_options = %i[message_obj tag configuration_set_name]
+  api.delivery_settings = { return_response: true }
+  api.client = AwsSesApiClient
+end
+```
+
+Then modify the mailer method a little bit.
+
+```ruby
+class TestMailer < ApplicationMailer
+  default from: 'from@example.com'
+
+  def send_test
+    mail subject: 'Test email', to: 'to@example.com', delivery_system: 'aws_ses', tag: 'send_test', configuration_set_name: "#{Rails.env}_events_tracking"
+  end
+end
+```