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

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

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

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

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

Сообщения отправляются с помощью почтового сервера, например:

Yii::$app->mailer->compose()
    ->setFrom('from@domain.com')
    ->setTo($form->email)
    ->setSubject($form->subject)
    ->setTextBody('Plain text content')
    ->setHtmlBody('<b>HTML content</b>')
    ->send();

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

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

Метод	Описание	Определено в
attach()	Прикрепляет существующий файл к сообщению электронной почты.	yii\mail\MessageInterface
attachContent()	Прикрепляет указанное содержимое как файл к сообщению электронной почты.	yii\mail\MessageInterface
embed()	Прикрепляет файл и возвращает его CID-источник.	yii\mail\MessageInterface
embedContent()	Прикрепляет содержимое как файл и возвращает его CID-источник.	yii\mail\MessageInterface
getBcc()	Возвращает адреса Bcc (скрытых получателей) этого сообщения.	yii\mail\MessageInterface
getCc()	Возвращает адреса Cc (дополнительных получателей) этого сообщения.	yii\mail\MessageInterface
getCharset()	Возвращает кодировку символов этого сообщения.	yii\mail\MessageInterface
getFrom()	Возвращает отправителя сообщения.	yii\mail\MessageInterface
getReplyTo()	Возвращает адрес ответа для этого сообщения.	yii\mail\MessageInterface
getSubject()	Возвращает тему сообщения.	yii\mail\MessageInterface
getTo()	Возвращает получателя(ей) сообщения.	yii\mail\MessageInterface
send()	Отправляет это электронное письмо.	yii\mail\MessageInterface
setBcc()	Устанавливает адреса Bcc (скрытых получателей) этого сообщения.	yii\mail\MessageInterface
setCc()	Устанавливает адреса Cc (дополнительных получателей) этого сообщения.	yii\mail\MessageInterface
setCharset()	Устанавливает кодировку символов этого сообщения.	yii\mail\MessageInterface
setFrom()	Устанавливает отправителя сообщения.	yii\mail\MessageInterface
setHtmlBody()	Устанавливает HTML-содержимое сообщения.	yii\mail\MessageInterface
setReplyTo()	Устанавливает адрес ответа для этого сообщения.	yii\mail\MessageInterface
setSubject()	Устанавливает тему сообщения.	yii\mail\MessageInterface
setTextBody()	Устанавливает текстовое содержимое сообщения.	yii\mail\MessageInterface
setTo()	Устанавливает получателя(ей) сообщения.	yii\mail\MessageInterface
toString()	Возвращает строковое представление этого сообщения.	yii\mail\MessageInterface

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

attach() public abstract method

Прикрепляет существующий файл к сообщению электронной почты.

public abstract $this attach ( $fileName, array $options = [] )
$fileName	string	Полное имя файла
$options	array	Параметры для встраивания файла. Допустимые параметры: fileName: имя, которое должно быть использовано для прикрепления файла. contentType: MIME-тип прикрепляемого файла.
return	$this	Ссылка на себя.

public abstract $this attach ( $fileName, array $options = [] )

$fileName

string

Полное имя файла

$options

array

Параметры для встраивания файла. Допустимые параметры:

fileName: имя, которое должно быть использовано для прикрепления файла.
contentType: MIME-тип прикрепляемого файла.

return

$this

Ссылка на себя.

attachContent() public abstract method

Прикрепляет указанное содержимое как файл к сообщению электронной почты.

public abstract $this attachContent ( $content, array $options = [] )
$content	string	Содержимое файла-вложения.
$options	array	Параметры для встраивания файла. Допустимые параметры: fileName: имя, которое должно быть использовано для прикрепления файла. contentType: MIME-тип прикрепляемого файла.
return	$this	Ссылка на себя.

public abstract $this attachContent ( $content, array $options = [] )

$content

string

Содержимое файла-вложения.

$options

array

Параметры для встраивания файла. Допустимые параметры:

fileName: имя, которое должно быть использовано для прикрепления файла.
contentType: MIME-тип прикрепляемого файла.

return

$this

Ссылка на себя.

embed() public abstract method

Прикрепляет файл и возвращает его CID-источник.

Этот метод следует использовать при встраивании изображений или других данных в сообщение.

public abstract string embed ( $fileName, array $options = [] )
$fileName	string	Имя файла.
$options	array	Параметры для встраивания файла. Допустимые параметры: fileName: имя, которое должно быть использовано для прикрепления файла. contentType: MIME-тип прикрепляемого файла.
return	string	CID вложения.

public abstract string embed ( $fileName, array $options = [] )

$fileName

string

Имя файла.

$options

array

Параметры для встраивания файла. Допустимые параметры:

fileName: имя, которое должно быть использовано для прикрепления файла.
contentType: MIME-тип прикрепляемого файла.

return

string

CID вложения.

embedContent() public abstract method

Прикрепляет содержимое как файл и возвращает его CID-источник.

Этот метод следует использовать при встраивании изображений или других данных в сообщение.

public abstract string embedContent ( $content, array $options = [] )
$content	string	Содержимое файла-вложения.
$options	array	Параметры для встраивания файла. Допустимые параметры: fileName: имя, которое должно быть использовано для прикрепления файла. contentType: MIME-тип прикрепляемого файла.
return	string	CID вложения.

public abstract string embedContent ( $content, array $options = [] )

$content

string

Содержимое файла-вложения.

$options

array

Параметры для встраивания файла. Допустимые параметры:

fileName: имя, которое должно быть использовано для прикрепления файла.
contentType: MIME-тип прикрепляемого файла.

return

string

CID вложения.

getBcc() public abstract method

Возвращает адреса получателей Bcc (скрытая копия) этого сообщения.

public abstract array getBcc ( )
return	array	Адреса получателей Bcc (скрытая копия) этого сообщения.

getCc() public abstract method

Возвращает адреса получателей Cc (дополнительная копия) этого сообщения.

public abstract array getCc ( )
return	array	Адреса получателей Cc (дополнительная копия) этого сообщения.

getCharset() public abstract method

Возвращает кодировку символов этого сообщения.

public abstract string getCharset ( )
return	string	Кодировка символов этого сообщения.

getFrom() public abstract method

Возвращает отправителя сообщения.

public abstract string getFrom ( )
return	string	Отправитель

getReplyTo() public abstract method

Возвращает адрес ответа для этого сообщения.

public abstract string getReplyTo ( )
return	string	Адрес ответа для этого сообщения.

getSubject() public abstract method

Возвращает тему сообщения.

public abstract string getSubject ( )
return	string	Тема сообщения

getTo() public abstract method

Возвращает получателя(ей) сообщения.

public abstract array getTo ( )
return	array	Получатели сообщения

send() public abstract method

Отправляет это электронное сообщение.

public abstract boolean send ( yii\mail\MailerInterface $mailer = null )
$mailer	yii\mail\MailerInterface	Отправитель, который должен быть использован для отправки этого сообщения. Если null, будет использован компонент приложения "mail".
return	boolean	Успешно ли отправлено это сообщение.

setBcc() public abstract method

Устанавливает адреса получателей Bcc (скрытая копия) этого сообщения.

public abstract $this setBcc ( $bcc )
$bcc	string\|array	Адрес электронной почты скрытого получателя копии. Можно передать массив адресов, если несколько получателей должны получить это сообщение. Также можно указать имя получателя дополнительно к адресу электронной почты, используя формат: `[email => name]`.
return	$this	Ссылка на себя.

setCc() public abstract method

Устанавливает адреса получателей Cc (дополнительная копия) этого сообщения.

public abstract $this setCc ( $cc )
$cc	string\|array	Адрес электронной почты получателя копии. Можно передать массив адресов, если несколько получателей должны получить это сообщение. Также можно указать имя получателя дополнительно к адресу электронной почты, используя формат: `[email => name]`.
return	$this	Ссылка на себя.

setCharset() public abstract method

Устанавливает кодировку символов этого сообщения.

public abstract $this setCharset ( $charset )
$charset	string	Имя кодировки символов.
return	$this	Ссылка на себя.

setFrom() public abstract method

Устанавливает отправителя сообщения.

public abstract $this setFrom ( $from )
$from	строка\|массив	Адрес электронной почты отправителя. Вы можете передать массив адресов, если это сообщение отправлено от нескольких человек. Также вы можете указать имя отправителя в дополнение к адресу электронной почты, используя формат: `[email => name]`.
return	$this	Ссылка на себя.

setHtmlBody() public abstract method

Устанавливает HTML-содержимое сообщения.

public abstract $this setHtmlBody ( $html )
$html	строка	HTML-содержимое сообщения.
return	$this	Ссылка на себя.

setReplyTo() public abstract method

Устанавливает адрес ответа для этого сообщения.

public abstract $this setReplyTo ( $replyTo )
$replyTo	строка\|массив	Адрес ответа. Вы можете передать массив адресов, если на это сообщение должно быть несколько ответов. Также вы можете указать имя адресата ответа в дополнение к адресу электронной почты, используя формат: `[email => name]`.
return	$this	Ссылка на себя.

setSubject() public abstract method

Устанавливает тему сообщения.

public abstract $this setSubject ( $subject )
$subject	строка	Тема сообщения
return	$this	Ссылка на себя.

setTextBody() public abstract method

Устанавливает текстовое содержимое сообщения.

public abstract $this setTextBody ( $text )
$text	строка	Текстовое содержимое сообщения.
return	$this	Ссылка на себя.

setTo() public abstract method

Устанавливает получателя(ей) сообщения.

public abstract $this setTo ( $to )
$to	строка\|массив	Адрес электронной почты получателя. Вы можете передать массив адресов, если это сообщение должно быть доставлено нескольким получателям. Вы также можете указать имя получателя в дополнение к адресу электронной почты, используя формат: `[email => name]`.
return	$this	Ссылка на себя.

toString() public abstract method

Возвращает строковое представление этого сообщения.

public abstract строка toString ( )
return	строка	Строковое представление этого сообщения.

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