Inheritance diagram for TransportBuilder:

Public Member Functions
	__construct (FactoryInterface $templateFactory, MessageInterface $message, SenderResolverInterface $senderResolver, ObjectManagerInterface $objectManager, TransportInterfaceFactory $mailTransportFactory, MessageInterfaceFactory $messageFactory=null)

	addCc ($address, $name='')

	addTo ($address, $name='')

	addBcc ($address)

	setReplyTo ($email, $name=null)

	setFrom ($from)

	setTemplateIdentifier ($templateIdentifier)

	setTemplateModel ($templateModel)

	setTemplateVars ($templateVars)

	setTemplateOptions ($templateOptions)

	getTransport ()

Protected Member Functions
	reset ()

	getTemplate ()

	prepareMessage ()

Protected Attributes
	$templateIdentifier

	$templateModel

	$templateVars

	$templateOptions

	$transport

	$templateFactory

	$objectManager

	$message

	$_senderResolver

	$mailTransportFactory

Detailed Description

@api @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Since: 100.0.2

Definition at line 24 of file TransportBuilder.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	FactoryInterface	$templateFactory,
		MessageInterface	$message,
		SenderResolverInterface	$senderResolver,
		ObjectManagerInterface	$objectManager,
		TransportInterfaceFactory	$mailTransportFactory,
		MessageInterfaceFactory	$messageFactory = `null`
	)

Parameters

FactoryInterface	$templateFactory
MessageInterface	$message
SenderResolverInterface	$senderResolver
ObjectManagerInterface	$objectManager
TransportInterfaceFactory	$mailTransportFactory
MessageInterfaceFactory	$messageFactory	@SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 109 of file TransportBuilder.php.

       {
         $this->templateFactory = $templateFactory;
         $this->objectManager = $objectManager;
         $this->_senderResolver = $senderResolver;
         $this->mailTransportFactory = $mailTransportFactory;
         $this->messageFactory = $messageFactory ?: $this->objectManager->get(MessageInterfaceFactory::class);
         $this->message = $this->messageFactory->create();
     }

Member Function Documentation

◆ addBcc()

addBcc ( $address )

Add bcc address

Parameters

array | string $address

Returns: $this

Definition at line 157 of file TransportBuilder.php.

     {
         $this->message->addBcc($address);
         return $this;
     }

◆ addCc()

addCc	(	$address,
		$name = `''`
	)

Add cc address

Parameters

array \| string	$address
string	$name

Returns: $this

Definition at line 132 of file TransportBuilder.php.

     {
         $this->message->addCc($address, $name);
         return $this;
     }

◆ addTo()

addTo	(	$address,
		$name = `''`
	)

Add to address

Parameters

array \| string	$address
string	$name

Returns: $this

Definition at line 145 of file TransportBuilder.php.

     {
         $this->message->addTo($address, $name);
         return $this;
     }

◆ getTemplate()

getTemplate ( )

protected

Get template

Returns: \Magento\Framework\Mail\TemplateInterface

Definition at line 270 of file TransportBuilder.php.

     {
         return $this->templateFactory->get($this->templateIdentifier, $this->templateModel)
             ->setVars($this->templateVars)
             ->setOptions($this->templateOptions);
     }

◆ getTransport()

getTransport ( )

Get mail transport

Returns: \Magento\Framework\Mail\TransportInterface

Definition at line 242 of file TransportBuilder.php.

     {
         $this->prepareMessage();
         $mailTransport = $this->mailTransportFactory->create(['message' => clone $this->message]);
         $this->reset();
 
         return $mailTransport;
     }

◆ prepareMessage()

prepareMessage ( )

protected

Prepare message.

Returns: $this

Exceptions

LocalizedException if template type is unknown

Definition at line 283 of file TransportBuilder.php.

     {
         $template = $this->getTemplate();
         $body = $template->processTemplate();
         switch ($template->getType()) {
             case TemplateTypesInterface::TYPE_TEXT:
                 $this->message->setBodyText($body);
                 break;
 
             case TemplateTypesInterface::TYPE_HTML:
                 $this->message->setBodyHtml($body);
                 break;
 
             default:
                 throw new LocalizedException(
                     new Phrase('Unknown template type')
                 );
         }
         $this->message->setSubject(html_entity_decode($template->getSubject(), ENT_QUOTES));
         return $this;
     }

◆ reset()

reset ( )

protected

Reset object state

Returns: $this

Definition at line 256 of file TransportBuilder.php.

     {
         $this->message = $this->messageFactory->create();
         $this->templateIdentifier = null;
         $this->templateVars = null;
         $this->templateOptions = null;
         return $this;
     }

◆ setFrom()

setFrom ( $from )

Set mail from address

Parameters

string | array $from

Returns: $this

Definition at line 182 of file TransportBuilder.php.

     {
         $result = $this->_senderResolver->resolve($from);
         $this->message->setFrom($result['email'], $result['name']);
         return $this;
     }

◆ setReplyTo()

setReplyTo	(	$email,
		$name = `null`
	)

Set Reply-To Header

Parameters

string	$email
string \| null	$name

Returns: $this

Definition at line 170 of file TransportBuilder.php.

     {
         $this->message->setReplyTo($email, $name);
         return $this;
     }

◆ setTemplateIdentifier()

setTemplateIdentifier ( $templateIdentifier )

Set template identifier

Parameters

string $templateIdentifier

Returns: $this

Definition at line 195 of file TransportBuilder.php.

     {
         $this->templateIdentifier = $templateIdentifier;
         return $this;
     }

◆ setTemplateModel()

setTemplateModel ( $templateModel )

Set template model

Parameters

string $templateModel

Returns: $this

Definition at line 207 of file TransportBuilder.php.

     {
         $this->templateModel = $templateModel;
         return $this;
     }

◆ setTemplateOptions()

setTemplateOptions ( $templateOptions )

Set template options

Parameters

array $templateOptions

Returns: $this

Definition at line 231 of file TransportBuilder.php.

     {
         $this->templateOptions = $templateOptions;
         return $this;
     }

◆ setTemplateVars()

setTemplateVars ( $templateVars )

Set template vars

Parameters

array $templateVars

Returns: $this

Definition at line 219 of file TransportBuilder.php.

     {
         $this->templateVars = $templateVars;
         return $this;
     }

Field Documentation

◆ $_senderResolver

$_senderResolver

protected

Definition at line 87 of file TransportBuilder.php.

◆ $mailTransportFactory

$mailTransportFactory

protected

Definition at line 92 of file TransportBuilder.php.

◆ $message

$message

protected

Definition at line 80 of file TransportBuilder.php.

◆ $objectManager

$objectManager

protected

Definition at line 73 of file TransportBuilder.php.

◆ $templateFactory

$templateFactory

protected

Definition at line 66 of file TransportBuilder.php.

◆ $templateIdentifier

$templateIdentifier

protected

Definition at line 31 of file TransportBuilder.php.

◆ $templateModel

$templateModel

protected

Definition at line 38 of file TransportBuilder.php.

◆ $templateOptions

$templateOptions

protected

Definition at line 52 of file TransportBuilder.php.

◆ $templateVars

$templateVars

protected

Definition at line 45 of file TransportBuilder.php.

◆ $transport

$transport

protected

Definition at line 59 of file TransportBuilder.php.

The documentation for this class was generated from the following file:

vendor/magento/framework/Mail/Template/TransportBuilder.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addBcc()

◆ addCc()

◆ addTo()

◆ getTemplate()

◆ getTransport()

◆ prepareMessage()

◆ reset()

◆ setFrom()

◆ setReplyTo()

◆ setTemplateIdentifier()

◆ setTemplateModel()

◆ setTemplateOptions()

◆ setTemplateVars()

Field Documentation

◆ $_senderResolver

◆ $mailTransportFactory

◆ $message

◆ $objectManager

◆ $templateFactory

◆ $templateIdentifier

◆ $templateModel

◆ $templateOptions

◆ $templateVars

◆ $transport