Класс yii\swiftmailer\Message

public array getBcc ( )
public $this setBcc ( $bcc )

public array getCc ( )
public $this setCc ( $cc )

public string getCharset ( )
public $this setCharset ( $charset )

public string getFrom ( )
public $this setFrom ( $from )

public $this setHeaders ( $headers )

public $this setHtmlBody ( $html )

public integer getPriority ( )
public $this setPriority ( $priority )

public string getReadReceiptTo ( )
public $this setReadReceiptTo ( $addresses )

public string getReplyTo ( )
public $this setReplyTo ( $replyTo )

public string getReturnPath ( )
public $this setReturnPath ( $address )

public $this setSignature ( $signature )

public string getSubject ( )
public $this setSubject ( $subject )

public \Swift_Message getSwiftMessage ( )

public $this setTextBody ( $text )

public array getTo ( )
public $this setTo ( $to )

__clone() метод public (доступен с версии 2.0.7)

Этот метод вызывается после создания объекта путем клонирования существующего.

Он гарантирует, что $swiftMessage также будет клонирован.

public void __clone ( )

addHeader() метод public (доступен с версии 2.0.6)

Добавляет значение пользовательского заголовка в сообщение.

Несколько вызовов этого метода с одинаковым именем добавят несколько значений заголовка.

public $this addHeader ( $name, $value )
$name	строка	Имя заголовка.
$value	строка	Значение заголовка.
return	$this	Ссылка на себя.

addSignature() метод public (доступен с версии 2.0.6)

Добавляет подпись к сообщению.

public $this addSignature ( $signature )
$signature	массив|вызываемый объект|\Swift_Signer	Настройка подписи, это может быть: \Swift_Signer экземпляр вызываемый объект, возвращающий \Swift_Signer экземпляр массив конфигурации для создания подписывающего средства
return	$this	Ссылка на себя
throws	yii\base\InvalidConfigException	при неверной конфигурации подписи

attach() метод public

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

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

attachContent() метод public

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

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

createSwiftMessage() метод protected

Создаёт экземпляр сообщения Swift для электронной почты.

protected \Swift_Message createSwiftMessage ( )
return	\Swift_Message	Экземпляр сообщения электронной почты.

createSwiftSigner() метод protected (доступен с версии 2.0.6)

Создаёт подписывающее средство из его конфигурации

protected \Swift_Signer createSwiftSigner ( $signature )
$signature	массив	Конфигурация подписи
return	\Swift_Signer	Экземпляр подписывающего средства
throws	yii\base\InvalidConfigException	при неверной предоставленной конфигурации

embed() метод public

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

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

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

embedContent() метод public

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

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

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

getBcc() метод public

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

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

getCc() метод public

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

public массив getCc ( )
return	массив	Адреса Cc (дополнительные получатели) этого сообщения.

getCharset() метод public

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

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

getFrom() метод public

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

public строка getFrom ( )
return	строка	Отправитель

getHeader() метод public (доступен с версии 2.0.6)

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

public массив getHeader ( $name )
$name	строка	Имя заголовка.
return	массив	Список значений заголовка.

getPriority() метод public (доступен с версии 2.0.6)

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

public целое число getPriority ( )
return	целое число	Значение приоритета как целое число в диапазоне: 1..5, где 1 — наивысший приоритет, а 5 — наименьший.

getReadReceiptTo() метод public (доступен с версии 2.0.6)

Получает адреса, которым будет отправлено подтверждение о прочтении.

public string getReadReceiptTo ( )
return	string	Адреса электронной почты для получения подтверждения прочтения.

getReplyTo() public method

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

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

getReturnPath() public method (available since version 2.0.6)

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

public string getReturnPath ( )
return	string	Адрес электронной почты для уведомлений о возврате.

getSubject() public method

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

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

getSwiftMessage() public method

public \Swift_Message getSwiftMessage ( )
return	\Swift_Message	Экземпляр Swift-сообщения.

getTo() public method

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

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

setBcc() public method

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

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

setBody() protected method

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

Если тело уже установлено и его тип содержимого соответствует заданному, оно будет перезаписано; если тип содержимого не совпадает, будет создано составное сообщение.

protected void setBody ( $body, $contentType )
$body	string	Содержимое тела.
$contentType	string	Тип содержимого тела.

setCc() public method

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

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

setCharset() public method

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

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

setFrom() public method

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

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

setHeader() public method (available since version 2.0.6)

Устанавливает значение пользовательского заголовка сообщения.

public $this setHeader ( $name, $value )
$name	string	Имя заголовка.
$value	string|array	Значение или значения заголовка.
return	$this	Ссылка на себя.

setHeaders() public method (available since version 2.0.7)

Устанавливает значения пользовательских заголовков сообщения.

public $this setHeaders ( $headers )
$headers	array	Заголовки в формате: [name => value].
return	$this	Ссылка на себя.

setHtmlBody() public method

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

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

setPriority() public method (available since version 2.0.6)

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

public $this setPriority ( $priority )
$priority	integer	Значение приоритета, должно быть целым числом в диапазоне: 1..5, где 1 — самый высокий приоритет, а 5 — самый низкий.
return	$this	Ссылка на себя.

setReadReceiptTo() public method (available since version 2.0.6)

Устанавливает запрос подтверждения доставки от получателя, который будет отправлен по адресам $addresses.

public $this setReadReceiptTo ( $addresses )
$addresses	string|array	Адрес(а) электронной почты для получения подтверждения прочтения.
return	$this	Ссылка на себя.

setReplyTo() public method

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

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

setReturnPath() public method (available since version 2.0.6)

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

public $this setReturnPath ( $address )
$address	строка	Адрес электронной почты для ответов.
return	$this	Ссылка на себя.

setSignature() public method (доступно с версии 2.0.6)

Устанавливает подпись сообщения

public $this setSignature ( $signature )
$signature	массив|обратный вызов|\Swift_Signer	Параметры подписи. Подробное описание того, как следует их указать, см. в addSignature().
return	$this	Ссылка на себя.

setSubject() public method

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

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

setTextBody() public method

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

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

setTo() public method

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

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

toString() public method

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

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