dcidev_mailer 0.0.16 → 0.0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f3f6f2bc44b3d45a845f89bc2922dfb527a8a3fd98156b444a46fb1920ef355
-  data.tar.gz: e395df17cc4a719004e7d58b513aaa8d534032c335b82e34054380c08fa427be
+  metadata.gz: a307fb952b55347c9179dc189fb8985dc77e12dc2cd2da701101fa436c38a28c
+  data.tar.gz: e67cd65ca7997d4e1b325fcf9aca21b9f1aaa68d10bdd01ed15ebc9c04dc45c1
 SHA512:
-  metadata.gz: 26926484cb0021436d5a9f9d74a9927d3220f6bdea7438c9d6ba99ea104c21290fde491c60af8f413772e01df74e79cc12f6e8fa3c54d3879a7716caa9be83fd
-  data.tar.gz: f82ebb6124f7425de9fc3b2b6bd8e09122f8514b3137dfb7e23ce31dfecf48e99c5e6dd5284f08aead7157ce8e0fce736b7445e9743c57589fe6377e16ab04a0
+  metadata.gz: 3e0fa773abcd440cb1cd8936a74349dd0bf0e89000dfcbdbcaff76c7776422f823e06910161e63058448e8483a880b86009f6cef8c920ca4aa13c3339b76a5bc
+  data.tar.gz: 841ac66e022fe389612eb49bbbf481eba8ae04b83b82a05c1d553c344c5f535b4264f25156363df14cb00a2d054eb020346d72090b38d3fad9c543762ac0bced

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= 
@@ -163,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  
@@ -187,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?
+                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,8 +29,9 @@ module DcidevMailer
                               important: true,
                               inline_css: true,
                               attachments: attachments,
-                              images: images
+                              images: images,
+                              preserve_recipients: cc.present? || preserve_recipients
             end
         end
     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.rb

@@ -43,7 +43,7 @@ module DcidevMailer
         
         def format_header_footer(header_url: "", footer_url: "", locals: {}, images: {})
             [{ name: "header", url: header_url }, { name: "footer", url: footer_url }].each do |i|
-                return if i[:url].nil?
+                next if i[:url].nil?
                 begin
                     extension, encoded, _ = DcidevUtility.file_url_to_base64(i[:url])
                     locals[i[:name].to_sym] = "cid:#{i[:name]}"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dcidev_mailer
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 0.0.18
 platform: ruby
 authors:
 - Punto Damar P
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-19 00:00:00.000000000 Z
+date: 2023-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mimemagic