Transport Class Reference

Inheritance diagram for Transport:

Public Member Functions
	__construct (MessageInterface $message, ScopeConfigInterface $scopeConfig, $parameters=null)
	sendMessage ()
	getMessage ()

Data Fields
const	XML_PATH_SENDING_SET_RETURN_PATH = 'system/smtp/set_return_path'
const	XML_PATH_SENDING_RETURN_PATH_EMAIL = 'system/smtp/return_path_email'

Detailed Description

Class that responsible for filling some message data before transporting it.

See also

\Zend\Mail\Transport\Sendmail is used for transport

Definition at line 21 of file Transport.php.

Constructor & Destructor Documentation

__construct()

__construct	(	MessageInterface	$message,
		ScopeConfigInterface	$scopeConfig,
			$parameters = null
	)

Parameters

MessageInterface	$message	Email message object
ScopeConfigInterface	$scopeConfig	Core store config
null | string | array | \Traversable	$parameters	Config options for sendmail parameters

Definition at line 49 of file Transport.php.

      {
        /* configuration of whether return path should be set or no. Possible values are:
             * 0 - no
             * 1 - yes (set value as FROM address)
             * 2 - use custom value
             * @see Magento\Config\Model\Config\Source\Yesnocustom
             */
        $isSetReturnPath = $scopeConfig->getValue(
            self::XML_PATH_SENDING_SET_RETURN_PATH,
            ScopeInterface::SCOPE_STORE
        );
        $returnPathValue = $scopeConfig->getValue(
            self::XML_PATH_SENDING_RETURN_PATH_EMAIL,
            ScopeInterface::SCOPE_STORE
        );

        if ($isSetReturnPath == '2' && $returnPathValue !== null) {
            $parameters .= ' -f' . \escapeshellarg($returnPathValue);
        }

        $this->zendTransport = new Sendmail($parameters);
        $this->message = $message;
    }

Member Function Documentation

getMessage()

getMessage

(

)

Get message

Returns

\Magento\Framework\Mail\MessageInterface

Since

101.0.0

Implements TransportInterface.

Definition at line 94 of file Transport.php.

    {
        return $this->message;
    }

sendMessage()

sendMessage

(

)

Send a mail using this transport

Returns

void

Exceptions

Implements TransportInterface.

Definition at line 80 of file Transport.php.

    {
        try {
            $this->zendTransport->send(
                Message::fromString($this->message->getRawMessage())
            );
        } catch (\Exception $e) {
            throw new MailException(new Phrase($e->getMessage()), $e);
        }
    }

Field Documentation

XML_PATH_SENDING_RETURN_PATH_EMAIL

const XML_PATH_SENDING_RETURN_PATH_EMAIL = 'system/smtp/return_path_email'

Configuration path for custom Return-Path email

Definition at line 32 of file Transport.php.

XML_PATH_SENDING_SET_RETURN_PATH

const XML_PATH_SENDING_SET_RETURN_PATH = 'system/smtp/set_return_path'

Configuration path to source of Return-Path and whether it should be set at all

See also

\Magento\Config\Model\Config\Source\Yesnocustom to possible values

Definition at line 27 of file Transport.php.

---

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

• vendor/magento/module-email/Model/Transport.php