Spec-Zone.ru › CakePHP 3.2

Класс MailTransport

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

Cake\Mailer\AbstractTransport использует Cake\Core\InstanceConfigTrait
Extended by 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 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

Spec-Zone.ru

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