courrier 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0a97b8804b294b065433077d025cde44716b87821214649a6421cac278beca5
-  data.tar.gz: 814110bf00d835bfacb15bc8f59bdeb04a0cb7f7b572d4418c3fd901e98c1115
+  metadata.gz: 802112a2d410713a25a67fca11af1a9021cf8f5bd15efe55590bb6d41dcf188b
+  data.tar.gz: ac7fd7ab96871921876c79e20a623baa5d7a8fd9ab5ad13b23e3ae9e2631cc57
 SHA512:
-  metadata.gz: fc4503ec4cef48dbd12f67f093ccb3df9b29834d34b26f99af90b8020f9be2f7207b7629be79d50ba90af9b7b01c47e104568c1813b7b5296211ed788f453831
-  data.tar.gz: d50436d4e7417f481f3f2ad2cc59962b30f42fd60d471f7226128e02e04c0378c117968a8c64c8346a735af2e1dae843d1d0447bdb9ce91153850d9e67af1d83
+  metadata.gz: 350843ff6b853bb92e797d87dd5b485ad095d3f8a70a2129863ea141e11dcf6f0fd90c8a680bf5f731ce38690e0bc0f47dba60ca61cb3ab9089d7b8d524bfaf8
+  data.tar.gz: 222f3088acd972aa5f282e4a29d5f7a2035b2373c10804ff97db89651cb09ead6938117734144c182b2b7268ff64285833674782b38d966145635818a49d2a14

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    courrier (1.0.0)
+    courrier (1.1.0)
       logger (>= 1.5, < 3)
       nokogiri (>= 1.18, < 2)
 

data/README.md

@@ -96,6 +96,7 @@ Courrier.configure do |config|
   config.providers.cloudflare.account_id = "your-account-id"
   config.providers.loops.transactional_id = "default-template"
   config.providers.mailgun.domain = "notifications.railsdesigner.com"
+  config.providers.smtpcom.channel = "your-sender-channel"
 
   config.providers.ses.region = "us-east-1"
   config.providers.ses.access_key_id = "your-access-key-id"
@@ -196,12 +197,16 @@ Courrier supports these transactional email providers:
 - [Cloudflare Email Service](https://developers.cloudflare.com/email-service/)
 - [Lettermint](https://lettermint.co)
 - [Loops](https://loops.so)
+- [MailerSend](https://www.mailersend.com/)
 - [Mailgun](https://mailgun.com)
+- [MailKite](https://mailkite.dev)
 - [MailPace](https://mailpace.com)
+- [Mailtrap](https://mailtrap.io)
 - [Postmark](https://postmarkapp.com)
 - [Resend](https://resend.com)
 - [SendGrid](https://sendgrid.com)
 - [SMTP2GO](https://www.smtp2go.com/)
+- [SMTP.com](https://www.smtp.com/) — requires a `channel`
 - [SparkPost](https://www.sparkpost.com/)
 - [Userlist](https://userlist.com)
 

data/lib/courrier/context_value.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "cgi"
+
+require "courrier/safe_string"
+
+module Courrier
+  class ContextValue
+    def initialize(value, escape:)
+      @value = value
+      @escape = escape
+    end
+
+    def to_s
+      @escape ? CGI.escapeHTML(@value.to_s) : @value.to_s
+    end
+
+    def html_safe
+      SafeString.new(@value.to_s)
+    end
+    alias_method :h, :html_safe
+
+    def method_missing(name, *arguments, &block)
+      result = @value.send(name, *arguments, &block)
+
+      result.is_a?(String) ? ContextValue.new(result, escape: @escape) : result
+    end
+
+    def respond_to_missing?(name, include_private = false)
+      @value.respond_to?(name, include_private) || super
+    end
+  end
+end

data/lib/courrier/email/options.rb

@@ -15,9 +15,9 @@ module Courrier
         @cc = options.fetch(:cc, nil)
         @bcc = options.fetch(:bcc, nil)
 
-        @subject = options.fetch(:subject, "")
-        @text = options.fetch(:text, "")
-        @html = options.fetch(:html, "")
+        @subject = options.fetch(:subject, "").to_s
+        @text = options.fetch(:text, "").to_s
+        @html = options.fetch(:html, "").to_s
 
         @auto_generate_text = options.fetch(:auto_generate_text, false)
 

data/lib/courrier/email/provider.rb

@@ -6,14 +6,18 @@ require "courrier/email/providers/cloudflare"
 require "courrier/email/providers/lettermint"
 require "courrier/email/providers/logger"
 require "courrier/email/providers/loops"
+require "courrier/email/providers/mailersend"
 require "courrier/email/providers/mailgun"
+require "courrier/email/providers/mailkite"
 require "courrier/email/providers/mailjet"
 require "courrier/email/providers/mailpace"
+require "courrier/email/providers/mailtrap"
 require "courrier/email/providers/postmark"
 require "courrier/email/providers/resend"
 require "courrier/email/providers/ses"
 require "courrier/email/providers/sendgrid"
 require "courrier/email/providers/smtp2go"
+require "courrier/email/providers/smtpcom"
 require "courrier/email/providers/sparkpost"
 require "courrier/email/providers/userlist"
 
@@ -26,14 +30,18 @@ module Courrier
         logger: Courrier::Email::Providers::Logger,
         lettermint: Courrier::Email::Providers::Lettermint,
         loops: Courrier::Email::Providers::Loops,
+        mailersend: Courrier::Email::Providers::Mailersend,
         mailgun: Courrier::Email::Providers::Mailgun,
+        mailkite: Courrier::Email::Providers::Mailkite,
         mailjet: Courrier::Email::Providers::Mailjet,
         mailpace: Courrier::Email::Providers::Mailpace,
+        mailtrap: Courrier::Email::Providers::Mailtrap,
         postmark: Courrier::Email::Providers::Postmark,
         resend: Courrier::Email::Providers::Resend,
         ses: Courrier::Email::Providers::Ses,
         sendgrid: Courrier::Email::Providers::Sendgrid,
         smtp2go: Courrier::Email::Providers::Smtp2go,
+        smtpcom: Courrier::Email::Providers::Smtpcom,
         sparkpost: Courrier::Email::Providers::Sparkpost,
         userlist: Courrier::Email::Providers::Userlist
       }

data/lib/courrier/email/providers/base.rb

@@ -40,6 +40,23 @@ module Courrier
 
         def default_headers = {}
 
+        def address_list(value, as: :email)
+          list = value&.to_s&.split(",")&.map(&:strip)&.reject(&:empty?)
+          return unless list && !list.empty?
+
+          list.map { |address| address_element(address, as) }
+        end
+
+        def address_line(value) = address_list(value, as: :plain)&.join(", ")
+
+        def address_element(address, as)
+          case as
+          when :email then {"email" => address}
+          when :address then {"address" => address}
+          else address
+          end
+        end
+
         def provider = self.class.name.split("::").last
       end
     end

data/lib/courrier/email/providers/brevo.rb

@@ -8,11 +8,11 @@ module Courrier
 
         def body
           {
-            "sender" => email_address(@options.from),
-            "to" => email_addresses(@options.to),
-            "cc" => email_addresses(@options.cc),
-            "bcc" => email_addresses(@options.bcc),
-            "replyTo" => email_address(@options.reply_to),
+            "sender" => address_list(@options.from)&.first,
+            "to" => address_list(@options.to),
+            "cc" => address_list(@options.cc),
+            "bcc" => address_list(@options.bcc),
+            "replyTo" => address_list(@options.reply_to)&.first,
             "subject" => @options.subject,
             "htmlContent" => @options.html,
             "textContent" => @options.text
@@ -22,14 +22,6 @@ module Courrier
         private
 
         def default_headers = {"api-key" => @api_key}
-
-        def email_addresses(addresses)
-          addresses&.split(",")&.map { |address| email_address(address) }
-        end
-
-        def email_address(address)
-          {"email" => address.strip} if address
-        end
       end
     end
   end

data/lib/courrier/email/providers/mailersend.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Courrier
+  class Email
+    module Providers
+      class Mailersend < Base
+        ENDPOINT_URL = "https://api.mailersend.com/v1/email"
+
+        def body
+          {
+            "from" => address_list(@options.from)&.first,
+            "to" => address_list(@options.to),
+            "cc" => address_list(@options.cc),
+            "bcc" => address_list(@options.bcc),
+            "reply_to" => address_list(@options.reply_to)&.first,
+            "subject" => @options.subject,
+            "text" => @options.text,
+            "html" => @options.html
+          }.compact
+        end
+
+        private
+
+        def default_headers = {"Authorization" => "Bearer #{@api_key}"}
+      end
+    end
+  end
+end

data/lib/courrier/email/providers/mailgun.rb

@@ -13,6 +13,8 @@ module Courrier
             "from" => @options.from,
 
             "to" => @options.to,
+            "cc" => address_line(@options.cc),
+            "bcc" => address_line(@options.bcc),
             "h:Reply-To" => @options.reply_to,
 
             "subject" => @options.subject,
@@ -33,7 +35,7 @@ module Courrier
 
         def default_headers
           {
-            "Authorization" => "Basic #{Base64.strict_encode64("api:#{@api_key}")}"
+            "Authorization" => "Basic #{["api:#{@api_key}"].pack("m0")}"
           }
         end
       end

data/lib/courrier/email/providers/mailjet.rb

@@ -16,11 +16,9 @@ module Courrier
                   "Email" => @options.from
                 },
 
-                "To" => [
-                  {
-                    "Email" => @options.to
-                  }
-                ],
+                "To" => addresses(@options.to),
+                "Cc" => addresses(@options.cc),
+                "Bcc" => addresses(@options.bcc),
                 "ReplyTo" => reply_to_object,
 
                 "Subject" => @options.subject,
@@ -35,10 +33,14 @@ module Courrier
 
         def default_headers
           {
-            "Authorization" => "Basic " + Base64.strict_encode64("#{@api_key}:#{@provider_options.api_secret}")
+            "Authorization" => "Basic #{["#{@api_key}:#{@provider_options.api_secret}"].pack("m0")}"
           }
         end
 
+        def addresses(value)
+          address_list(value, as: :plain)&.map { |address| {"Email" => address} }
+        end
+
         def reply_to_object
           return if @options.reply_to.nil?
 

data/lib/courrier/email/providers/mailkite.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Courrier
+  class Email
+    module Providers
+      class Mailkite < Base
+        ENDPOINT_URL = "https://api.mailkite.dev/v1/send"
+
+        def body
+          {
+            "from" => @options.from,
+            "to" => address_list(@options.to, as: :plain),
+            "cc" => address_list(@options.cc, as: :plain),
+            "bcc" => address_list(@options.bcc, as: :plain),
+            "replyTo" => @options.reply_to,
+            "subject" => @options.subject,
+            "text" => @options.text,
+            "html" => @options.html
+          }.compact
+        end
+
+        private
+
+        def default_headers
+          {
+            "Authorization" => "Bearer #{@api_key}"
+          }
+        end
+      end
+    end
+  end
+end

data/lib/courrier/email/providers/mailpace.rb

@@ -11,6 +11,8 @@ module Courrier
             "from" => @options.from,
 
             "to" => @options.to,
+            "cc" => address_line(@options.cc),
+            "bcc" => address_line(@options.bcc),
             "replyto" => @options.reply_to,
 
             "subject" => @options.subject,

data/lib/courrier/email/providers/mailtrap.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Courrier
+  class Email
+    module Providers
+      class Mailtrap < Base
+        ENDPOINT_URL = "https://send.api.mailtrap.io/api/send"
+
+        def body
+          {
+            "from" => address_list(@options.from)&.first,
+            "to" => address_list(@options.to),
+            "cc" => address_list(@options.cc),
+            "bcc" => address_list(@options.bcc),
+            "reply_to" => address_list(@options.reply_to)&.first,
+            "subject" => @options.subject,
+            "text" => @options.text,
+            "html" => @options.html
+          }.compact
+        end
+
+        private
+
+        def default_headers = {"Api-Token" => @api_key}
+      end
+    end
+  end
+end

data/lib/courrier/email/providers/postmark.rb

@@ -13,6 +13,8 @@ module Courrier
             "From" => @options.from,
 
             "To" => @options.to,
+            "Cc" => address_line(@options.cc),
+            "Bcc" => address_line(@options.bcc),
             "ReplyTo" => @options.reply_to,
 
             "Subject" => @options.subject,

data/lib/courrier/email/providers/sendgrid.rb

@@ -13,12 +13,10 @@ module Courrier
             },
             "personalizations" => [
               {
-                "to" => [
-                  {
-                    "email" => @options.to
-                  }
-                ]
-              }
+                "to" => address_list(@options.to),
+                "cc" => address_list(@options.cc),
+                "bcc" => address_list(@options.bcc)
+              }.compact
             ],
             "reply_to" => reply_to_object,
 

data/lib/courrier/email/providers/smtpcom.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Courrier
+  class Email
+    module Providers
+      class Smtpcom < Base
+        def self.config_options = %w[channel]
+
+        ENDPOINT_URL = "https://api.smtp.com/v4/messages"
+
+        def body
+          {
+            "channel" => channel,
+            "recipients" => {
+              "to" => address_list(@options.to, as: :address),
+              "cc" => address_list(@options.cc, as: :address),
+              "bcc" => address_list(@options.bcc, as: :address)
+            }.compact,
+            "originator" => {
+              "from" => address_list(@options.from, as: :address)&.first,
+              "reply_to" => address_list(@options.reply_to, as: :address)&.first
+            }.compact,
+            "subject" => @options.subject,
+            "body" => {"parts" => parts}
+          }
+        end
+
+        private
+
+        def default_headers
+          {"Authorization" => "Basic #{base64("api:#{@api_key}")}"}
+        end
+
+        def channel
+          @provider_options.channel || raise(Courrier::ArgumentError, "SMTP.com requires a `channel`")
+        end
+
+        def parts
+          [part("text/plain", @options.text), part("text/html", @options.html)].compact
+        end
+
+        def part(type, content)
+          return unless content
+
+          {
+            "type" => type,
+            "charset" => "UTF-8",
+            "encoding" => "base64",
+            "content" => base64(content)
+          }
+        end
+
+        def base64(value) = [value].pack("m0")
+      end
+    end
+  end
+end

data/lib/courrier/email/providers/sparkpost.rb

@@ -13,15 +13,10 @@ module Courrier
               "from" => @options.from,
               "subject" => @options.subject,
               "text" => @options.text,
-              "html" => @options.html
+              "html" => @options.html,
+              "headers" => cc_header
             }.compact,
-            "recipients" => [
-              {
-                "address" => {
-                  "email" => @options.to
-                }
-              }
-            ]
+            "recipients" => recipients
           }
         end
 
@@ -32,6 +27,26 @@ module Courrier
             "Authorization" => @api_key
           }
         end
+
+        # SparkPost has no cc/bcc field: every copy is an entry in `recipients`, and only
+        # the addresses repeated in the CC header are shown as copied. `header_to` keeps the
+        # visible To line the same for all of them, so a bcc stays hidden and a cc is not
+        # mistaken for a to.
+        def recipients
+          [@options.to, @options.cc, @options.bcc].flat_map { |value| recipients_for(value) }
+        end
+
+        def recipients_for(value)
+          Array(address_list(value, as: :plain)).map do |address|
+            {"address" => {"email" => address, "header_to" => address_line(@options.to)}}
+          end
+        end
+
+        def cc_header
+          cc = address_line(@options.cc)
+
+          {"CC" => cc} if cc
+        end
       end
     end
   end

data/lib/courrier/email/rendering.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require "erb"
+
+require "courrier/context_value"
+require "courrier/safe_string"
+require "courrier/markdown"
+
+module Courrier
+  class Email
+    module Rendering
+      private
+
+      def method_missing(name, *)
+        return in_html_context { render_template("html") || markdown_rendered } if name == :html
+        return render_template("text") if name == :text
+
+        value = @context_options[name]
+        return value if value.is_a?(SafeString)
+
+        value.is_a?(String) ? ContextValue.new(value, escape: @html_context) : value
+      end
+
+      def in_html_context
+        previous = @html_context
+        @html_context = true
+
+        yield
+      ensure
+        @html_context = previous
+      end
+
+      def in_safe_context
+        previous = @html_context
+        @html_context = false
+
+        yield
+      ensure
+        @html_context = previous
+      end
+
+      def render_template(format)
+        template_path = template_file_path(format)
+
+        File.exist?(template_path) ? ERB.new(File.read(template_path)).result(binding) : nil
+      end
+
+      def render_markdown_template
+        %w[md markdown].each do |ext|
+          template_path = template_file_path(ext)
+
+          return ERB.new(File.read(template_path)).result(binding) if File.exist?(template_path)
+        end
+
+        nil
+      end
+
+      def markdown_rendered
+        return unless Courrier::Markdown.available?
+
+        markdown_content = render_markdown_template || (respond_to?(:markdown, true) ? markdown : nil)
+
+        Courrier::Markdown.render(markdown_content) if markdown_content
+      end
+
+      def template_file_path(format)
+        class_path = self.class.name.gsub(/([a-z\d])([A-Z])/, '\1_\2').downcase
+
+        File.join(Courrier.configuration&.email_path, "#{class_path}.#{format}.erb")
+      end
+
+      def html_safe(value = nil, &block)
+        return in_safe_context { SafeString.new(block.call.to_s) } if block
+        return value.html_safe if value.is_a?(ContextValue)
+
+        SafeString.new(value.to_s)
+      end
+      alias_method :h, :html_safe
+
+      def respond_to_missing?(name, include_private = false) = true
+    end
+  end
+end

data/lib/courrier/email.rb

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
 
-require "erb"
-
+require "courrier/email/rendering"
 require "courrier/email/address"
 require "courrier/email/layouts"
-require "courrier/markdown"
 require "courrier/email/options"
 require "courrier/email/provider"
 
 module Courrier
   class Email
+    include Rendering
+
     attr_accessor :provider, :api_key, :default_url_options, :options, :queue_options
 
     @queue_options = {}
@@ -97,7 +97,7 @@ module Courrier
           bcc: options[:bcc] || self.class.bcc || Courrier.configuration&.bcc,
           subject: subject,
           text: text,
-          html: html,
+          html: in_html_context { html },
           auto_generate_text: Courrier.configuration&.auto_generate_text,
           layouts: Courrier::Email::Layouts.new(self).build
         )
@@ -133,46 +133,5 @@ module Courrier
     def delivery_disabled?
       ENV["COURRIER_EMAIL_DISABLED"] == "true" || ENV["COURRIER_EMAIL_ENABLED"] == "false"
     end
-
-    def method_missing(name, *)
-      if name == :text || name == :html
-        render_template(name.to_s).tap do |result|
-          return result || markdown_rendered if name == :html
-        end
-      else
-        @context_options[name]
-      end
-    end
-
-    def render_template(format)
-      template_path = template_file_path(format)
-
-      File.exist?(template_path) ? ERB.new(File.read(template_path)).result(binding) : nil
-    end
-
-    def render_markdown_template
-      %w[md markdown].each do |ext|
-        template_path = template_file_path(ext)
-
-        return ERB.new(File.read(template_path)).result(binding) if File.exist?(template_path)
-      end
-
-      nil
-    end
-
-    def markdown_rendered
-      return unless Courrier::Markdown.available?
-
-      markdown_content = render_markdown_template || (respond_to?(:markdown, true) ? markdown : nil)
-      Courrier::Markdown.render(markdown_content) if markdown_content
-    end
-
-    def template_file_path(format)
-      class_path = self.class.name.gsub(/([a-z\d])([A-Z])/, '\1_\2').downcase
-
-      File.join(Courrier.configuration&.email_path, "#{class_path}.#{format}.erb")
-    end
-
-    def respond_to_missing?(name, include_private = false) = true
   end
 end

data/lib/courrier/safe_string.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Courrier
+  class SafeString
+    def initialize(string) = @string = string.to_s
+    def to_s = @string
+    def html_safe? = true
+  end
+end

data/lib/courrier/version.rb

@@ -1,3 +1,3 @@
 module Courrier
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: courrier
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Rails Designer
@@ -68,6 +68,7 @@ files:
 - lib/courrier.rb
 - lib/courrier/configuration.rb
 - lib/courrier/configuration/providers.rb
+- lib/courrier/context_value.rb
 - lib/courrier/email.rb
 - lib/courrier/email/address.rb
 - lib/courrier/email/layouts.rb
@@ -79,21 +80,27 @@ files:
 - lib/courrier/email/providers/lettermint.rb
 - lib/courrier/email/providers/logger.rb
 - lib/courrier/email/providers/loops.rb
+- lib/courrier/email/providers/mailersend.rb
 - lib/courrier/email/providers/mailgun.rb
 - lib/courrier/email/providers/mailjet.rb
+- lib/courrier/email/providers/mailkite.rb
 - lib/courrier/email/providers/mailpace.rb
+- lib/courrier/email/providers/mailtrap.rb
 - lib/courrier/email/providers/postmark.rb
 - lib/courrier/email/providers/resend.rb
 - lib/courrier/email/providers/sendgrid.rb
 - lib/courrier/email/providers/ses.rb
 - lib/courrier/email/providers/smtp2go.rb
+- lib/courrier/email/providers/smtpcom.rb
 - lib/courrier/email/providers/sparkpost.rb
 - lib/courrier/email/providers/userlist.rb
+- lib/courrier/email/rendering.rb
 - lib/courrier/email/request.rb
 - lib/courrier/email/result.rb
 - lib/courrier/email/transformer.rb
 - lib/courrier/errors.rb
 - lib/courrier/markdown.rb
+- lib/courrier/safe_string.rb
 - lib/courrier/subscriber.rb
 - lib/courrier/subscriber/base.rb
 - lib/courrier/subscriber/beehiiv.rb