Класс SmtpTransport

__destructsource public

__destruct( )

Деструктор

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

_authsource protected

_auth( )

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

Исключения

Cake\Network\Exception\SocketException
\Cake\Network\Exception\SocketException

_bufferResponseLinessource protected

_bufferResponseLines( array $responseLines )

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

Параметры

массив $responseLines

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

_connectsource protected

_connect( )

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

Исключения

Cake\Network\Exception\SocketException
\Cake\Network\Exception\SocketException

_disconnectsource protected

_disconnect( )

Отключение

Исключения

Cake\Network\Exception\SocketException
\Cake\Network\Exception\SocketException

_generateSocketsource protected

_generateSocket( )

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

Исключения

Cake\Network\Exception\SocketException
\Cake\Network\Exception\SocketException

_prepareFromAddresssource protected

_prepareFromAddress( Cake\Mailer\Email $email )

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

Параметры

Cake\Mailer\Email $email

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

Возвращает

array
массив

_prepareFromCmdsource protected

_prepareFromCmd( string $email )

Подготавливает команду SMTP MAIL FROM.

Параметры

строка $email

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

Возвращает

string
строка

_prepareMessagesource protected

_prepareMessage( Cake\Mailer\Email $email )

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

Параметры

Cake\Mailer\Email $email

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

Возвращает

string
строка

_prepareMessageHeaderssource protected

_prepareMessageHeaders( Cake\Mailer\Email $email )

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

Параметры

Cake\Mailer\Email $email

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

Возвращает

array
массив

_prepareRcptCmdsource protected

_prepareRcptCmd( string $email )

Подготавливает команду SMTP RCPT TO.

Параметры

строка $email

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

Возвращает

string
строка

_prepareRecipientAddressessource protected

_prepareRecipientAddresses( Cake\Mailer\Email $email )

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

Параметры

Cake\Mailer\Email $email

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

Возвращает

array
массив

_sendDatasource protected

_sendData( Cake\Mailer\Email $email )

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

Параметры

Cake\Mailer\Email $email

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

Исключения

Cake\Network\Exception\SocketException
\Cake\Network\Exception\SocketException

_sendRcptsource protected

_sendRcpt( Cake\Mailer\Email $email )

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

Параметры

Cake\Mailer\Email $email

Cake Email

Исключения

Cake\Network\Exception\SocketException
\Cake\Network\Exception\SocketException

_smtpSendsource protected

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

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

Параметры

строка|null $data

Данные, которые нужно отправить на SMTP-сервер

строка|булево $checkCode необязательно '250'

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

Возвращает

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

Исключения

Cake\Network\Exception\SocketException
\Cake\Network\Exception\SocketException

connectsource public

connect( )

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

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

connectedsource public

connected( )

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

Возвращает

boolean
bool

disconnectsource public

disconnect( )

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

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

getLastResponsesource public

getLastResponse( )

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

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

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

Возвращает

array
массив

sendsource public

send( Cake\Mailer\Email $email )

Отправка почты

Параметры

Cake\Mailer\Email $email

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

Возвращает

array
массив

Исключения

Cake\Network\Exception\SocketException
\Cake\Network\Exception\SocketException

__constructsource public

__construct( array $config [] )

Конструктор

Параметры

массив $config необязательно []

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

_headersToStringsource protected

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

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

Параметры

массив $headers

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

строка $eol необязательно "\r\n"

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

Возвращает

string
строка

_configDeletesource protected

_configDelete( string $key )

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

Параметры

строка $key

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

Исключение

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

_configReadsource protected

_configRead( string|null $key )

Чтение переменной конфигурации

Параметры

строка|null $key

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

Возвращает

mixed
смешанное значение

_configWritesource protected

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

Запись переменной конфигурации

Параметры

строка|массив $key

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

смешанное значение $value

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

логическое значение|строка $merge необязательно false

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

Исключение

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

configsource 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

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

Возвращает

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

Исключение

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

configShallowsource 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

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

Возвращает

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

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

[]

[]

false