Класс 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

Экземпляр 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

Экземпляр 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']);

Параметры

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->config('key', $value);

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

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

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

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

Параметры

string|array $key

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

mixed|null $value optional null

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

Возвращает

$this Сам объект.

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

[]