Spec-Zone.ru › CakePHP 3.1

Класс MailTransport

Отправка почты с использованием функции mail()

Cake\Mailer\AbstractTransport использует Cake\Core\InstanceConfigTrait
Extended by Cake\Mailer\Transport\MailTransport
Пространство имён: Cake\Mailer\Transport
Расположение: Mailer/Transport/MailTransport.php

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

_mailисходный код protected

_mail( string $to , string $subject , string $message , string $headers , string|null $params null )

Оборачивает внутреннюю функцию mail() и генерирует исключение вместо ошибок, если что-то пойдёт не так

Параметры

строка $to
Получатель электронного письма
строка $subject
Тема электронного письма
строка $message
Тело электронного письма
строка $headers
Пользовательские заголовки электронного письма
строка|null $params необязательно null
Дополнительные параметры для отправки электронного письма

Исключения

Cake\Network\Exception\SocketException
если почта не была отправлена

sendисходный код public

send( Cake\Mailer\Email $email )

Отправить почту

Параметры

Cake\Mailer\Email $email
Cake Email

Возвращает

array
массив

Методы, унаследованные от Cake\Mailer\AbstractTransport

__constructисходный код public

__construct( array $config [] )

Конструктор

Параметры

массив $config необязательно []
Настройки конфигурации.

_headersToStringисходный код protected

_headersToString( array $headers , string $eol "\r\n" )

Помогает преобразовать заголовки в строку

Параметры

массив $headers
Заголовки в формате ключ => значение
строка $eol необязательно "\r\n"
Строка конца строки.

Возвращает

string
строка

Методы, используемые из Cake\Core\InstanceConfigTrait

_configDeleteисходный код protected

_configDelete( string $key )

Удаление одного ключа конфигурации

Параметры

строка $key
Ключ для удаления.

Исключения

Cake\Core\Exception\Exception
если происходит попытка перезаписи существующей конфигурации

_configReadисходный код protected

_configRead( string|null $key )

Чтение переменной конфигурации

Параметры

строка|null $key
Ключ для чтения.

Возвращает

mixed
смешанный тип

_configWriteисходный код protected

_configWrite( string|array $key , mixed $value , boolean|string $merge false )

Запись переменной конфигурации

Параметры

строка|массив $key
Ключ для записи.
смешанный тип $value
Значение для записи.
boolean|строка $merge необязательно false
True для рекурсивной слияния, 'shallow' для простого слияния, false для перезаписи, по умолчанию false.

Исключения

Cake\Core\Exception\Exception
если происходит попытка перезаписи существующей конфигурации

configисходный код public

config( string|array|null $key null , mixed|null $value null , boolean $merge true )

Использование

Чтение всей конфигурации:

$this->config();

Чтение определённого значения:

$this->config('key');

Чтение вложенного значения:

$this->config('some.nested.key');

Установка определённого значения:

$this->config('key', $value);

Установка вложенного значения:

$this->config('some.nested.key', $value);

Обновление нескольких настроек конфигурации одновременно:

$this->config(['one' => 'value', 'another' => 'value']);

Параметры

строка|массив|null $key необязательно null
Ключ для получения/установки или весь массив конфигурации.
смешанный тип|null $value необязательно null
Значение для установки.
boolean $merge необязательно true
Производить рекурсивное слияние или перезапись существующей конфигурации, по умолчанию true.

Возвращает

mixed
Значение конфигурации, которое читается, или сам объект при операциях записи.

Исключения

Cake\Core\Exception\Exception
При попытке установить неверный ключ.

configShallowисходный код public

configShallow( string|array $key , mixed|null $value null )

Объединяет предоставленную конфигурацию с существующей конфигурацией. В отличие от config(), которая выполняет рекурсивное слияние вложенных ключей, этот метод выполняет простое слияние.

Установка определённого значения:

$this->config('key', $value);

Установка вложенного значения:

$this->config('some.nested.key', $value);

Обновление нескольких настроек конфигурации одновременно:

$this->config(['one' => 'value', 'another' => 'value']);

Параметры

строка|массив $key
Ключ для установки или весь массив конфигурации.
смешанный тип|null $value необязательно null
Значение для установки.

Возвращает

mixed
$this Сам объект.

Свойства, унаследованные от Cake\Mailer\AbstractTransport

$_defaultConfigисходный код

protected массив

Значения по умолчанию для данного класса

[]

Свойства, используемые из Cake\Core\InstanceConfigTrait

$_configисходный код

protected массив

Конфигурация во время выполнения

[]

$_configInitializedисходный код

protected boolean

Указывает, была ли уже настроена конфигурация с использованием значений по умолчанию

false

© 2005–2016 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
http://api.cakephp.org/3.1/class-Cake.Mailer.Transport.MailTransport.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API