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.

Ability to toggle off and disable transactional emails (#12973)

Damian Legawiecd63baceb26ed
diff --git a/admin/app/views/spree/admin/stores/form/_emails.html.erb b/admin/app/views/spree/admin/stores/form/_emails.html.erb
index 4e8838ab0d..aae1c8efda 100644
--- a/admin/app/views/spree/admin/stores/form/_emails.html.erb
+++ b/admin/app/views/spree/admin/stores/form/_emails.html.erb
@@ -4,6 +4,23 @@
<div class="row">
<div class="col-lg-6 offset-lg-3">
+ <div class="card mb-4">
+ <div class="card-header">
+ <h5 class="card-title"><%= Spree.t(:settings) %></h5>
+ </div>
+ <div class="card-body">
+ <div class="form-group">
+ <div class="custom-control custom-checkbox">
+ <%= f.check_box :preferred_send_consumer_transactional_emails, class: 'custom-control-input' %>
+ <%= f.label :preferred_send_consumer_transactional_emails, Spree.t(:send_consumer_transactional_emails), class: 'custom-control-label' %>
+ <small class="form-text text-muted mt-2">
+ <%= Spree.t('admin.store_form.send_consumer_transactional_emails_help') %>
+ </small>
+ </div>
+ </div>
+ </div>
+ </div>
+
<div class="card mb-4">
<div class="card-header">
<h5 class="card-title">Email addresses</h5>
diff --git a/admin/config/locales/en.yml b/admin/config/locales/en.yml
index 596c682770..41029b3708 100644
--- a/admin/config/locales/en.yml
+++ b/admin/config/locales/en.yml
@@ -211,6 +211,7 @@ en:
label: Display the company address field
customer_support_email_help: This email is visible to your Store visitors in the Footer section
new_order_notifications_email_help: If you want to receive an email notification every time someone places an Order please provide an email address for that notification to be sent to
+ send_consumer_transactional_emails_help: When unchecked, transactional emails like order confirmations and shipment notifications will not be sent to customers
store_setup_tasks:
add_billing_address: Add billing address
add_products: Add products
diff --git a/core/config/locales/en.yml b/core/config/locales/en.yml
index d6b5508bec..15ae3ce062 100644
--- a/core/config/locales/en.yml
+++ b/core/config/locales/en.yml
@@ -1855,6 +1855,7 @@ en:
select_stores: Select Store(s)
select_user: Select customer
selected_quantity_not_available: selected of %{item} is not available.
+ send_consumer_transactional_emails: Send Customer Transactional Emails
send_copy_of_all_mails_to: Send Copy of All Mails To
send_mails_as: Send Mails As
send_message: Send message
diff --git a/core/lib/spree/core/configuration.rb b/core/lib/spree/core/configuration.rb
index 7255c79c9a..7e2b791fb0 100644
--- a/core/lib/spree/core/configuration.rb
+++ b/core/lib/spree/core/configuration.rb
@@ -54,7 +54,7 @@ module Spree
preference :require_master_price, :boolean, default: false
preference :restock_inventory, :boolean, default: true # Determines if a return item is restocked automatically once it has been received
preference :return_eligibility_number_of_days, :integer, default: 365
- preference :send_core_emails, :boolean, default: true # Default mail headers settings
+ preference :send_core_emails, :boolean, default: true, deprecated: true # Default mail headers settings
preference :shipping_instructions, :boolean, deprecated: true
preference :show_only_complete_orders_by_default, :boolean, deprecated: true
preference :show_variant_full_price, :boolean, default: false # Displays variant full price or difference with product price. Default false to be compatible with older behavior
diff --git a/emails/app/models/spree/order/emails.rb b/emails/app/models/spree/order/emails.rb
index f333531d56..8d81c5fc9c 100644
--- a/emails/app/models/spree/order/emails.rb
+++ b/emails/app/models/spree/order/emails.rb
@@ -3,7 +3,7 @@ module Spree
module Emails
def deliver_order_confirmation_email
if completed?
- OrderMailer.confirm_email(id).deliver_later
+ OrderMailer.confirm_email(id).deliver_later if store.prefers_send_consumer_transactional_emails?
update_column(:confirmation_delivered, true)
else
errors.add(:base, Spree.t(:order_email_resent_error))
diff --git a/emails/spec/models/spree/order_spec.rb b/emails/spec/models/spree/order_spec.rb
index 8837a1f020..fe5b262bdb 100644
--- a/emails/spec/models/spree/order_spec.rb
+++ b/emails/spec/models/spree/order_spec.rb
@@ -19,6 +19,17 @@ describe Spree::Order, type: :model do
order.finalize!
end
+ context 'when send_consumer_transactional_emails store setting is set to false' do
+ before do
+ allow(order.store).to receive(:prefers_send_consumer_transactional_emails?).and_return(false)
+ end
+
+ it 'does not send order confirmation email to customer' do
+ expect(Spree::OrderMailer).not_to receive(:confirm_email)
+ order.finalize!
+ end
+ end
+
it 'sets confirmation delivered when finalizing' do
expect(order.confirmation_delivered?).to be false
order.finalize!
@@ -50,6 +61,40 @@ describe Spree::Order, type: :model do
end
end
+ describe '#deliver_order_confirmation_email' do
+ let(:order) { create(:completed_order_with_totals, email: '[email protected]', store: store) }
+
+ context 'when send_consumer_transactional_emails store setting is enabled' do
+ before do
+ allow(order.store).to receive(:prefers_send_consumer_transactional_emails?).and_return(true)
+ end
+
+ it 'sends order confirmation email' do
+ mail_message = double 'Mail::Message'
+ expect(Spree::OrderMailer).to receive(:confirm_email).with(order.id).and_return(mail_message)
+ expect(mail_message).to receive(:deliver_later)
+ order.deliver_order_confirmation_email
+ end
+ end
+
+ context 'when send_consumer_transactional_emails store setting is disabled' do
+ before do
+ allow(order.store).to receive(:prefers_send_consumer_transactional_emails?).and_return(false)
+ end
+
+ it 'does not send order confirmation email' do
+ expect(Spree::OrderMailer).not_to receive(:confirm_email)
+ order.deliver_order_confirmation_email
+ end
+
+ it 'still sets confirmation_delivered to true' do
+ expect(order.confirmation_delivered?).to be false
+ order.deliver_order_confirmation_email
+ expect(order.confirmation_delivered?).to be true
+ end
+ end
+ end
+
describe '#cancel' do
let(:order) { build(:order) }
let!(:variant) { create(:variant) }