Spec-Zone.ru › CakePHP 3.3

Класс MailTransport

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

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

Наследуемые свойства

  • _defaultConfig _config, _configInitialized

Краткое описание методов

  • _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

Возвращает

массив

Методы, унаследованные от 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–2017 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.
https://api.cakephp.org/3.3/class-Cake.Mailer.Transport.MailTransport.html

Spec-Zone.ru

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