Special characters in store name converted to numerical character references in email subject

[mattcoz]

If your store name has a special character in it, such as an apostrophe, it will be converted to a numerical character reference in any email subject. For example:

Store name: Bob's Burgers
Reset password email subject: Reset your Bob's Burgers password

I've tried sending the email directly with php and with Zend_Mail without issues, so it must be somewhere in Magento's email template handling.

[veloraven]

@mattcoz thank you for your feedback.
Please, format this issue according to the Issue reporting guidelines: with steps to reproduce, actual result and expected result.
Please, also identify which version of Magento you are running.

[mattcoz]

Steps to reproduce:

1. Set store name to "Bob's Burgers"
2. Request a password reset

Expected result:

Subject should be "Reset your Bob's Burgers password"

Actual result:

Subject is "Reset your Bob's Burgers password"

[veloraven]

@mattcoz thank you for update.
I have created internal ticket for this issue: MAGETWO-63154

[bat553]

@veloraven Is there a way to track this ticket ?

[rudik99]

Im not sure if you want me to raise another issue, but this happens all the way through the emails.

So If a customer submits via contact form the same thing happens - apostrophe is converted like the example above.

[korostii]

I can confirm that this issue appears in other email as well. For example, when you share a wishlist via email, the subject according to this line and then in your inbox it is also shown with this weird ' inside.

[korostii]

In particular case of the wishlist, the issues seems to be coming out of this little quirk which doesn't seem to care whether the directive is invoked inside subject or body of the email.

To anyone struggling, this is quite an easy workaround: in a given template just add that |raw part at the end of the directive, like in the following:
<!--@subject {{trans "Take a look at %customer_name's Wish List" customer_name=$customerName|raw}} @-->

[hardyjohnson]

Probably related #6597 and MAGETWO-58663 which is referenced in that issue.

[mattcoz]

@korostii Thanks for the workaround, unfortunately it's a pain to have to override every single email template file to fix this. Instead I created a simple plugin to reverse the encoding.

public function afterGetSubject(\Magento\Email\Model\Template $subject, $result)
{
	return htmlspecialchars_decode((string)$result, ENT_QUOTES);
}

[PieterCappelle]

Quick fix is in di.xml

<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
    <type name="Magento\Email\Model\Template">
        <plugin name="mail_subject" type="VENDOR\MODULE\Plugin\Template" sortOrder="100" />
    </type>
</config>

In Template.php

namespace VENDOR\MODULE\Plugin;

class Template
{
    public function afterGetSubject(
        \Magento\Email\Model\Template $subject,
        $result
    ) {
        return htmlspecialchars_decode((string)$result, ENT_QUOTES);
    }
}