Merge pull request #48782 from c960657/preview-smtp-envelope

Only show SMTP envelope recipient when relevant
rails · Nov 7, 2023 · 0157819 · 0157819
2 parents 2f34889 + e5481ed
commit 0157819
Show file tree

Hide file tree

Showing 3 changed files with 48 additions and 6 deletions.
diff --git a/railties/CHANGELOG.md b/railties/CHANGELOG.md
@@ -1,3 +1,7 @@
+*   In mailer preview, only show SMTP-To if it differs from the union of To, Cc and Bcc.
+
+    *Christian Schmidt*
+
 *   Enable YJIT by default on new applications running Ruby 3.3+
 
     Adds a `config/initializers/enable_yjit.rb` initializer that enables YJIT

diff --git a/railties/lib/rails/templates/rails/mailers/email.html.erb b/railties/lib/rails/templates/rails/mailers/email.html.erb
@@ -61,14 +61,14 @@
 <body>
 <header>
   <dl>
-    <% if @email.respond_to?(:smtp_envelope_from) && Array(@email.from) != Array(@email.smtp_envelope_from) %>
+    <% if Array(@email.from) != Array(@email.smtp_envelope_from) %>
       <dt>SMTP-From:</dt>
       <dd id="smtp_from"><%= @email.smtp_envelope_from %></dd>
     <% end %>
 
-    <% if @email.respond_to?(:smtp_envelope_to) && @email.to != @email.smtp_envelope_to %>
+    <% if Set[*@email.to, *@email.cc, *@email.bcc] != Set[*@email.smtp_envelope_to] %>
       <dt>SMTP-To:</dt>
-      <dd id="smtp_to"><%= @email.smtp_envelope_to %></dd>
+      <dd id="smtp_to"><%= @email.smtp_envelope_to.join(", ") %></dd>
     <% end %>
 
     <dt>From:</dt>

diff --git a/railties/test/application/mailer_previews_test.rb b/railties/test/application/mailer_previews_test.rb
@@ -509,9 +509,11 @@ def foo
 
       get "/rails/mailers/notifier/foo"
       assert_equal 200, last_response.status
-      assert_match "Ruby on Rails &lt;core@rubyonrails.org&gt;", last_response.body
-      assert_match "Andrew White &lt;andyw@pixeltrix.co.uk&gt;", last_response.body
-      assert_match "David Heinemeier Hansson &lt;david@heinemeierhansson.com&gt;", last_response.body
+      assert_match '<dd id="from">Ruby on Rails &lt;core@rubyonrails.org&gt;</dd>', last_response.body
+      assert_match '<dd id="to">Andrew White &lt;andyw@pixeltrix.co.uk&gt;</dd>', last_response.body
+      assert_match '<dd id="cc">David Heinemeier Hansson &lt;david@heinemeierhansson.com&gt;</dd>', last_response.body
+      assert_no_match '<dd id="smtp_from">', last_response.body
+      assert_no_match '<dd id="smtp_to">', last_response.body
 
       get "/rails/mailers/download/notifier/foo"
       email = Mail.read_from_string(last_response.body)
@@ -521,6 +523,42 @@ def foo
       assert_equal ["david@heinemeierhansson.com"], email.cc
     end
 
+    test "message header shows SMTP envelope To and From when different than message headers" do
+      mailer "notifier", <<-RUBY
+        class Notifier < ActionMailer::Base
+          default from: "from@example.com"
+
+          def foo
+            message.smtp_envelope_from = "smtp-from@example.com"
+            message.smtp_envelope_to = ["to@example.com", "bcc@example.com"]
+
+            mail to: "to@example.com"
+          end
+        end
+      RUBY
+
+      mailer_preview "notifier", <<-RUBY
+        class NotifierPreview < ActionMailer::Preview
+          def foo
+            Notifier.foo
+          end
+        end
+      RUBY
+
+      text_template "notifier/foo", <<-RUBY
+        Hello, World!
+      RUBY
+
+      app("development")
+
+      get "/rails/mailers/notifier/foo"
+      assert_equal 200, last_response.status
+      assert_match '<dd id="from">from@example.com</dd>', last_response.body
+      assert_match '<dd id="smtp_from">smtp-from@example.com</dd>', last_response.body
+      assert_match '<dd id="to">to@example.com</dd>', last_response.body
+      assert_match '<dd id="smtp_to">to@example.com, bcc@example.com</dd>', last_response.body
+    end
+
     test "part menu selects correct option" do
       mailer "notifier", <<-RUBY
         class Notifier < ActionMailer::Base