Magento 2 Add file Attachment in email using custom module

If you want to implement “add file attachment in the email” functionality in Magento 2, then please follow the below step.

Step 1) Create Vendor/Module/etc/di.xml

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
  <preference for="\Magento\Framework\Mail\Template\TransportBuilder" type="Vendor\Module\Model\Mail\TransportBuilder" />
</config>

<?xml version="1.0"?>

</config>

Step 2) Please create the email template in Vendor/Module/view/frontend/email/email_template.html
then after calling this file to Vendor/Module/etc/email_templates.xml

Step 3) CreateTransportBuilder and extend with \Magento\Framework\Mail\Template\TransportBuilder

Create Vendor/Module/Model/Mail/TransportBuilder.php

<?php
namespace Vendor\Module\Model\Mail;

use Zend_Mime;
class TransportBuilder extends \Magento\Framework\Mail\Template\TransportBuilder
{
    public function addAttachment(
        $body,
        $mimeType    = Zend_Mime::TYPE_OCTETSTREAM,
        $disposition = Zend_Mime::DISPOSITION_ATTACHMENT,
        $encoding    = Zend_Mime::ENCODING_BASE64,
        $filename    = null
    ) {
        $this->message->createAttachment($body, $mimeType, $disposition, $encoding, $filename);
        return $this;
    }
}

<?php

namespace Vendor\Module\Model\Mail;

use Zend_Mime;

class TransportBuilder extends \Magento\Framework\Mail\Template\TransportBuilder

{

public function addAttachment(

$body,

$mimeType = Zend_Mime::TYPE_OCTETSTREAM,

$disposition = Zend_Mime::DISPOSITION_ATTACHMENT,

$encoding = Zend_Mime::ENCODING_BASE64,

$filename = null

) {

$this->message->createAttachment($body, $mimeType, $disposition, $encoding, $filename);

return $this;

}

Step 4) Send mail using controller in execute method
Create Vendor/Module/Controller/Index/Index.php

<?php
namespace Vendor\Module\Controller\Index;

use Magento\Framework\App\Action\Context;
use Magento\Framework\UrlFactory;
use Magento\Framework\App\Filesystem\DirectoryList;
use Magento\Framework\Translate\Inline\StateInterface;
use Vendor\Module\Model\Mail\TransportBuilder;
use Magento\Framework\App\Config\ScopeConfigInterface;
use Magento\Store\Model\ScopeInterface;
use Zend_Mime;


class Index extends \Magento\Customer\Controller\AbstractAccount {
    
    public function __construct(Context $context, 
        \Magento\Framework\Filesystem $fileSystem,
        StateInterface $inlineTranslation,
        TransportBuilder $transportBuilder,  
        ScopeConfigInterface $scopeConfig,
        UrlFactory $urlFactory, 
        \Magento\Framework\Message\ManagerInterface $messageManager
    ) {
        $this->_filesystem = $fileSystem;
        $this->urlModel = $urlFactory->create ();
        $this->inlineTranslation = $inlineTranslation;
        $this->_transportBuilder = $transportBuilder;
        $this->scopeConfig = $scopeConfig;
        $this->messageManager = $messageManager;
        parent::__construct ( $context );
    }
    public function execute() {
        $objectManager = \Magento\Framework\App\ObjectManager::getInstance();
        $storeurl = $objectManager->get( 'Magento\Store\Model\StoreManagerInterface' )->getStore()->getBaseUrl();
        $result = array();
        $resultRedirect = $this->resultRedirectFactory->create ();
        if($_FILES['fileattach']['name']){
            try {
                $uploader = $objectManager->create('Magento\MediaStorage\Model\File\Uploader',['fileId' => 'fileattach']);
                $uploader->setAllowedExtensions(['docx']);
                $uploader->setAllowRenameFiles(true);
                $uploader->setFilesDispersion(true);
                // get media directory
                $mediaDirectory = $this->_filesystem->getDirectoryRead(DirectoryList::MEDIA);
                // save the image to media directory
                
                $result = $uploader->save($mediaDirectory->getAbsolutePath()."fileupload");
                $email = $this->scopeConfig->getValue('trans_email/ident_general/email',ScopeInterface::SCOPE_STORE);
                $name  = $this->scopeConfig->getValue('trans_email/ident_general/name',ScopeInterface::SCOPE_STORE);
                $pdfFile = $result['path'].$result['file'];
                $emailTemplateVariables['message'] = 'This is a test message.';
                $this->inlineTranslation->suspend();
                $this->_transportBuilder->setTemplateIdentifier('email_template') // Add your template name
                  ->setTemplateOptions(
                      [
                          'area' => \Magento\Framework\App\Area::AREA_FRONTEND,
                          'store' =>  $objectManager->get( 'Magento\Store\Model\StoreManagerInterface' )->getStore()->getId(),
                      ]
                  )
                  ->setTemplateVars($emailTemplateVariables)
                  ->setFrom([
                      'name' => 'From Name',
                      'email' => "test1@gmail.com",
                  ])
                  ->addTo("test123@gmail.com", "To Name")
                  ->addAttachment(file_get_contents($pdfFile),$result['type'],Zend_Mime::DISPOSITION_ATTACHMENT,Zend_Mime::ENCODING_BASE64,$result['name']); //Attachment goes here.
              try {
                  $transport = $this->_transportBuilder->getTransport();
                  $transport->sendMessage();
                  $this->inlineTranslation->resume();
              } catch (\Exception $e) {
                  echo $e->getMessage(); die;
              }
            } catch (Exception $e) {
                \Zend_Debug::dump($e->getMessage());
            }
        }else{
            $url = $this->urlModel->getUrl ( '*/*/create', [ 
                    '_secure' => true 
            ] );
            $resultRedirect->setUrl ( $this->_redirect->error ( $url ) );
            $this->messageManager->addError(__('Please upload the document'));
            return $resultRedirect;
        }
      }
    }

<?php

namespace Vendor\Module\Controller\Index;

use Magento\Framework\App\Action\Context;

use Magento\Framework\UrlFactory;

use Magento\Framework\App\Filesystem\DirectoryList;

use Magento\Framework\Translate\Inline\StateInterface;

use Vendor\Module\Model\Mail\TransportBuilder;

use Magento\Framework\App\Config\ScopeConfigInterface;

use Magento\Store\Model\ScopeInterface;

use Zend_Mime;

class Index extends \Magento\Customer\Controller\AbstractAccount {

public function __construct(Context $context,

\Magento\Framework\Filesystem $fileSystem,

StateInterface $inlineTranslation,

TransportBuilder $transportBuilder,

ScopeConfigInterface $scopeConfig,

UrlFactory $urlFactory,

\Magento\Framework\Message\ManagerInterface $messageManager

) {

$this->_filesystem = $fileSystem;

$this->urlModel = $urlFactory->create ();

$this->inlineTranslation = $inlineTranslation;

$this->_transportBuilder = $transportBuilder;

$this->scopeConfig = $scopeConfig;

$this->messageManager = $messageManager;

parent::__construct ( $context );

}

public function execute() {

$objectManager = \Magento\Framework\App\ObjectManager::getInstance();

$storeurl = $objectManager->get( 'Magento\Store\Model\StoreManagerInterface' )->getStore()->getBaseUrl();

$result = array();

$resultRedirect = $this->resultRedirectFactory->create ();

if($_FILES['fileattach']['name']){

try {

$uploader = $objectManager->create('Magento\MediaStorage\Model\File\Uploader',['fileId' => 'fileattach']);

$uploader->setAllowedExtensions(['docx']);

$uploader->setAllowRenameFiles(true);

$uploader->setFilesDispersion(true);

// get media directory

$mediaDirectory = $this->_filesystem->getDirectoryRead(DirectoryList::MEDIA);

// save the image to media directory

$result = $uploader->save($mediaDirectory->getAbsolutePath()."fileupload");

$email = $this->scopeConfig->getValue('trans_email/ident_general/email',ScopeInterface::SCOPE_STORE);

$name = $this->scopeConfig->getValue('trans_email/ident_general/name',ScopeInterface::SCOPE_STORE);

$pdfFile = $result['path'].$result['file'];

$emailTemplateVariables['message'] = 'This is a test message.';

$this->inlineTranslation->suspend();

$this->_transportBuilder->setTemplateIdentifier('email_template') // Add your template name

->setTemplateOptions(

[

'area' => \Magento\Framework\App\Area::AREA_FRONTEND,

'store' => $objectManager->get( 'Magento\Store\Model\StoreManagerInterface' )->getStore()->getId(),

]

)

->setTemplateVars($emailTemplateVariables)

->setFrom([

'name' => 'From Name',

'email' => "test1@gmail.com",

])

->addTo("test123@gmail.com", "To Name")

->addAttachment(file_get_contents($pdfFile),$result['type'],Zend_Mime::DISPOSITION_ATTACHMENT,Zend_Mime::ENCODING_BASE64,$result['name']); //Attachment goes here.

try {

$transport = $this->_transportBuilder->getTransport();

$transport->sendMessage();

$this->inlineTranslation->resume();

} catch (\Exception $e) {

echo $e->getMessage(); die;

}

} catch (Exception $e) {

\Zend_Debug::dump($e->getMessage());

}

}else{

$url = $this->urlModel->getUrl ( '*/*/create', [

'_secure' => true

] );

$resultRedirect->setUrl ( $this->_redirect->error ( $url ) );

$this->messageManager->addError(__('Please upload the document'));

return $resultRedirect;

}

Author Info

s. dutt

Hire s. dutt

Fill the form & Get Installation Support

GET IN TOUCH WITH US NOW

Magento 2 Add file Attachment in email using custom module

Recent Articles

Get a Free Quote

Author Info

s. dutt

Fill the form & Get Installation Support

GET IN TOUCH WITH US NOW

Magento 2 Add file Attachment in email using custom module

Recent Articles

Get a Free Quote

Author Info

s. dutt

FILL THE FORM BELOW & GET FREE DEVELOPMENT FOR 25 HOURS.