Класс MailTransport

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

Пространство имён: Cake\Mailer\Transport

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

$_config protected

array<string, mixed>

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

bool

Инициализирована ли конфигурация свойства значениями по умолчанию
$_defaultConfig protected

array<string, mixed>

Конфигурация по умолчанию для данного класса

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

__construct() public

Конструктор
_configDelete() protected

Удаляет один ключ конфигурации.
_configRead() protected

Считывает ключ конфигурации.
_configWrite() protected

Записывает ключ конфигурации.
_mail() protected

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

Проверяет, что установлен хотя бы один заголовок назначения.
configShallow() public

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

Возвращает конфигурацию.
getConfigOrFail() public

Возвращает конфигурацию для этого конкретного ключа.
send() public

Отправить письмо
setConfig() public

Устанавливает конфигурацию.

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

__construct() public

__construct(array<string, mixed> $config = [])

Конструктор

Параметры

array<string, mixed> $config необязательный: Параметры конфигурации.

_configDelete() protected

_configDelete(string $key): void

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

Параметры

string $key: Ключ для удаления.

Возвращает

void

Выбрасывает

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

_configRead() protected

_configRead(string|null $key): mixed

Считывает ключ конфигурации.

Параметры

string|null $key: Ключ для считывания.

Возвращает

mixed

_configWrite() protected

_configWrite(array<string, mixed>|string $key, mixed $value, string|bool $merge = false): void

Записывает ключ конфигурации.

Параметры

array<string, mixed>|string $key: Ключ для записи.
mixed $value: Значение для записи.
string|bool $merge необязательный: Истинно для рекурсивного объединения, 'shallow' для простого объединения, ложно для перезаписи, по умолчанию ложно.

Возвращает

void

Выбрасывает

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

_mail() protected

_mail(string $to, string $subject, string $message, string $headers = '', string $params = ''): void

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

Параметры

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

Возвращает

void

Выбрасывает

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

checkRecipient() protected

checkRecipient(Cake\Mailer\Message $message): void

Проверяет, что установлен хотя бы один заголовок назначения.

Параметры

Cake\Mailer\Message $message: Экземпляр сообщения.

Возвращает

void

Выбрасывает

Cake\Core\Exception\CakeException
Если не указан хотя бы один из to, cc или bcc.

configShallow() public

configShallow(array<string, mixed>|string $key, mixed|null $value = null): $this

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

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

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

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

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

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

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

Параметры

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

Возвращает

$this

getConfig() public

getConfig(string|null $key = null, mixed $default = null): mixed

Возвращает конфигурацию.

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

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

$this->getConfig();

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

$this->getConfig('key');

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

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

Чтение со значением по умолчанию:

$this->getConfig('some-key', 'default-value');

Параметры

string|null $key необязательный: Ключ для получения или null для всей конфигурации.
mixed $default необязательный: Возвращаемое значение, когда ключ не существует.

Возвращает

mixed

getConfigOrFail() public

getConfigOrFail(string $key): mixed

Возвращает конфигурацию для этого конкретного ключа.

Значение конфигурации для этого ключа должно существовать, оно никогда не может быть null.

Параметры

string $key: Ключ для получения.

Возвращает

mixed

Выбрасывает

InvalidArgumentException

send() public

send(Cake\Mailer\Message $message): array

Отправить письмо

Параметры

Cake\Mailer\Message $message

Возвращает

array

setConfig() public

setConfig(array<string, mixed>|string $key, mixed|null $value = null, bool $merge = true): $this

Устанавливает конфигурацию.

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

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

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

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

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

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

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

Параметры

array<string, mixed>|string $key: Ключ для установки или полный массив конфигураций.
mixed|null $value необязательный: Значение для установки.
bool $merge необязательный: Выполнять рекурсивное объединение или перезаписывать существующую конфигурацию, по умолчанию истинно.

Возвращает

$this

Выбрасывает

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

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

`$_config` protected

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

Тип

array<string, mixed>

`$_configInitialized` protected

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

Тип

bool

`$_defaultConfig` protected

Конфигурация по умолчанию для этого класса

Тип

array<string, mixed>

© 2005–present 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/4.4/class-Cake.Mailer.Transport.MailTransport.html

Класс MailTransport

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

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

__construct() public

_configDelete() protected

_configRead() protected

_configWrite() protected

_mail() protected

checkRecipient() protected

configShallow() public

getConfig() public

getConfigOrFail() public

send() public

setConfig() public

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

__construct() public

Параметры

_configDelete() protected

Параметры

Возвращает

Выбрасывает

_configRead() protected

Параметры

Возвращает

_configWrite() protected

Параметры

Возвращает

Выбрасывает

_mail() protected

Параметры

Возвращает

Выбрасывает

checkRecipient() protected

Параметры

Возвращает

Выбрасывает

configShallow() public

Параметры

Возвращает

getConfig() public

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

Параметры

Возвращает

getConfigOrFail() public

Параметры

Возвращает

Выбрасывает

send() public

Параметры

Возвращает

setConfig() public

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

Параметры

Возвращает

Выбрасывает

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

$_config protected

Тип

$_configInitialized protected

Тип

$_defaultConfig protected

Тип

`$_config` protected

`$_configInitialized` protected

`$_defaultConfig` protected