How to Send Email in Magento 2

Currently, keeping the longlasting relationship between the stores and customer is extremely necessary. Email is a common method to help store owners keep contact and communicate information to their customers.

In this article, we will give you the way to create custom email by using email template and send email to any addresses.

Declare config module

Create etc/adminhtml/system.xml.

You can create field to load email template in section and group through by: app/code/Bss/EmailDemo/etc/adminhtml/system.xml.

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Config:etc/system_file.xsd">
    <system>
        <tab id="bss" translate="label" sortOrder="300">           
            <label><![CDATA[Bss Commerce]]></label>
        </tab>
        <section id="email" translate="label" sortOrder="20" showInDefault="1" showInWebsite="1" showInStore="1">
            <class>separator-top</class>
            <label>Bss Email Demo</label>
            <tab>bss</tab>
            <resource>Bss_EmailDemo::config_emaildemo</resource>
            <group id="demo" translate="label" type="text" sortOrder="2" showInDefault="1" showInWebsite="1" showInStore="1">
                <label>Please Choose Your Email Template</label>
                <field id="template" translate="label" type="select" sortOrder="3" showInDefault="1" showInWebsite="1" showInStore="1">
                    <label>Email Template</label>
                    <source_model>Magento\Config\Model\Config\Source\Email\Template</source_model>
                    <comment>Email template is chosen based on theme fallback when "Default" option is selected.</comment>
                </field>            
            </group>
        </section>
    </system>
</config>

Please go BSS COMMERCE -> Bss Email Demo to see the result.

Declare Email Template

Create app/code/Bss/EmailDemo/etc/email_templates.xml.

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Email:etc/email_templates.xsd">
<template id="email_demo_template" label="This is email demo" file="email_demo_template.html" type="html" module="Bss_EmailDemo" area="frontend"/>
</config>

In which:

Template id: Your template id you have create in Step 1.
Label: Your Label will show in dropdown email.
file: Your email template file.
type: Type of your email. module: Your module.
area: The place your email in the module directory. view / frontend or view / adminhtml

Create Helper Email

Create app/code/Bss/EmailDemo/Helper/Email.php.

<?php
namespace Bss\EmailDemo\Helper;

use Magento\Framework\App\Helper\Context;
use Magento\Framework\Translate\Inline\StateInterface;
use Magento\Framework\Escaper;
use Magento\Framework\Mail\Template\TransportBuilder;

class Email extends \Magento\Framework\App\Helper\AbstractHelper
{
    protected $inlineTranslation;
    protected $escaper;
    protected $transportBuilder;
    protected $logger;

    public function __construct(
        Context $context,
        StateInterface $inlineTranslation,
        Escaper $escaper,
        TransportBuilder $transportBuilder
    ) {
        parent::__construct($context);
        $this->inlineTranslation = $inlineTranslation;
        $this->escaper = $escaper;
        $this->transportBuilder = $transportBuilder;
        $this->logger = $context->getLogger();
    }

    public function sendEmail()
    {
        try {
            $this->inlineTranslation->suspend();
            $sender = [
                'name' => $this->escaper->escapeHtml('Test'),
                'email' => $this->escaper->escapeHtml('humorgodfather9x02@gmail.com'),
            ];
            $transport = $this->transportBuilder
                ->setTemplateIdentifier('email_demo_template')
                ->setTemplateOptions(
                    [
                        'area' => \Magento\Framework\App\Area::AREA_FRONTEND,
                        'store' => \Magento\Store\Model\Store::DEFAULT_STORE_ID,
                    ]
                )
                ->setTemplateVars([
                    'templateVar'  => 'My Topic',
                ])
                ->setFrom($sender)
                ->addTo('testmagento321@gmail.com')
                ->getTransport();
            $transport->sendMessage();
            $this->inlineTranslation->resume();
        } catch (\Exception $e) {
            $this->logger->debug($e->getMessage());
        }
    }
}

In which:

$sender: The sender’s information (‘name’: sender’s name and ‘email’: sender’s email)
setTemplateIdentifier(’email_demo_template’): email_demo_template is ID of template email mentioned in Step 1 and 2.
setTemplateVars: The information or variable in your email.
addTo(‘testmagento321@gmail.com’): You can fill in the recipient’s email here.

Create Email by html

Create app/code/Bss/EmailDemo/view/frontend/email/email_demo_template.html.

{{template config_path="design/email/header_template"}}
<table>
    <tr>{{trans "Wellcome To: %templateVar." templateVar=$templateVar}}</tr>
</table>
{{template config_path="design/email/footer_template"}}

You can also send emails through Events or use the Plugin to add emails.

Catch Event

To test the email function, we test through the capture of the customer_register_success event when the customer registers the account successfully.

Create app/code/Bss/EmailDemo/etc/frontend/events.xml.

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Event/etc/events.xsd">
    <event name="customer_register_success">
        <observer name="bss_email_customer_register" instance="Bss\EmailDemo\Observer\CustomerRegisterObserver"/>
    </event>
</config>

Create Observer to Send Email

Create app/code/Bss/EmailDemo/Observer/CustomerRegisterObserver.php.

<?php
namespace Bss\EmailDemo\Observer;

use Magento\Framework\Event\ObserverInterface;
use Bss\EmailDemo\Helper\Email;


class CustomerRegisterObserver implements ObserverInterface
{
    private $helperEmail;
    
    public function __construct(
        Email $helperEmail
    ) {
        $this->helperEmail = $helperEmail;
    }
    public function execute(\Magento\Framework\Event\Observer $observer)
    {
        return $this->helperEmail->sendEmail();
    }
}

The Result

After the account is registered successfully, email will be sent automatically to the customer. Please take a look at the image as below.

Nguyen Tan Thanh

+ posts

For your requirement, please follow:
Step 1: Construct Customer Session
use Magento\Customer\Model\Session;


protected $customerSession;

/** * Email constructor. * @param Session $customerSession */ public function __construct( Context $context, Session $customerSession ) { parent::__construct($context); $this->customerSession = $customerSession; }
Step 2: Get model customer from customer session and necessary info. For example, in the sendMail() function:
public function sendEmail() { try { $this->inlineTranslation->suspend(); $sender = [ 'name' => $this->escape->escapeHtml('Test'), 'email' => $this->escape->escapeHtml('humorgodfather9x02@gmail.com'), ]; if ($this->customerSession->isLoggedIn()) { $customer = $this->customerSession->getCustomer(); $transport = $this->transportBuilder ->setTemplateIdentifier('email_demo_template') ->setTemplateOptions( [ 'area' => \Magento\Framework\App\Area::AREA_FRONTEND, 'store' => \Magento\Store\Model\Store::DEFAULT_STORE_ID, ] ) ->setTemplateVars([ 'templateVar' => 'My Topic', 'customerName' => $customer->getName(), 'customerAddress' => $customer->getAddresses() ]) ->setFrom($sender) ->addTo('testmagento321@gmail.com') ->getTransport(); } else { $transport = $this->transportBuilder ->setTemplateIdentifier('email_demo_template') ->setTemplateOptions( [ 'area' => \Magento\Framework\App\Area::AREA_FRONTEND, 'store' => \Magento\Store\Model\Store::DEFAULT_STORE_ID, ] ) ->setTemplateVars([ 'templateVar' => 'My Topic' ]) ->setFrom($sender) ->addTo('testmagento321@gmail.com') ->getTransport(); }

$transport->sendMessage(); $this->inlineTranslation->resume(); } catch (\Exception $e) { $this->logger->debug($e->getMessage()); } }
Hope this helps!

Comments

Chad Singer says:

February 7, 2019 at 5:42 pm

Hello Nguyen and thank you for your tutorial. If I wanted to include customer details of the customer that just registered in the email, how would I get the customerID (or directly the $customer variable) inside the sendEmail() funtion for example?

1. admin says:
  
  March 12, 2019 at 8:58 am
  
  For your requirement, please follow:
  Step 1: Construct Customer Session
  use Magento\Customer\Model\Session;
  protected $customerSession;
  /** * Email constructor. * @param Session $customerSession */ public function __construct( Context $context, Session $customerSession ) { parent::__construct($context); $this->customerSession = $customerSession; }
  Step 2: Get model customer from customer session and necessary info. For example, in the sendMail() function:
  public function sendEmail() { try { $this->inlineTranslation->suspend(); $sender = [ 'name' => $this->escape->escapeHtml('Test'), 'email' => $this->escape->escapeHtml('humorgodfather9x02@gmail.com'), ]; if ($this->customerSession->isLoggedIn()) { $customer = $this->customerSession->getCustomer(); $transport = $this->transportBuilder ->setTemplateIdentifier('email_demo_template') ->setTemplateOptions( [ 'area' => \Magento\Framework\App\Area::AREA_FRONTEND, 'store' => \Magento\Store\Model\Store::DEFAULT_STORE_ID, ] ) ->setTemplateVars([ 'templateVar' => 'My Topic', 'customerName' => $customer->getName(), 'customerAddress' => $customer->getAddresses() ]) ->setFrom($sender) ->addTo('testmagento321@gmail.com') ->getTransport(); } else { $transport = $this->transportBuilder ->setTemplateIdentifier('email_demo_template') ->setTemplateOptions( [ 'area' => \Magento\Framework\App\Area::AREA_FRONTEND, 'store' => \Magento\Store\Model\Store::DEFAULT_STORE_ID, ] ) ->setTemplateVars([ 'templateVar' => 'My Topic' ]) ->setFrom($sender) ->addTo('testmagento321@gmail.com') ->getTransport(); }
  $transport->sendMessage(); $this->inlineTranslation->resume(); } catch (\Exception $e) { $this->logger->debug($e->getMessage()); } }
  Hope this helps!
  
John says:

July 30, 2020 at 9:45 pm

Hey,

Thanks for the great tutorial. I want to send email to individual or multiple customers e.g. sending them a coupon code, it will be easier if I can get a form in admin panel, and write the mail and send. Could you please help me with this? or is their such extension?

Bsscommerce Magento Confluence

Declare config module

Declare Email Template

Create Helper Email

Create Email by html

Catch Event

Create Observer to Send Email

The Result

Nguyen Tan Thanh

Comments

Comments

About us