Class yii\symfonymailer\Mailer

All Classes | Properties | Methods
Inheritanceyii\symfonymailer\Mailer » yii\mail\BaseMailer
Source Code https://github.com/yiisoft/yii2-symfonymailer/blob/master/src/Mailer.php

PHPStan Types

Name Value
TransportConfigArray array{scheme?: string, host?: string, username?: string, password?: string, port?: integer, options?: array, dsn?: string|\Symfony\Component\Mailer\Transport\Dsn}

Psalm Types

Name Value
TransportHostArray array{scheme?: string, host?: string, username?: string, password?: string, port?: integer, options?: array, dsn?: string|\Symfony\Component\Mailer\Transport\Dsn}

Public Properties

Hide inherited properties

Property Type Description Defined By
$encrypter yii\symfonymailer\MessageEncrypterInterface|null yii\symfonymailer\Mailer
$messageClass string Message default class name. yii\symfonymailer\Mailer
$signer yii\symfonymailer\MessageSignerInterface|null yii\symfonymailer\Mailer
$signerOptions array yii\symfonymailer\Mailer
$transportFactory \Symfony\Component\Mailer\Transport|null yii\symfonymailer\Mailer

Public Methods

Hide inherited methods

Method Description Defined By
setTransport() yii\symfonymailer\Mailer

Protected Methods

Hide inherited methods

Method Description Defined By
sendMessage() yii\symfonymailer\Mailer

Property Details

Hide inherited properties

$messageClass public property

Message default class name.

public string $messageClass = \yii\symfonymailer\Message::class
$signerOptions public property
public array $signerOptions = []
$transportFactory public property
public \Symfony\Component\Mailer\Transport|null $transportFactory = null

Method Details

Hide inherited methods

sendMessage() protected method

protected sendMessage( yii\symfonymailer\MessageWrapperInterface&\yii\mail\MessageInterface $message ): boolean
$message yii\symfonymailer\MessageWrapperInterface&\yii\mail\MessageInterface
throws \Symfony\Component\Mailer\Exception\TransportExceptionInterface 

                protected function sendMessage($message): bool
{
    if (!($message instanceof MessageWrapperInterface)) {
        throw new InvalidArgumentException(sprintf(
            'The message must be an instance of "%s". The "%s" instance is received.',
            MessageWrapperInterface::class,
            get_class($message),
        ));
    }
    $message = $message->getSymfonyEmail();
    if ($this->encrypter !== null) {
        $message = $this->encrypter->encrypt($message);
    }
    if ($this->signer !== null) {
        $message = $this->signer->sign($message, $this->signerOptions);
    }
    $this->getTransport()->send($message);
    return true;
}
setTransport() public method

public setTransport( TransportConfigArray|\Symfony\Component\Mailer\Transport\TransportInterface $transport ): void
$transport TransportConfigArray|\Symfony\Component\Mailer\Transport\TransportInterface
throws \yii\base\InvalidConfigException

on invalid argument.

 

                public function setTransport(array|TransportInterface $transport): void
{
    $this->_transport = $transport instanceof TransportInterface ? $transport : $this->createTransport($transport);
}