Класс 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 необязательно '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 необязательно []

Настройки конфигурации.

_headersToString()source protected

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

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

Параметры

array $headers

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

string $eol необязательно "\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 необязательно 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 необязательно null

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

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

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

boolean $merge необязательно 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 необязательно null

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

Возвращает

$this Объект самого себя.

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

[]