Spec-Zone.ru › CakePHP 2.9

Класс SmtpTransport

Отправка почты по протоколу SMTP

AbstractTransport
Extended by SmtpTransport
Пакет: Cake\Network\Email
Авторские права: Copyright (c) Cake Software Foundation, Inc. (http://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
    Подготавливает адрес электронной почты from.
  • _prepareFromCmd() protected
    Подготавливает команду SMTP MAIL FROM.
  • _prepareMessage() protected
    Подготавливает тело сообщения.
  • _prepareMessageHeaders() protected
    Подготавливает заголовки сообщения.
  • _prepareRcptCmd() protected
    Подготавливает команду SMTP RCPT TO.
  • _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
Строки ответа для разбора.

_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

Возвращает

массив

_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-сервер
строка|boolean $checkCode необязательно '250'
Код для проверки в ответе сервера, false для пропуска

Возвращает

строка|null
Совпавший код, или null, если ничего не совпало

Исключение

SocketException
END_OF_DOCUMENT_MARKER

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–2016 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.9/class-SmtpTransport.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API