Dispatch events for e-mail template variables

[tzyganu]

I think there is a need for an event to be dispatched before calling setTemplateParams when an e-mail is sent. I often needed this to add extra information in e-mail templates (at least for 1.x version) and the only way I could do it is to rewrite the method. (or am I doing it wrong?)
Here is an example.
in Magento\Sales\Model\Order::sendNewOrderEmail() this code

$mailer->setTemplateParams(array(
       'order'        => $this,
       'billing'      => $this->getBillingAddress(),
       'payment_html' => $paymentBlockHtml
      )
);

can be

$params = new \Magento\Object(array(
       'order'        => $this,
       'billing'      => $this->getBillingAddress(),
       'payment_html' => $paymentBlockHtml
      ));

$this->_eventManager->dispatch('sales_order_new_email', array('params'=>$params));
$mailer->setTemplateParams($params->getData());

[benmarks]

The info has to be passed as an argument, requiring a rewrite. This must
be changed.

On Wednesday, October 30, 2013, Marius wrote:

I think there is a need for an event to be dispatched before calling
setTemplateParams when an e-mail is sent. I often needed this to add
extra information in e-mail templates (at least for 1.x version) and the
only way I could do it is to rewrite the method. (or am I doing it wrong?)
Here is an example.
in Magento\Sales\Model\Order::sendNewOrderEmail() this code

$mailer->setTemplateParams(array(
'order' => $this,
'billing' => $this->getBillingAddress(),
'payment_html' => $paymentBlockHtml
)
);

can be

$params = new \Magento\Object(array(
'order' => $this,
'billing' => $this->getBillingAddress(),
'payment_html' => $paymentBlockHtml
));

$this->_eventManager->dispatch('sales_order_new_email', array('params'=>$params));
$mailer->setTemplateParams($params->getData());

—
Reply to this email directly or view it on GitHubhttps://github.com//issues/396
.

[image: Blue Acorn]

Benjamin H. Marks
Director of Development | ben@blueacorn.com |
@benmarkshttp://twitter.com/benmarks

o: 843-641-0045 | m: 843-670-4240 | skype: blueacorn_ben

Blue Acorn | www.blueacorn.com
Subscribe to our Blog http://www.blueacorn.com/feed/ | Follow us on
Twitter http://www.twitter.com/blueacorn

[wshqq]

This is not very useful at all, because it is limited to sales_order_new_email and it's set at the wrong place.

It's better to at this feature to Magento\Email\Model\Template to functions send and sendTransactional. Here you can also add the Mail themself to event. So everyone can observe this event for paste in new params and email attachments like pdfs. This event also triggered for all emails.

I will create a pull request for this feature.

[kandy]

Use Interceptors, Luke!

[tzyganu]

@wshqq the code I provided was is not necessarily the correct code. I was trying to prove a point. Of course this is needed for all e-mails.

@kandy That might work.

[verklov]

Hello @tzyganu ,
Thank you for reporting this issue! We will investigate on it and let you know once our analysis is complete.

[verklov]

Here is the response from the team I got regarding this issue:

Yes, we can use interceptors, in case to inject Magento\Email\Model\Template\Mailer with interceptor into Magento\Sales\Model\Order class, DI configuration will be:

<type name="Magento\Sales\Model\Order">
   <param name="templateMailerFactory">
       <instance type="virtualMailerFactory" />
   </param>
</type>
<virtualType name="virtualMailerFactory" type="Magento\Email\Model\Template\MailerFactory">
   <param name="instanceName">
       <value>virtualOrderTemplateMailer</value>
   </param>
</virtualType>
<virtualType name="virtualOrderTemplateMailer" type="Magento\Email\Model\Template\Mailer">
   <plugin name="additional_params" type="Magento\Sales\Model\Plugin\Mailer" />
</virtualType>

For all others cases, it could be:

<type name="Magento\Email\Model\Template\Mailer">
   <plugin name="additional_params" type="Magento\Sales\Model\Plugin\Mailer" />
</type>

We assume this is the complete answer for the question you asked. We are closing this ticket now. If there are more unanswered questions, please let us know. We will try to provide you with the complete answers.

[tzyganu]

@verklov Thanks for the nice tutorial. All clear now.