Класс yii\swiftmailer\Mailer

Mailer реализует почтовый клиент на основе SwiftMailer.

Для использования Mailer, необходимо настроить его в конфигурации приложения следующим образом:

[
    'components' => [
        'mailer' => [
            'class' => 'yii\swiftmailer\Mailer',
            'transport' => [
                'class' => 'Swift_SmtpTransport',
                'host' => 'localhost',
                'username' => 'username',
                'password' => 'password',
                'port' => '587',
                'encryption' => 'tls',
            ],
        ],
        // ...
    ],
    // ...
],

Вы также можете пропустить настройку свойства $transport. В этом случае для отправки писем будет использована стандартная функция PHP mail() .

Вы можете указать аргументы конструктора для транспорта, используя ключ 'constructArgs' в конфигурации. Вы также можете указать список плагинов, которые должны быть зарегистрированы для транспорта, используя ключ 'plugins'. Например:

'transport' => [
    'class' => 'Swift_SmtpTransport',
    'constructArgs' => ['localhost', 25]
    'plugins' => [
        [
            'class' => 'Swift_Plugins_ThrottlerPlugin',
            'constructArgs' => [20],
        ],
    ],
],

Для отправки письма, можно использовать следующий код:

Yii::$app->mailer->compose('contact/html', ['contactForm' => $form])
    ->setFrom('from@domain.com')
    ->setTo($form->email)
    ->setSubject($form->subject)
    ->send();

См. также http://swiftmailer.org.

Публичные свойства

Публичные методы

Защищенные методы

События

Подробности свойств

$enableSwiftMailerLogging публичное свойство (доступно с версии 2.0.4)

Включить запись внутренних журналов SwiftMailer с помощью механизма Yii логирования. При включении, плагин yii\swiftmailer\Logger будет присоединен к $transport для этой цели.

См. также yii\swiftmailer\Logger.

public boolean $enableSwiftMailerLogging = false

$messageClass общедоступное свойство

Имя по умолчанию класса сообщения.

public string $messageClass = 'yii\swiftmailer\Message'

$swiftMailer общедоступное только для чтения свойство

Экземпляр или конфигурационный массив Swift mailer.

public array|\Swift_Mailer getSwiftMailer ( )

$transport общедоступное свойство

public array|\Swift_Transport getTransport ( )
public void setTransport ( $transport )

Подробное описание методов