Интерфейс yii\mail\MailerInterface

Все классы | Методы

Реализуется	yii\mail\BaseMailer, yii\swiftmailer\Mailer
Доступен с версии	2.0
Исходный код	https://github.com/yiisoft/yii2/blob/master/framework/mail/MailerInterface.php

MailerInterface — это интерфейс, который должны реализовывать классы почтовых клиентов.

Почтовый клиент должен главным образом поддерживать создание и отправку сообщений электронной почты. Он также должен поддерживать составление тела сообщения с помощью механизма рендеринга представлений. Например,

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

См. также yii\mail\MessageInterface.

Общедоступные методы

Метод	Описание	Определено в
compose()	Создает новый экземпляр сообщения и, по желанию, составляет его содержимое тела с помощью рендеринга представления.	yii\mail\MailerInterface
send()	Отправляет заданное электронное письмо.	yii\mail\MailerInterface
sendMultiple()	Отправляет несколько сообщений сразу.	yii\mail\MailerInterface

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

compose() public abstract method

Создает новый экземпляр сообщения и, по желанию, составляет его содержимое тела с помощью рендеринга представления.

public abstract yii\mail\MessageInterface compose ( $view = null, array $params = [] )
$view	string\|array\|null	Представление, которое будет использоваться для рендеринга тела сообщения. Это может быть: строка, которая представляет имя представления или псевдоним пути для рендеринга HTML-тела письма. В этом случае текстовое тело будет сгенерировано с применением `strip_tags()` к HTML-телу. массив с элементами 'html' и/или 'text'. Элемент 'html' относится к имени представления или псевдониму пути для рендеринга HTML-тела, а элемент 'text' — для рендеринга текстового тела. Например, `['html' => 'contact-html', 'text' => 'contact-text']`. null, что означает, что экземпляр сообщения будет возвращен без содержимого тела.
$params	array	Параметры (имя-значение), которые будут извлечены и доступны в файле представления.
return	yii\mail\MessageInterface	Экземпляр сообщения.

public abstract yii\mail\MessageInterface compose ( $view = null, array $params = [] )

$view

string|array|null

Представление, которое будет использоваться для рендеринга тела сообщения. Это может быть:

строка, которая представляет имя представления или псевдоним пути для рендеринга HTML-тела письма. В этом случае текстовое тело будет сгенерировано с применением strip_tags() к HTML-телу.
массив с элементами 'html' и/или 'text'. Элемент 'html' относится к имени представления или псевдониму пути для рендеринга HTML-тела, а элемент 'text' — для рендеринга текстового тела. Например, ['html' => 'contact-html', 'text' => 'contact-text'].
null, что означает, что экземпляр сообщения будет возвращен без содержимого тела.

$params

array

Параметры (имя-значение), которые будут извлечены и доступны в файле представления.

return

yii\mail\MessageInterface

Экземпляр сообщения.

send() public abstract method

Отправляет заданное электронное письмо.

public abstract boolean send ( $message )
$message	yii\mail\MessageInterface	Экземпляр сообщения электронной почты, который необходимо отправить
return	boolean	Было ли сообщение успешно отправлено

sendMultiple() public abstract method

Отправляет несколько сообщений сразу.

Этот метод может быть реализован некоторыми почтовыми клиентами, которые поддерживают более эффективный способ отправки нескольких сообщений в одной партии.

public abstract integer sendMultiple ( array $messages )
$messages	array	Список электронных сообщений, которые должны быть отправлены.
return	integer	Количество сообщений, которые были успешно отправлены.

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-mail-mailerinterface.html