Here we learn how to send transactional emails programmatically in Magento 2 custom module.<\/p>\n\n\n\n
Transactional emails in Magento 2 play a crucial role in keeping customers informed about important events and actions on the store.<\/p>\n\n\n\n
Magento 2 provides a flexible and scalable email system that allows store owners and developers to manage transactional emails using predefined templates, custom email variables, and dynamic content.<\/p>\n\n\n\n
1# First, we create a field in the configuration from where we can select which email template will use.<\/strong><\/p>\n\n\n\n You can create a configuration field according to your section and group in app\/code\/NameSpace\/ModuleName\/etc\/adminhtml\/system.xml file as follows<\/p>\n\n\n\n 2# Now create an email template configuration file at app\/code\/NameSpace\/ModuleName\/etc location file name should be email_templates.xml<\/strong><\/p>\n\n\n\n 3# Now create an email template file at app\/code\/NameSpace\/ModuleName\/view\/adminhtml\/email with<\/strong> the same name you gave in email_template.xml file .<\/strong><\/p>\n\n\n\n Here we will use\u00a0 “your_email_template.html” for the<\/strong> email template<\/strong><\/p>\n\n\n\n 4# Now the template is ready, and we will write code to send mail.<\/strong> 5# Helper file where we define our custom send mail function<\/p>\n\n\n\n With this, you have successfully learn to send transactional emails programmatically in Magento 2.<\/p>\n\n\n\n For technical assistance, please get in touch with us via email at\u00a0support@webkul.com<\/a>.<\/p>\n\n\n\n Discover powerful solutions to enhance your Magento 2 store by exploring our\u00a0Magento 2 plugins<\/a>\u00a0page.<\/p>\n\n\n\n Bring your vision to life with custom-built solutions\u2014hire skilled\u00a0Magento 2 developers<\/a>\u00a0today.<\/p>\n\n\n\n Thanks \ud83d\ude42<\/p>\n","protected":false},"excerpt":{"rendered":"<field id="your_email_template_field_id" translate="label comment" type="select" sortOrder="2" showInDefault="1" showInWebsite="1" showInStore="1">\n <label>Label Of Your Field<\/label>\n <source_model>Magento\\Config\\Model\\Config\\Source\\Email\\Template<\/source_model>\n <!-- This model return all transactional email template list of magento -->\n<\/field><\/pre>\n\n\n\n
<?xml version="1.0"?>\n<config xmlns:xsi="http:\/\/www.w3.org\/2001\/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Email:etc\/email_templates.xsd">\n <template id="section_group_your_email_template_field_id" label="Label Of Your Template File" file="your_email_template.html" type="html" module="NameSpace_ModuleName" area="adminhtml"\/>\n<\/config>\n<!-- here you define your email template and its template location path--><\/pre>\n\n\n\n
<!--@subject Subject Of your email @-->\n<!--@vars {\n"var this.getUrl($store, 'admin')":"Warehouse Account URL",\n"var customer.email":"Customer Email",\n"var customer.name":"Customer Name"\n} @-->\n\n{{template config_path="design\/email\/header_template"}} <!-- pathe of template header-->\n\n<!-- here $myvar1 , $myvar2, $myvar3, $myvar4, $myvar5, $myvar6 are variables in which we\n asssign values when we use this template for send mail-->\n\n<!-- you can Modify content of template according to your requirement-->\n<table>\n <tr class="email-intro">\n <td>\n <p class="greeting">{{trans "%customer_name," customer_name=$myvar3}}<\/p>\n <p>\n {{trans "Your custom message."}}\n {{trans 'Your custom message <a href="%account_url">logging into your account<\/a>.' account_url=$this.getUrl($store,'admin',[_nosid:1]) |raw}}\n <\/p>\n <\/td>\n <\/tr>\n <tr class="email-summary">\n <td>\n <h1>{{trans 'Your Order <span class="no-link">#%increment_id<\/span>' increment_id=$myvar1 |raw}}<\/h1>\n <p>{{trans 'Placed on <span class="no-link">%created_at<\/span>' created_at=$myvar2 |raw}}<\/p>\n <\/td>\n <\/tr>\n <tr class="email-information">\n <td>\n <table class="order-details">\n <tr>\n <td class="address-details">\n <h3>{{trans "Billing Info"}}<\/h3>\n <p>{{var myvar4|raw}}<\/p>\n <\/td>\n <\/tr>\n <\/table>\n <table class="email-items">\n <thead>\n <tr>\n <th class="item-info">{{trans "Item"}}<\/th>\n <th class="item-info">{{trans "Sku"}}<\/th>\n <\/tr>\n <\/thead>\n <tbody>\n {{var myvar8|raw}}\n <\/tbody>\n <\/table>\n <\/td>\n <\/tr>\n<\/table>\n\n{{template config_path="design\/email\/footer_template"}} <!--footer of template--><\/pre>\n\n\n\n
Write the send mail code in the action from where you want to send this mail.<\/p>\n\n\n\n\/* Here we prepare data for our email *\/\n\n\n\/* Receiver Detail *\/\n$receiverInfo = [\n 'name' => 'Reciver Name',\n 'email' => 'receiver@address.com'\n];\n\n\n\/* Sender Detail *\/\n$senderInfo = [\n 'name' => 'Sender Name',\n 'email' => 'sender@addess.com',\n];\n\n\n\/* Assign values for your template variables *\/\n$emailTemplateVariables = array();\n$emailTempVariables['myvar1'] = $variablevalue1;\n$emailTempVariables['myvar2'] = $variablevalue2;\n ...\n ...\n ... \n\n\/* We write send mail function in helper because if we want to \n use same in other action then we can call it directly from helper *\/ \n\n\/* call send mail method from helper or where you define it*\/ \n$this->_objectManager->get('NameSpace\\ModuleName\\Helper\\Email')->yourCustomMailSendMethod(\n $emailTempVariables,\n $senderInfo,\n $receiverInfo\n );<\/pre>\n\n\n\n<?php\nnamespace NameSpace\\ModuleName\\Helper;\n\n\/**\n * Custom Module Email helper\n *\/\nclass Email extends \\Magento\\Framework\\App\\Helper\\AbstractHelper\n{\n const XML_PATH_EMAIL_TEMPLATE_FIELD = 'section\/group\/your_email_template_field_id';\n \/* Here section and group refer to name of section and group where you create this field in configuration*\/\n\n \/**\n * @var \\Magento\\Framework\\App\\Config\\ScopeConfigInterface\n *\/\n protected $_scopeConfig;\n\n \/**\n * Store manager\n *\n * @var \\Magento\\Store\\Model\\StoreManagerInterface\n *\/\n protected $_storeManager;\n\n \/**\n * @var \\Magento\\Framework\\Translate\\Inline\\StateInterface\n *\/\n protected $inlineTranslation;\n\n \/**\n * @var \\Magento\\Framework\\Mail\\Template\\TransportBuilder\n *\/\n protected $_transportBuilder;\n \n \/**\n * @var string\n *\/\n protected $temp_id;\n\n \/**\n * @param Magento\\Framework\\App\\Helper\\Context $context\n * @param Magento\\Framework\\App\\Config\\ScopeConfigInterface $scopeConfig\n * @param Magento\\Store\\Model\\StoreManagerInterface $storeManager\n * @param Magento\\Framework\\Translate\\Inline\\StateInterface $inlineTranslation\n * @param Magento\\Framework\\Mail\\Template\\TransportBuilder $transportBuilder\n *\/\n public function __construct(\n \\Magento\\Framework\\App\\Helper\\Context $context,\n \\Magento\\Store\\Model\\StoreManagerInterface $storeManager,\n \\Magento\\Framework\\Translate\\Inline\\StateInterface $inlineTranslation,\n \\Magento\\Framework\\Mail\\Template\\TransportBuilder $transportBuilder\n ) {\n $this->_scopeConfig = $context;\n parent::__construct($context);\n $this->_storeManager = $storeManager;\n $this->inlineTranslation = $inlineTranslation;\n $this->_transportBuilder = $transportBuilder; \n }\n\n \/**\n * Return store configuration value of your template field that which id you set for template\n *\n * @param string $path\n * @param int $storeId\n * @return mixed\n *\/\n protected function getConfigValue($path, $storeId)\n {\n return $this->scopeConfig->getValue(\n $path,\n \\Magento\\Store\\Model\\ScopeInterface::SCOPE_STORE,\n $storeId\n );\n }\n\n \/**\n * Return store \n *\n * @return Store\n *\/\n public function getStore()\n {\n return $this->_storeManager->getStore();\n }\n\n \/**\n * Return template id according to store\n *\n * @return mixed\n *\/\n public function getTemplateId($xmlPath)\n {\n return $this->getConfigValue($xmlPath, $this->getStore()->getStoreId());\n }\n\n \/**\n * [generateTemplate description] with template file and tempaltes variables values \n * @param Mixed $emailTemplateVariables \n * @param Mixed $senderInfo \n * @param Mixed $receiverInfo \n * @return void\n *\/\n public function generateTemplate($emailTemplateVariables,$senderInfo,$receiverInfo)\n {\n $template = $this->_transportBuilder->setTemplateIdentifier($this->temp_id)\n ->setTemplateOptions(\n [\n 'area' => \\Magento\\Framework\\App\\Area::AREA_FRONTEND, \/* here you can defile area and\n store of template for which you prepare it *\/\n 'store' => $this->_storeManager->getStore()->getId(),\n ]\n )\n ->setTemplateVars($emailTemplateVariables)\n ->setFrom($senderInfo)\n ->addTo($receiverInfo['email'],$receiverInfo['name']);\n return $this; \n }\n\n \/**\n * [sendInvoicedOrderEmail description] \n * @param Mixed $emailTemplateVariables \n * @param Mixed $senderInfo \n * @param Mixed $receiverInfo \n * @return void\n *\/\n \/* your send mail method*\/\n public function yourCustomMailSendMethod($emailTemplateVariables,$senderInfo,$receiverInfo)\n {\n\n $this->temp_id = $this->getTemplateId(self::XML_PATH_EMAIL_TEMPLATE_FIELD);\n $this->inlineTranslation->suspend(); \n $this->generateTemplate($emailTemplateVariables,$senderInfo,$receiverInfo); \n $transport = $this->_transportBuilder->getTransport();\n $transport->sendMessage(); \n $this->inlineTranslation->resume();\n }\n\n}<\/pre>\n\n\n\n