QUALITY PATCH

MDVA-38827: When the Notify Customers by Email option for shipment is selected…

When the Notify Customers by Email option for shipment is selected, customers receive an email containing the following error message: We're sorry, an error has occurred while generating this content. Quality patch MDVA-38827 for magento/module-sales applies to Magento Open Source and Adobe Commerce 2.3.3-p2 to 2.4.3-p3.

Categories
Emails
Components
magento/module-sales
Origin
adobe-commerce-support
Since QPT
1.1.0

Issue

When the Notify Customers by Email option for shipment is selected, customers receive an email containing the following error message: We're sorry, an error has occurred while generating this content.

Steps to reproduce

1. Go to Marketing > Communications > Email Templates and select Add New Template. * Select Magento Sales > New Shipment. * Click on Load Template. * Add a template name (e.g., Core Shipping Template) and click Save. 1. Go to Store > Settings > Configuration > Sales > Sales Email: * Enable Shipment Comments. * Select Core Shipping Template (refer to the "Add a template name" part of Step 1) under Shipment Comment Email Template and Shipment Comment Email Template for Guest. 1. Place an order. Go to the Admin panel > Sales > Order, click View, and then ship the order. 1. The order state will change from Pending to Processing. 1. Click Shipments on the left sidebar menu and then click View to see the order. 1. Add a comment in Comment Text below Shipment History and check the checkbox Notify Customer by Email. 1. Click Submit Comment.

Adobe's page lists 2.3.3-p1 – 2.4.2-p1 as compatible; the versions below are resolved from the current QPT constraints and are the ones the tool will offer.

Adobe scheduled the permanent fix for 2.4.4.

Install

Install the Quality Patches Tool with composer require magento/quality-patches, apply the prerequisites listed for all files applicable to your distribution and version first, then run vendor/bin/magento-patches apply MDVA-38827. On Cloud, add MDVA-38827 under stage.build.QUALITY_PATCHES in .magento.env.yaml.

For cweagans/composer-patches, choose a compatible version below and download the bundle. Copy its MDVA-38827/ folder into patches/composer/, merge composer.patches.json into composer.json, then run composer install. Bundle prerequisites the same way and list them first. Paths are relative to each package root, using the default -p1 level. Prefer local files when configuring composer-patches; a remote URL can change.

Patch files and compatible versions

Packages across compatible versions (1): magento/module-sales
Packages across compatible versions (1): magento/module-sales

magento/magento2-base >=2.3.3-p1 <2.4.4

Magento Open Source
2.4.3-p3, 2.4.3-p2, 2.4.3-p1, 2.4.3, 2.4.2-p2, 2.4.2-p1, 2.4.2, 2.4.1-p1, 2.4.1, 2.4.0-p1, 2.4.0, 2.3.7-p4, 2.3.7-p3, 2.3.7-p2, 2.3.7-p1, 2.3.7, 2.3.6-p1, 2.3.6, 2.3.5-p2, 2.3.5-p1, 2.3.5, 2.3.4-p2, 2.3.4-p1, 2.3.4, 2.3.3-p2
Adobe Commerce
2.4.3-p3, 2.4.3-p2, 2.4.3-p1, 2.4.3, 2.4.2-p2, 2.4.2-p1, 2.4.2, 2.4.1-p1, 2.4.1, 2.4.0-p1, 2.4.0, 2.3.7-p4, 2.3.7-p3, 2.3.7-p2, 2.3.7-p1, 2.3.7, 2.3.6-p1, 2.3.6, 2.3.5-p2, 2.3.5-p1, 2.3.5, 2.3.4-p2, 2.3.4-p1, 2.3.4, 2.3.3-p2
Patch file
patches/os/MDVA-38827_2.4.2-p1_v2.patch
  • vendor/magento/module-sales/Model/Order/Email/Sender/ShipmentCommentSender.php

Sources

Łukasz Bajsarowicz
Built by

Łukasz Bajsarowicz, e-commerce architect

Magento and Adobe Commerce architecture, upgrades, performance and audits for merchants and agencies since 2015; magento.watch is the tooling I use on those projects.

Open source, maintained on weekends.