Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

Add support for setting `reply_to` for spree mailers (#11584)

Damian Legawiecf1bb4c5e0035
diff --git a/emails/app/mailers/spree/base_mailer.rb b/emails/app/mailers/spree/base_mailer.rb
index 3b0f8ecd59..42a2a6f265 100644
--- a/emails/app/mailers/spree/base_mailer.rb
+++ b/emails/app/mailers/spree/base_mailer.rb
@@ -11,6 +11,10 @@ module Spree
current_store.mail_from_address
end
+ def reply_to_address
+ current_store.mail_from_address
+ end
+
def money(amount, currency = nil)
currency ||= current_store.default_currency
Spree::Money.new(amount, currency: currency).to_s
diff --git a/emails/app/mailers/spree/order_mailer.rb b/emails/app/mailers/spree/order_mailer.rb
index 7d503eb0cb..341c5e0fa7 100644
--- a/emails/app/mailers/spree/order_mailer.rb
+++ b/emails/app/mailers/spree/order_mailer.rb
@@ -5,14 +5,14 @@ module Spree
current_store = @order.store
subject = (resend ? "[#{Spree.t(:resend).upcase}] " : '')
subject += "#{current_store.name} #{Spree.t('order_mailer.confirm_email.subject')} ##{@order.number}"
- mail(to: @order.email, from: from_address, subject: subject, store_url: current_store.url)
+ mail(to: @order.email, from: from_address, subject: subject, store_url: current_store.url, reply_to: reply_to_address)
end
def store_owner_notification_email(order)
@order = order.respond_to?(:id) ? order : Spree::Order.find(order)
current_store = @order.store
subject = Spree.t('order_mailer.store_owner_notification_email.subject', store_name: current_store.name)
- mail(to: current_store.new_order_notifications_email, from: from_address, subject: subject, store_url: current_store.url)
+ mail(to: current_store.new_order_notifications_email, from: from_address, subject: subject, store_url: current_store.url, reply_to: reply_to_address)
end
def cancel_email(order, resend = false)
@@ -20,7 +20,7 @@ module Spree
current_store = @order.store
subject = (resend ? "[#{Spree.t(:resend).upcase}] " : '')
subject += "#{current_store.name} #{Spree.t('order_mailer.cancel_email.subject')} ##{@order.number}"
- mail(to: @order.email, from: from_address, subject: subject, store_url: current_store.url)
+ mail(to: @order.email, from: from_address, subject: subject, store_url: current_store.url, reply_to: reply_to_address)
end
end
end
diff --git a/emails/app/mailers/spree/reimbursement_mailer.rb b/emails/app/mailers/spree/reimbursement_mailer.rb
index 0f258d2f41..de2e13369c 100644
--- a/emails/app/mailers/spree/reimbursement_mailer.rb
+++ b/emails/app/mailers/spree/reimbursement_mailer.rb
@@ -6,7 +6,7 @@ module Spree
current_store = @reimbursement.store || Spree::Store.default
subject = (resend ? "[#{Spree.t(:resend).upcase}] " : '')
subject += "#{current_store.name} #{Spree.t('reimbursement_mailer.reimbursement_email.subject')} ##{@order.number}"
- mail(to: @order.email, from: current_store.mail_from_address, subject: subject, store_url: current_store.url)
+ mail(to: @order.email, from: current_store.mail_from_address, subject: subject, store_url: current_store.url, reply_to: reply_to_address)
end
end
end
diff --git a/emails/app/mailers/spree/shipment_mailer.rb b/emails/app/mailers/spree/shipment_mailer.rb
index cb1a76734e..b4dd2bfbfa 100644
--- a/emails/app/mailers/spree/shipment_mailer.rb
+++ b/emails/app/mailers/spree/shipment_mailer.rb
@@ -6,7 +6,7 @@ module Spree
current_store = @shipment.store
subject = (resend ? "[#{Spree.t(:resend).upcase}] " : '')
subject += "#{current_store.name} #{Spree.t('shipment_mailer.shipped_email.subject')} ##{@order.number}"
- mail(to: @order.email, from: from_address, subject: subject, store_url: current_store.url)
+ mail(to: @order.email, from: from_address, subject: subject, store_url: current_store.url, reply_to: reply_to_address)
end
end
end
diff --git a/emails/app/mailers/spree/test_mailer.rb b/emails/app/mailers/spree/test_mailer.rb
index 03b43cdbfe..a12017ac80 100644
--- a/emails/app/mailers/spree/test_mailer.rb
+++ b/emails/app/mailers/spree/test_mailer.rb
@@ -2,7 +2,7 @@ module Spree
class TestMailer < BaseMailer
def test_email(email)
subject = "#{Spree::Store.default.name} #{Spree.t('test_mailer.test_email.subject')}"
- mail(to: email, from: from_address, subject: subject)
+ mail(to: email, from: from_address, reply_to: reply_to_address, subject: subject)
end
end
end
diff --git a/emails/spec/mailers/spree/order_mailer_spec.rb b/emails/spec/mailers/spree/order_mailer_spec.rb
index 782930c44e..17e1eb21d4 100644
--- a/emails/spec/mailers/spree/order_mailer_spec.rb
+++ b/emails/spec/mailers/spree/order_mailer_spec.rb
@@ -37,28 +37,39 @@ describe Spree::OrderMailer, type: :mailer do
end
context ':from not set explicitly' do
- it 'falls back to spree config' do
- message = Spree::OrderMailer.confirm_email(order)
+ it 'uses store mail from address' do
+ message = described_class.confirm_email(order)
expect(message.from).to eq([Spree::Store.default.mail_from_address])
+ message = described_class.cancel_email(order)
+ expect(message.from).to eq([Spree::Store.default.mail_from_address])
+ end
+ end
+
+ context ':reply_to not set explicitly' do
+ it 'uses store mail from address' do
+ message = described_class.confirm_email(order)
+ expect(message.reply_to).to eq([Spree::Store.default.mail_from_address])
+ message = described_class.cancel_email(order)
+ expect(message.reply_to).to eq([Spree::Store.default.mail_from_address])
end
end
it "doesn't aggressively escape double quotes in confirmation body" do
- confirmation_email = Spree::OrderMailer.confirm_email(order)
+ confirmation_email = described_class.confirm_email(order)
expect(confirmation_email.body).not_to include('&quot;')
end
it 'confirm_email accepts an order id as an alternative to an Order object' do
expect(Spree::Order).to receive(:find).with(order.id).and_return(order)
expect do
- Spree::OrderMailer.confirm_email(order.id).body
+ described_class.confirm_email(order.id).body
end.not_to raise_error
end
it 'cancel_email accepts an order id as an alternative to an Order object' do
expect(Spree::Order).to receive(:find).with(order.id).and_return(order)
expect do
- Spree::OrderMailer.cancel_email(order.id).body
+ described_class.cancel_email(order.id).body
end.not_to raise_error
end
@@ -68,7 +79,7 @@ describe Spree::OrderMailer, type: :mailer do
it 'accepts an order id as an alternative to an Order object' do
expect(Spree::Order).to receive(:find).with(order.id).and_return(order)
expect do
- Spree::OrderMailer.store_owner_notification_email(order.id).body
+ described_class.store_owner_notification_email(order.id).body
end.not_to raise_error
end
@@ -123,8 +134,8 @@ describe Spree::OrderMailer, type: :mailer do
create(:adjustment, order: order, eligible: false, label: 'Ineligible Adjustment')
end
- let!(:confirmation_email) { Spree::OrderMailer.confirm_email(order) }
- let!(:cancel_email) { Spree::OrderMailer.cancel_email(order) }
+ let!(:confirmation_email) { described_class.confirm_email(order) }
+ let!(:cancel_email) { described_class.cancel_email(order) }
specify do
expect(confirmation_email.body).not_to include('Ineligible Adjustment')
@@ -140,14 +151,14 @@ describe Spree::OrderMailer, type: :mailer do
# Tests mailer view spree/order_mailer/confirm_email.text.erb
specify do
- confirmation_email = Spree::OrderMailer.confirm_email(order)
+ confirmation_email = described_class.confirm_email(order)
expect(confirmation_email).to have_body_text('4.99')
expect(confirmation_email).not_to have_body_text('5.00')
end
# Tests mailer view spree/order_mailer/cancel_email.text.erb
specify do
- cancel_email = Spree::OrderMailer.cancel_email(order)
+ cancel_email = described_class.cancel_email(order)
expect(cancel_email).to have_body_text('4.99')
expect(cancel_email).not_to have_body_text('5.00')
end
@@ -171,14 +182,14 @@ describe Spree::OrderMailer, type: :mailer do
shared_examples 'translates emails' do
context 'confirm_email' do
specify do
- confirmation_email = Spree::OrderMailer.confirm_email(order)
+ confirmation_email = described_class.confirm_email(order)
expect(confirmation_email).to have_body_text('Caro Cliente,')
end
end
context 'cancel_email' do
specify do
- cancel_email = Spree::OrderMailer.cancel_email(order)
+ cancel_email = described_class.cancel_email(order)
expect(cancel_email).to have_body_text('Resumo da Pedido [CANCELADA]')
end
end
@@ -201,20 +212,20 @@ describe Spree::OrderMailer, type: :mailer do
context 'with preference :send_core_emails set to false' do
it 'sends no email' do
Spree::Config.set(:send_core_emails, false)
- message = Spree::OrderMailer.confirm_email(order)
+ message = described_class.confirm_email(order)
expect(message.body).to be_blank
end
end
context 'confirm_email comes with data of the store where order was made' do
it 'shows order store data' do
- confirmation_email = Spree::OrderMailer.confirm_email(order)
+ confirmation_email = described_class.confirm_email(order)
expect(confirmation_email.from).to include(first_store.mail_from_address)
expect(confirmation_email.subject).to include(first_store.name)
end
it 'shows order store data #2' do
- confirmation_email = Spree::OrderMailer.confirm_email(second_order)
+ confirmation_email = described_class.confirm_email(second_order)
expect(confirmation_email.from).to include(second_store.mail_from_address)
expect(confirmation_email.subject).to include(second_store.name)
end
diff --git a/emails/spec/mailers/spree/reimbursement_mailer_spec.rb b/emails/spec/mailers/spree/reimbursement_mailer_spec.rb
index 6bf3ae18da..8815cf9d28 100644
--- a/emails/spec/mailers/spree/reimbursement_mailer_spec.rb
+++ b/emails/spec/mailers/spree/reimbursement_mailer_spec.rb
@@ -8,12 +8,19 @@ describe Spree::ReimbursementMailer, type: :mailer do
let(:reimbursement) { create(:reimbursement) }
context ':from not set explicitly' do
- it 'falls back to spree config' do
+ it 'uses store mail from address' do
message = Spree::ReimbursementMailer.reimbursement_email(reimbursement)
expect(message.from).to eq [Spree::Store.default.mail_from_address]
end
end
+ context ':reply_to not set explicitly' do
+ it 'uses store mail from address' do
+ message = Spree::ReimbursementMailer.reimbursement_email(reimbursement)
+ expect(message.reply_to).to eq [Spree::Store.default.mail_from_address]
+ end
+ end
+
it 'accepts a reimbursement id as an alternative to a Reimbursement object' do
expect(Spree::Reimbursement).to receive(:find).with(reimbursement.id).and_return(reimbursement)
diff --git a/emails/spec/mailers/spree/shipment_mailer_spec.rb b/emails/spec/mailers/spree/shipment_mailer_spec.rb
index d2ae1cc0c6..686d17fe67 100644
--- a/emails/spec/mailers/spree/shipment_mailer_spec.rb
+++ b/emails/spec/mailers/spree/shipment_mailer_spec.rb
@@ -16,12 +16,19 @@ describe Spree::ShipmentMailer, type: :mailer do
end
context ':from not set explicitly' do
- it 'falls back to spree config' do
+ it 'falls back to store mail from address' do
message = described_class.shipped_email(shipment)
expect(message.from).to eq([store.mail_from_address])
end
end
+ context ':reply_to not set explicitly' do
+ it 'falls back to store mail from address' do
+ message = described_class.shipped_email(shipment)
+ expect(message.reply_to).to eq([store.mail_from_address])
+ end
+ end
+
# Regression test for #2196
it "doesn't include out of stock in the email body" do
shipment_email = described_class.shipped_email(shipment)