Класс SmtpTransport

Отправка почты с использованием протокола SMTP

SmtpTransport

Пакет: Cake\Network\Email
Авторские права: Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
Лицензия: MIT License
Расположение: Cake/Network/Email/SmtpTransport.php

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

$_content protected

string
Содержимое почтового сообщения для возврата
$_lastResponse protected

array
Ответ последней отправленной команды SMTP.
$_socket protected

CakeSocket
Сокет к серверу SMTP

Наследованные свойства

_config

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

_auth() protected
Отправить аутентификацию
_bufferResponseLines() protected
Парсит и сохраняет строки ответа в формате 'code' => 'message'.
_connect() protected
Подключиться к серверу SMTP
_disconnect() protected
Отключиться
_generateSocket() protected
Вспомогательный метод для создания сокета
_prepareFromAddress() protected
Подготавливает адрес электронной почты отправителя.
_prepareFromCmd() protected
Подготавливает команду SMTP для отправителя.
_prepareMessage() protected
Подготавливает тело сообщения.
_prepareMessageHeaders() protected
Подготавливает заголовки сообщения.
_prepareRcptCmd() protected
Подготавливает команду SMTP для получателей.
_prepareRecipientAddresses() protected
Подготавливает адреса электронной почты получателей.
_sendData() protected
Отправка данных
_sendRcpt() protected
Отправка электронной почты
_smtpSend() protected
Защищенный метод для отправки данных на SMTP-соединение
config() public
Установить конфигурацию
getLastResponse() public
Возвращает ответ последней отправленной команды SMTP.
send() public
Отправить почту

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

_auth()source protected

_auth( )

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

Исключения

SocketException

_bufferResponseLines()source protected

_bufferResponseLines( array $responseLines )

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

Параметры

массив $responseLines: Строки ответа для парсинга.

END_OF_DOCUMENT_MARKER

_connect()source protected

_connect( )

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

Возможные исключения

SocketException

_disconnect()source protected

_disconnect( )

Отключение

Возможные исключения

SocketException

_generateSocket()source protected

_generateSocket( )

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

Возможные исключения

SocketException

_prepareFromAddress()source protected

_prepareFromAddress( CakeEmail $email )

Подготовка адреса отправок from электронного письма.

Параметры

CakeEmail $email: CakeEmail

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

array

_prepareFromCmd()source protected

_prepareFromCmd( string $email )

Подготовка команды SMTP для MAIL FROM адреса.

Параметры

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

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

строка

_prepareMessage()source protected

_prepareMessage( CakeEmail $email )

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

Параметры

CakeEmail $email: CakeEmail

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

строка

_prepareMessageHeaders()source protected

_prepareMessageHeaders( CakeEmail $email )

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

Параметры

CakeEmail $email: CakeEmail

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

массив

_prepareRcptCmd()source protected

_prepareRcptCmd( string $email )

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

Параметры

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

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

строка

_prepareRecipientAddresses()source protected

_prepareRecipientAddresses( CakeEmail $email )

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

Параметры

CakeEmail $email: CakeEmail

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

массив

_sendData()source protected

_sendData( CakeEmail $email )

Отправить данные

Параметры

CakeEmail $email: CakeEmail

Возможные исключения

SocketException

_sendRcpt()source protected

_sendRcpt( CakeEmail $email )

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

Параметры

CakeEmail $email: CakeEmail

Возможные исключения

SocketException

_smtpSend()source protected

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

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

Параметры

строка|null $data: Данные, которые будут отправлены на SMTP-сервер
строка|булево $checkCode необязательно '250': Код для проверки в ответ сервера, false для пропуска

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

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

Возможные исключения

SocketException

config()source public

config( array $config null )

Установить конфигурацию

Параметры

массив $config необязательно null: Параметры конфигурации.

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

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

Переопределяет

AbstractTransport::config()

getLastResponse()source public

getLastResponse( )

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

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

array(
    array(
        'code' => '250',
        'message' => 'mail.example.com'
    ),
    array(
        'code' => '250',
        'message' => 'PIPELINING'
    ),
    array(
        'code' => '250',
        'message' => '8BITMIME'
    ),
    // etc...
)

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

массив

send()source public

send( CakeEmail $email )

Отправить почту

Параметры

CakeEmail $email: CakeEmail

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

массив

Исключения

SocketException

Методы, унаследованные от AbstractTransport

_headersToString()source protected

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

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

Параметры

массив $headers: Заголовки в формате ключ => значение
строка $eol необязательно "\r\n": Строка конца строки.

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

строка

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

$_contentsource

protected строка

Содержимое электронной почты для возврата

$_lastResponsesource

protected массив

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

array()

$_socketsource

protected CakeSocket

Сокет SMTP-сервера

© 2005–2017 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/2.10/class-SmtpTransport.html