Класс SmtpTransport

__destruct()source public

__destruct( )

Деструктор

Попытка отключения для обеспечения надлежащего завершения соединения перед закрытием сокета.

_auth()source protected

_auth( )

Отправка аутентификации

Исключения

Cake\Network\Exception\SocketException

_bufferResponseLines()source protected

_bufferResponseLines( array $responseLines )

Разбирает и сохраняет строки ответа в формате 'code' => 'message'.

Параметры

массив $responseLines

Строки ответа для разбора.

_connect()source protected

_connect( )

Подключение к серверу SMTP

Исключения

Cake\Network\Exception\SocketException

_disconnect()source protected

_disconnect( )

Отключение

Исключения

Cake\Network\Exception\SocketException

_generateSocket()source protected

_generateSocket( )

Вспомогательный метод для создания сокета

Исключения

Cake\Network\Exception\SocketException

_prepareFromAddress()source protected

_prepareFromAddress( Cake\Mailer\Email $email )

Подготавливает адрес электронной почты отправителя.

Параметры

Cake\Mailer\Email $email

Экземпляр электронной почты

Возвращаемое значение

массив

_prepareFromCmd()source protected

_prepareFromCmd( string $email )

Подготавливает команду SMTP для отправителя.

Параметры

строка $email

Адрес электронной почты для отправки с командой.

Возвращаемое значение

строка

_prepareMessage()source protected

_prepareMessage( Cake\Mailer\Email $email )

Подготавливает тело сообщения.

Параметры

Cake\Mailer\Email $email

Экземпляр электронной почты

Возвращаемое значение

строка

_prepareMessageHeaders()source protected

_prepareMessageHeaders( Cake\Mailer\Email $email )

Подготавливает заголовки сообщения.

Параметры

Cake\Mailer\Email $email

Экземпляр электронной почты

Возвращаемое значение

массив

_prepareRcptCmd()source protected

_prepareRcptCmd( string $email )

Подготавливает команду SMTP для получателей.

Параметры

строка $email

Адрес электронной почты для отправки с командой.

Возвращаемое значение

строка

_prepareRecipientAddresses()source protected

_prepareRecipientAddresses( Cake\Mailer\Email $email )

Подготавливает адреса электронной почты получателей.

Параметры

Cake\Mailer\Email $email

Экземпляр электронной почты

Возвращаемое значение

массив

_sendData()source protected

_sendData( Cake\Mailer\Email $email )

Отправка данных

Параметры

Cake\Mailer\Email $email

Экземпляр электронной почты

Исключения

Cake\Network\Exception\SocketException

_sendRcpt()source protected

_sendRcpt( Cake\Mailer\Email $email )

Отправка электронных писем

Параметры

Cake\Mailer\Email $email

Cake Email

Исключения

Cake\Network\Exception\SocketException

_smtpSend()source protected

_smtpSend( string|null $data , string|boolean $checkCode '250' )

Защищенный метод для отправки данных на SMTP-соединение

Параметры

string|null $data

Данные, которые будут отправлены на SMTP-сервер

string|boolean $checkCode optional '250'

Код для проверки в ответ сервера, false — пропустить

Возвращает

string|null
Соответствующий код или null, если ничего не найдено

Исключения

Cake\Network\Exception\SocketException

connect()source public

connect( )

Подключение к SMTP-серверу.

Этот метод пытается подключиться только в том случае, если уже нет открытого соединения.

connected()source public

connected( )

Проверка наличия открытого соединения с SMTP-сервером.

Возвращает

boolean

disconnect()source public

disconnect( )

Отключение от SMTP-сервера.

Этот метод пытается отключиться только в том случае, если открытое соединение есть.

getLastResponse()source public

getLastResponse( )

Возвращает ответ последней отправленной SMTP-команды.

Ответ состоит из одной или нескольких строк, содержащих код ответа и необязательный текст сообщения ответа:

[
    [
        'code' => '250',
        'message' => 'mail.example.com'
    ],
    [
        'code' => '250',
        'message' => 'PIPELINING'
    ],
    [
        'code' => '250',
        'message' => '8BITMIME'
    ],
    // etc...
]

Возвращает

array

send()source public

send( Cake\Mailer\Email $email )

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

Параметры

Cake\Mailer\Email $email

Экземпляр электронной почты

Возвращает

array

Исключения

Cake\Network\Exception\SocketException

__construct()source public

__construct( array $config [] )

Конструктор

Параметры

array $config optional []

Параметры конфигурации.

_headersToString()source protected

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

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

Параметры

array $headers

Заголовки в формате ключ => значение

string $eol optional "\r\n"

Строка конца строки.

Возвращает

string

_configDelete()source protected

_configDelete( string $key )

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

Параметры

string $key

Ключ для удаления.

Исключения

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

_configRead()source protected

_configRead( string|null $key )

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

Параметры

string|null $key

Ключ для чтения.

Возвращает

mixed

_configWrite()source protected

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

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

Параметры

string|array $key

Ключ для записи.

mixed $value

Значение для записи.

boolean|string $merge optional false

True для рекурсивного слияния, 'shallow' для простого слияния, false для перезаписи, по умолчанию false.

Исключения

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']);

Устаревшее

3.4.0 используйте setConfig()/getConfig() вместо.

Параметры

string|array|null $key optional null

Ключ для получения/установки или полный массив конфигураций.

mixed|null $value optional null

Значение для установки.

boolean $merge optional true

Производить ли рекурсивное слияние или перезапись существующей конфигурации, по умолчанию true.

Возвращает

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

Исключения

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

configShallow()source public

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

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

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

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

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

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

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

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

Параметры

string|array $key

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

mixed|null $value optional null

Значение для установки.

Возвращает

$this

getConfig()source public

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

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

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

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

$this->getConfig();

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

$this->getConfig('key');

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

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

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

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

Параметры

string|null $key optional null

Ключ для получения или null для всей конфигурации.

mixed $default optional null

Возвращаемое значение, когда ключ не существует.

Возвращает

mixed
Значение конфигурации, которое считывается.

setConfig()source public

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

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

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

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

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

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

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

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

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

Параметры

string|array $key

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

mixed|null $value необязательно null

Значение для установки.

boolean $merge необязательно true

Включить рекурсивное слияние или перезапись существующей конфигурации, по умолчанию значение true.

Возвращаемое значение

$this

Исключения

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

[]

[
    'host' => 'localhost',
    'port' => 25,
    'timeout' => 30,
    'username' => null,
    'password' => null,
    'client' => null,
    'tls' => false,
    'keepAlive' => false
]

[]