MAGETWO-96712: RMA return emails are populated with the wrong variables (not from the configured scope)

Author: serhii-balko

lib/internal/Magento/Framework/Mail/Template/TransportBuilder.php

@@ -48,6 +48,13 @@ class TransportBuilder
      */
     protected $templateOptions;
 
+    /**
+     * Mail from address
+     *
+     * @var string|array
+     */
+    private $from;
+
     /**
      * Mail Transport
      *
@@ -178,8 +185,7 @@ public function setReplyTo($email, $name = null)
      */
     public function setFrom($from)
     {
-        $result = $this->_senderResolver->resolve($from);
-        $this->message->setFrom($result['email'], $result['name']);
+        $this->from = $from;
         return $this;
     }
 
@@ -256,6 +262,7 @@ protected function reset()
         $this->templateIdentifier = null;
         $this->templateVars = null;
         $this->templateOptions = null;
+        $this->from = null;
         return $this;
     }
 
@@ -289,6 +296,14 @@ protected function prepareMessage()
             ->setBody($body)
             ->setSubject(html_entity_decode($template->getSubject(), ENT_QUOTES));
 
+        if ($this->from) {
+            $from = $this->_senderResolver->resolve(
+                $this->from,
+                $template->getDesignConfig()->getStore()
+            );
+            $this->message->setFrom($from['email'], $from['name']);
+        }
+
         return $this;
     }
 }

lib/internal/Magento/Framework/Mail/Test/Unit/Template/TransportBuilderTest.php

@@ -7,6 +7,7 @@
 namespace Magento\Framework\Mail\Test\Unit\Template;
 
 use Magento\Framework\App\TemplateTypesInterface;
+use Magento\Framework\DataObject;
 use Magento\Framework\Mail\MessageInterface;
 
 /**
@@ -99,17 +100,37 @@ protected function setUp()
      */
     public function testGetTransport($templateType, $messageType, $bodyText, $templateNamespace)
     {
-        $this->builder->setTemplateModel($templateNamespace);
-
         $vars = ['reason' => 'Reason', 'customer' => 'Customer'];
         $options = ['area' => 'frontend', 'store' => 1];
+        $from = 'email_from';
+        $sender = ['email' => 'from@example.com', 'name' => 'name'];
 
-        $template = $this->createMock(\Magento\Framework\Mail\TemplateInterface::class);
+        $this->builder->setTemplateModel($templateNamespace);
+        $this->builder->setFrom($from);
+
+        $template = $this->createPartialMock(
+            \Magento\Framework\Mail\TemplateInterface::class,
+            [
+                'setVars',
+                'isPlain',
+                'setOptions',
+                'getSubject',
+                'getType',
+                'processTemplate',
+                'getDesignConfig',
+            ]
+        );
         $template->expects($this->once())->method('setVars')->with($this->equalTo($vars))->willReturnSelf();
         $template->expects($this->once())->method('setOptions')->with($this->equalTo($options))->willReturnSelf();
         $template->expects($this->once())->method('getSubject')->willReturn('Email Subject');
         $template->expects($this->once())->method('getType')->willReturn($templateType);
         $template->expects($this->once())->method('processTemplate')->willReturn($bodyText);
+        $template->method('getDesignConfig')->willReturn(new DataObject($options));
+
+        $this->senderResolverMock->expects($this->once())
+            ->method('resolve')
+            ->with($from, 1)
+            ->willReturn($sender);
 
         $this->templateFactoryMock->expects($this->once())
             ->method('get')
@@ -128,6 +149,9 @@ public function testGetTransport($templateType, $messageType, $bodyText, $templa
             ->method('setBody')
             ->with($this->equalTo($bodyText))
             ->willReturnSelf();
+        $this->messageMock->method('setFrom')
+            ->with($sender['email'], $sender['name'])
+            ->willReturnSelf();
 
         $transport = $this->createMock(\Magento\Framework\Mail\TransportInterface::class);
 
@@ -161,24 +185,6 @@ public function getTransportDataProvider()
         ];
     }
 
-    /**
-     * @return void
-     */
-    public function testSetFrom()
-    {
-        $sender = ['email' => 'from@example.com', 'name' => 'name'];
-        $this->senderResolverMock->expects($this->once())
-            ->method('resolve')
-            ->with($sender)
-            ->willReturn($sender);
-        $this->messageMock->expects($this->once())
-            ->method('setFrom')
-            ->with('from@example.com', 'name')
-            ->willReturnSelf();
-
-        $this->builder->setFrom($sender);
-    }
-
     /**
      * @return void
      */