Класс MailTransport
Отправка почты с помощью функции mail()
- Cake\Mailer\AbstractTransport использует Cake\Core\InstanceConfigTrait
-
Cake\Mailer\Transport\MailTransport
Унаследованные свойства
Краткое описание методов
- _mail() protectedОборачивает внутреннюю функцию mail() и выбрасывает исключение вместо ошибок, если что-то пойдёт не так
- send() publicОтправка почты
Подробное описание методов
_mail()source 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()source public
send( Cake\Mailer\Email $email )
Отправка почты
Параметры
-
Cake\Mailer\Email$email - Cake Email
Возвращает
массивУнаследованные методы из Cake\Mailer\AbstractTransport
__construct()source public
__construct( array $config [] )
Конструктор
Параметры
- массив
$configнеобязательно [] - Параметры конфигурации.
_headersToString()source protected
_headersToString( array $headers , string $eol "\r\n" )
Помогает преобразовать заголовки в строку
Параметры
- массив
$headers - Заголовки в формате ключ => значение
- строка
$eolнеобязательно "\r\n" - Строка конца строки.
Возвращает
строкаМетоды, используемые из Cake\Core\InstanceConfigTrait
_configDelete()source protected
_configDelete( string $key )
Удаление одного ключа конфигурации
Параметры
- строка
$key - Ключ для удаления.
Исключения
Cake\Core\Exception\Exceptionпри попытке перезаписи существующей конфигурации
_configRead()source protected
_configRead( string|null $key )
Чтение переменной конфигурации
Параметры
- строка|null
$key - Ключ для чтения.
Возвращает
смешанное_configWrite()source protected
_configWrite( string|array $key , mixed $value , boolean|string $merge false )
Запись переменной конфигурации
Параметры
- строка|массив
$key - Ключ для записи.
- смешанное
$value - Значение для записи.
- логическое|строка
$mergeнеобязательно false Истина для рекурсивного слияния, 'shallow' для простого слияния, ложь для перезаписи, по умолчанию ложь.
Исключения
Cake\Core\Exception\Exceptionпри попытке перезаписи существующей конфигурации
config()source 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 - Значение для установки.
- логическое
$mergeнеобязательно true - Выполнять ли рекурсивное слияние или перезапись существующей конфигурации, по умолчанию истинно.
Возвращает
смешанноеЗначение считанной конфигурации или сам объект при операциях записи.
Исключения
Cake\Core\Exception\ExceptionПри попытке установить недопустимый ключ.
configShallow()source 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 - Значение для установки.
Возвращает
$this Объект сам по себе.
© 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.2/class-Cake.Mailer.Transport.MailTransport.html