dcidev_mailer 0.0.14 → 0.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94b1d88c260563186badc0465bfc8890f3402f5f6b6cf334b432ea7a0f0186d5
-  data.tar.gz: 264d2847649172adefe30a6ab9c4ff61ed02460fb52d049a4700083dfa74431c
+  metadata.gz: 9f17117f9022e28dd492ea92310d25c16211f02a04376178027b069d1fc61ad1
+  data.tar.gz: fed2751d446175a98589df0e56bc22a7eb3181fab2bac922b35e3d63cd9fc285
 SHA512:
-  metadata.gz: c5a9251a9254bebc521d0613b0e5d9b5fb660a2d158ae032879f8bca9185c6a88035df082dc07e9b5bc868c078cad8c714ca78de600d27a59506f9faacc75fa8
-  data.tar.gz: 82fa420736919b8bfc686827b8643b9c1b7a83a39e0f6e3ced387517aa2405f4f3344fa9f09cfc55ca862dbd3dceb338ebc2db67b41d0b758a9e626b4e599669
+  metadata.gz: a873c97823a43f7fe38e8bbde83e77f6061baaa443b91b9412594f59c9e75ce2a0ac78b07c2b72c307e08bd6fcfffc8e69df3141c53330ce2359f6ce4ad594c0
+  data.tar.gz: 2577fce86abfe175086a91e6d6e245a3aa4af91bd1e64b065f5470f4f6f8ec63138417aa91116353f9eaaf9df7a3e50ca062464b24448f4d1d5443d06e96d376

data/README.md

@@ -3,7 +3,12 @@ This gem uses both Mandrill API and ActionMailer to send email.
 
 # Setup
 
-Add this to your `.env`
+Install mandrill mailer gem
+```
+gem 'mandrill_mailer'
+```
+
+Add `.env` configurations
 ```env
 BASE_URL_FE=
 DEFAULT_EMAIL_SENDER= 
@@ -132,7 +137,6 @@ class MandrillMailer
                 from: ENV['DEFAULT_EMAIL_SENDER'],
                 from_name: ENV['DEFAULT_EMAIL_SENDER_NAME'],
                 attachments: attachments,
-                # specify template file location
             )
         rescue => e
             error_message = "[SEND EMAIL] " + e.try(:to_s)
@@ -164,11 +168,11 @@ class MortgageMailer
                     header_url: template.header.try(:url),  
                     footer_url: template.footer.try(:url),  
                     file_attachments: file_attachments,  
-                    to: customer.email,  
+                    to: "#{customer.name} <#{customer.email}>",  
                     cc: nil, # can be a string / array
-                    bcc: nil, # can be a string / array
+                    bcc: ["John Doe <john.doe@gmail.com>", "Michael <michael@gmail.com>"], # can be a string / array
                     subject: template.subject,  
-                    from: ENV['DEFAULT_EMAIL_SENDER'],  
+                    from: "#{ENV['DEFAULT_EMAIL_SENDER_NAME']} <#{ENV['DEFAULT_EMAIL_SENDER']}>",  
                     template_path: "mail/blast.html.erb"  # specify template file location
                 ).deliver_now!  
             rescue => e  
@@ -188,6 +192,36 @@ The attachment is an array of hashes containing attachment file and filename
 attachments = [{file: DcidevUtility.download_to_file(self.ktp.url), filename: self.reference_number}]
 ```
 
+### Inline Images
+`MandrillMailer` supports sending images in the html body. As for `RailsMailer`, it currently only supports header & footer image. Feel free to contact me if you need such feature.
+
+Since gmail do not support link-based image, you have to format the images as inline attachments and use CID (Content-ID) to display each of them. The gem automatically takes care of the programming. You only have to specify a valid link as the parameter.
+
+The example to set the image in the template is shown below. This method works for both `RailsMailer` and `MandrillMailer` so you only need to code once.
+```html
+          <%
+            header = attachments['header'].try(:url) || header
+            footer = attachments['footer'].try(:url) || footer
+          %>
+
+          <% if header.present? %>
+            <div id="header-section-img">
+
+              <img
+                src="<%= header %>"
+                alt="Header Image"
+                style="border-radius: 10px"
+                width="100%"
+                />
+
+            </div>
+          <% end %>
+```
+
+### Development tips for custom SMTP server
+Some clients dont allow our server to access their SMTP server. To avoid blind coding, you can develop using google SMTP server to make sure that your program woks perfectly.
+Refer to https://dev.to/morinoko/sending-emails-in-rails-with-action-mailer-and-gmail-35g4 for the tutorial.
+
 ### Helpers
 ```ruby
 # convert all image URL in <img src="url"> to <img src="cid:xxxx">

data/lib/dcidev_mailer/mandrill.rb

@@ -5,17 +5,17 @@ module DcidevMailer
         default from: ENV['DEFAULT_EMAIL_SENDER']
 
         class << self
-            def send_email(subject: '', html_body: '', to: nil, cc: nil, bcc: nil, from: nil, from_name: nil, attachments: nil, email_template_path: '', header_url: '', footer_url: '')
+            def send_email(subject: '', html_body: '', to: nil, cc: nil, bcc: nil, from: nil, from_name: nil, attachments: nil, email_template_path: '', header_url: '', footer_url: '', preserve_recipients: false)
                 ac = ActionController::Base.new
                 wording, images = DcidevMailer.format_image_from_html(html_body)
                 locals = { wording: wording, header: nil, footer: nil }
                 locals, images = DcidevMailer.format_header_footer(header_url: header_url, footer_url: footer_url, locals: locals, images: images) if header_url.present? && footer_url.present?
                 html_body = ac.render_to_string(template: email_template_path, locals: locals)
                 attachments = DcidevMailer.format_attachments(attachments) if attachments.present?
-                self.send_mail(subject, to, cc, bcc, html_body, attachments, images, from, from_name).deliver_now
+                self.send_mail(subject, to, cc, bcc, html_body, attachments, images, from, from_name, preserve_recipients).deliver_now
             end
 
-            def send_mail(subject, to, cc, bcc, html, attachments = nil, images = nil, from = nil, from_name = nil)
+            def send_mail(subject, to, cc, bcc, html, attachments = nil, images = nil, from = nil, from_name = nil, preserve_recipients)
                 mandrill_mail subject: subject,
                               from: from,
                               from_name: from_name,
@@ -29,7 +29,8 @@ module DcidevMailer
                               important: true,
                               inline_css: true,
                               attachments: attachments,
-                              images: images
+                              images: images,
+                              preserve_recipients: cc.present? || preserve_recipients
             end
         end
     end

data/lib/dcidev_mailer/mandrill_template.rb

@@ -5,14 +5,14 @@ module DcidevMailer
         default from: ENV['DEFAULT_EMAIL_SENDER']
 
         class << self
-            def send_email(subject: '', to: nil, cc: nil, bcc: nil, from: nil, from_name: nil, attachments: nil, vars: nil, template_name: nil, images: nil)
+            def send_email(subject: '', to: nil, cc: nil, bcc: nil, from: nil, from_name: nil, attachments: nil, vars: nil, template_name: nil, images: nil, preserve_recipients: false)
                 raise DcidevMailer::Errors::InvalidTemplate unless template_name.present?
                 images = DcidevMailer.format_images(images) if images.present?
                 attachments = DcidevMailer.format_attachments(attachments) if attachments.present?
-                self.send_mail(subject, to, cc, bcc, attachments, images, from, from_name, template_name, vars).deliver_now
+                self.send_mail(subject, to, cc, bcc, attachments, images, from, from_name, template_name, vars, preserve_recipients).deliver_now
             end
 
-            def send_mail(subject, to, cc, bcc, attachments = nil, images = nil, from = nil, from_name = nil, template_name = nil, vars = nil)
+            def send_mail(subject, to, cc, bcc, attachments = nil, images = nil, from = nil, from_name = nil, template_name = nil, vars = nil, preserve_recipients)
                 mandrill_mail subject: subject,
                               from: from,
                               from_name: from_name,
@@ -24,7 +24,8 @@ module DcidevMailer
                               attachments: attachments,
                               images: images,
                               template_name: template_name,
-                              vars: vars
+                              vars: vars,
+                              preserve_recipients: cc.present? || preserve_recipients
             end
         end
     end

data/lib/dcidev_mailer/rails_mailer.rb

@@ -5,6 +5,7 @@ require 'mail'
 require 'dcidev_mailer/errors/invalid_recipients'
 require 'dcidev_mailer/errors/invalid_body'
 require 'dcidev_mailer/errors/invalid_template'
+
 module DcidevMailer
   class RailsMailer < ActionMailer::Base
 
@@ -15,7 +16,7 @@ module DcidevMailer
       wording, images = DcidevMailer.format_image_from_html(html_body)
 
       locals = { wording: wording, header: nil, footer: nil }
-      locals, images = DcidevMailer.format_header_footer(header_url: header_url, footer_url: footer_url, locals: locals, images: images) if header_url.present? && footer_url.present?
+      locals, _ = DcidevMailer.format_header_footer(header_url: header_url, footer_url: footer_url, locals: locals, images: images) if header_url.present? || footer_url.present?
       
       file_attachments = DcidevMailer.format_attachments(file_attachments) if file_attachments.present?
       if file_attachments.present?
@@ -24,8 +25,23 @@ module DcidevMailer
         end
       end
 
-      attachments.inline['header'] = File.read(DcidevUtility.download_to_file(header_url)) rescue nil if header_url.present?
-      attachments.inline['footer'] = File.read(DcidevUtility.download_to_file(footer_url)) rescue nil if footer_url.present?
+      begin
+        header_file = File.read(DcidevUtility.download_to_file(header_url))
+        header_mime = MimeMagic.by_magic(header_file)
+        attachments.inline['header'] = header_file
+        attachments.inline['header']['content-type'] = header_mime
+        attachments.inline['header']['content-id'] = '<header>'
+      rescue => _
+      end
+
+      begin
+        footer_file = File.read(DcidevUtility.download_to_file(footer_url))
+        footer_mime = MimeMagic.by_magic(footer_file)
+        attachments.inline['footer'] = footer_file
+        attachments.inline['footer']['content-type'] = footer_mime
+        attachments.inline['footer']['content-id'] = '<footer>'
+      rescue => _
+      end
 
       mail(
         to: to,
@@ -43,38 +59,5 @@ module DcidevMailer
         }
       end
     end
-
-
-    # def self.method_missing(method_name, html_body: "", header_url: "", footer_url: "", file_attachments: nil, to: nil, cc: nil, bcc: nil, from: nil, subject: "")
-    #   raise DcidevMailer::Errors::InvalidRecipients unless to.present?
-    #   raise DcidevMailer::Errors::InvalidBody unless html_body.present? && html_body.is_a?(String)
-    #   wording, images = DcidevMailer.format_image_from_html(html_body)
-    #
-    #   locals = { wording: wording, header: nil, footer: nil }
-    #   locals, images = DcidevMailer.format_header_footer(header_url: header_url, footer_url: footer_url, locals: locals, images: images) if header_url.present? && footer_url.present?
-    #
-    #   if file_attachments.present?
-    #     file_attachments.each do |a|
-    #       am.attachments[a[:name].to_s] = a[:content] unless a[:content].nil?
-    #     end
-    #   end
-    #
-    #   attachments.inline['header'] = File.read(Utility.download_to_file(header_url)) rescue nil if header_url.present?
-    #   attachments.inline['footer'] = File.read(Utility.download_to_file(footer_url)) rescue nil if footer_url.present?
-    #
-    #   mail(
-    #     to: to,
-    #     cc: cc,
-    #     bcc: bcc,
-    #     subject: subject,
-    #     format: "text/html",
-    #     from: from,
-    #   ) do |format|
-    #     format.html {
-    #       render locals: locals
-    #     }
-    #   end
-    # end
-
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dcidev_mailer
 version: !ruby/object:Gem::Version
-  version: 0.0.14
+  version: 0.0.17
 platform: ruby
 authors:
 - Punto Damar P
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-21 00:00:00.000000000 Z
+date: 2022-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mimemagic
@@ -71,7 +71,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Commonly used email codes