Spec-Zone.ru › CakePHP 2.10

Класс CakeEmail

Класс CakePHP для отправки электронных писем.

Этот класс используется для обработки электронных сообщений в формате Internet Message Format, основанном на стандарте, описанном в http://www.rfc-editor.org/rfc/rfc2822.txt

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

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

  • string

    EMAIL_CLIENT
    'CakePHP Email'

  • string

    EMAIL_PATTERN
    '/^((?:[\p{L}0-9.!#$%&\'*+\/=?^_`{|}~-]+)*@[\p{L}0-9-_.]+)$/ui'

  • integer

    LINE_LENGTH_MUST
    998

  • integer

    LINE_LENGTH_SHOULD
    78

  • string

    MESSAGE_HTML
    'html'

  • string

    MESSAGE_TEXT
    'text'

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

  • $_appCharset protected
    string
    Кодировка символов для всего приложения, используемая для кодирования заголовков и тела письма.
  • $_attachments protected
    array
    Список файлов, которые должны быть прикреплены к письму.
  • $_bcc protected
    array
    Скрытая копия
  • $_boundary protected
    string
    Если задано, разделитель для сообщений MIME в формате multipart
  • $_cc protected
    array
    Копия
  • $_charset8bit protected
    array
    Наборы символов 8-битного кодирования
  • $_config protected
    string|array
    Настройки для передачи
  • $_configClass protected
    string
    Имя класса, используемого для настройки электронной почты.
  • $_configInstance protected
    EmailConfig
    Здесь можно установить экземпляр класса EmailConfig
  • $_contentTypeCharset protected
    array
    Определение имени кодировки символов Content-Type
  • $_domain protected
    string

    Домен для генерации messageId. Нужно задавать вручную при отправке из командной строки, так как env('HTTP_HOST') пуст

  • $_emailFormat protected
    string
    В каком формате следует отправлять электронное письмо
  • $_emailFormatAvailable protected
    array
    Доступные форматы для отправки.
  • $_emailPattern protected
    string
    Регулярное выражение для проверки адреса электронной почты
  • $_from protected
    array
    Адрес электронной почты, с которого отправляется письмо
  • $_headers protected
    array

    Ассоциативный массив пользовательских заголовков. Ключи будут предваряться «X-» в соответствии с RFC2822, раздел 4.7.5

  • $_helpers protected
    array
    Помощники, которые будут использоваться при рендеринге
  • $_htmlMessage protected
    string
    HTML-сообщение
  • $_layout protected
    string
    Макет для представления
  • $_message protected
    array
    Окончательное сообщение для отправки
  • $_messageId protected
    boolean|string
    Идентификатор сообщения
  • $_readReceipt protected
    array
    Электронное письмо с подтверждением прочтения
  • $_replyTo protected
    array
    Адрес электронной почты, на который получатель будет отвечать
  • $_returnPath protected
    array

    Адрес электронной почты, который будет использоваться в случае ошибок, таких как - Отсутствует удаленный почтовый сервер - Удаленный пользователь превысил лимит - Неизвестный пользователь

  • $_sender protected
    array
    Адрес отправителя
  • $_subject protected
    string
    Тема электронного письма
  • $_template protected
    string
    Шаблон для представления
  • $_textMessage protected
    string
    Текстовое сообщение
  • $_theme protected
    array
    Тема для представления
  • $_to protected
    array
    Получатель электронного письма
  • $_transportClass protected
    AbstractTransport
    Экземпляр класса транспорта
  • $_transportName protected
    string
    Какой метод следует использовать для отправки письма
  • $_viewRender protected
    string
    Представление для рендеринга
  • $_viewVars protected
    array
    Переменные для отправки в рендеринг
  • $charset public
    string
    Кодировка символов тела электронного письма
  • $headerCharset public
    string

    Кодировка символов заголовка электронного письма. Если null, свойство $charset будет использоваться по умолчанию

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

  • __construct() public
    Конструктор
  • _addEmail() protected
    Добавить email
  • _applyConfig() protected
    Применить конфигурацию к экземпляру
  • _attachFiles() protected
    Прикрепить не встроенные файлы, добавив содержимое файла внутри границ.
  • _attachInlineFiles() protected
    Прикрепить встроенные файлы к сообщению.
  • _createBoundary() protected
    Создать уникальный идентификатор границы
  • _encode() protected
    Кодировать указанную строку с использованием текущей кодировки
  • _encodeString() protected

    Преобразовать строку из одной кодировки в другую, если значение App.encoding отличается и функция mb_convert_encoding существует

  • _formatAddress() protected
    Форматировать адреса
  • _getContentTransferEncoding() protected
    Возвращает значение Content-Transfer Encoding, основанное на установленной кодировке
  • _getContentTypeCharset() protected
    Возвращает значение кодировки для Content-Type.
  • _getTypes() protected
    Получить типы текстовых тел в этом электронном письме
  • _readFile() protected
    Прочитать содержимое файла и вернуть базой64 версию содержимого файла.
  • _render() protected
    Отобразить тело электронного письма.
  • _renderTemplates() protected

    Создать и установить все свойства представления, необходимые для отображения шаблонизированных электронных писем. Если шаблон не задан, $content будет возвращён в виде хэша текстовых типов содержимого для электронного письма.

  • _setEmail() protected
    Установить email
  • _setEmailSingle() protected
    Установить только 1 email
  • _validateEmail() protected
    Проверить адрес электронной почты
  • _wrap() protected
    Обработать сообщение в соответствии с RFC 2822 - 2.1.1
  • addAttachments() public
    Добавить вложения
  • addBcc() public
    Добавить Bcc
  • addCc() public
    Добавить Cc
  • addHeaders() public
    Добавить заголовок к сообщению
  • addTo() public
    Добавить Получателям
  • attachments() public
    Добавить вложения к электронному письму
  • bcc() public
    Bcc
  • cc() public
    Cc
  • charset() public
    Установщик/получатель кодировки
  • config() public
    Настройки для отправки электронного письма
  • deliver() public static
    Статический метод для быстрого создания экземпляра CakeEmail
  • domain() public
    Домен верхнего уровня (часть после @)
  • emailFormat() public
    Формат электронной почты
  • emailPattern() public
    Установщик/получатель emailPattern
  • from() public
    От кого
  • getHeaders() public
    Получить список заголовков
  • headerCharset() public
    Установщик/получатель headerCharset
  • helpers() public
    Вспомогательные функции, которые будут использоваться при отображении
  • message() public
    Получить сгенерированное сообщение (используется классами транспорта)
  • messageId() public
    Message-ID
  • readReceipt() public
    Получение подтверждения о прочтении (заголовок Disposition-Notification-To)
  • replyTo() public
    Reply-To
  • reset() public
    Сбросить все внутренние переменные CakeEmail, чтобы отправить новое электронное письмо.
  • returnPath() public
    Возврат пути
  • send() public
    Отправить электронное письмо, используя указанное содержимое, шаблон и макет
  • sender() public
    Отправитель
  • setHeaders() public
    Устанавливает заголовки сообщения
  • subject() public
    Получить/установить тему.
  • template() public
    Шаблон и макет
  • theme() public
    Тема для отображения
  • to() public
    Получателям
  • transport() public
    Имя транспорта
  • transportClass() public
    Возвратить класс транспорта
  • viewRender() public
    Класс представления для рендеринга
  • viewVars() public
    Переменные, которые должны быть установлены при рендеринге

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

__construct()source public 

__construct( array|string $config null )

Конструктор

Параметры

массив|строка $config необязательно null
Массив конфигураций или строка для загрузки конфигураций из email.php

_addEmail()source protected 

_addEmail( string $varName , string|array $email , string $name )

Добавить email

Параметры

строка $varName
Имя свойства
строка|массив $email

Строка с email, Массив с email в качестве ключа, имя в качестве значения или email в качестве значения (без имени)

строка $name
Имя

Возвращает

CakeEmail

Возбуждает

SocketException

_applyConfig()source protected 

_applyConfig( array $config )

Применить конфигурацию к экземпляру

Параметры

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

Возбуждает

ConfigureException

Если файл конфигурации не найден или отсутствует указанная конфигурация.


_attachFiles()source protected 

_attachFiles( string $boundary null )

Прикрепить не встроенные файлы, добавив содержимое файла внутри границ.

Параметры

строка $boundary необязательно null
Граница для использования. Если null, будет использоваться по умолчанию $this->_boundary

Возвращает

массив
Массив строк для добавления в сообщение

_attachInlineFiles()source protected 

_attachInlineFiles( string $boundary null )

Прикрепить встроенные файлы к сообщению.

Параметры

строка $boundary необязательно null
Используемая граница. Если null, будет использоваться по умолчанию $this->_boundary

Возвращает

массив
Массив строк для добавления в сообщение

_createBoundary()source protected 

_createBoundary( )

Создать уникальный идентификатор границы

_encode()source protected 

_encode( string $text )

Кодировать указанную строку с использованием текущей кодировки символов

Параметры

строка $text
Строка для кодирования

Возвращает

строка
Закодированная строка

_encodeString()source protected 

_encodeString( string $text , string $charset )

Преобразует строку из одной кодировки в другую, если кодировка приложения отличается, и функция mb_convert_encoding существует

Параметры

строка $text
Текст, который необходимо преобразовать
строка $charset
целевая кодировка

Возвращает

строка

_formatAddress()source protected 

_formatAddress( array $address )

Форматировать адреса

Если адрес содержит символы, не являющиеся буквенно-цифровыми или пробельными, он будет заключен в кавычки, так как символы, такие как : и ,, известны тем, что вызывают проблемы в полях заголовков адресов.

Параметры

массив $address
Адреса для форматирования.

Возвращает

массив

_getContentTransferEncoding()source protected 

_getContentTransferEncoding( )

Возвратить значение Content-Transfer Encoding на основе установленной кодировки символов

Возвращает

строка

_getContentTypeCharset()source protected 

_getContentTypeCharset( )

Возвратить значение кодировки символов для Content-Type.

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

Возвращает

строка

_getTypes()source protected 

_getTypes( )

Получить типы текстовых тел, которые находятся в этом электронном сообщении

Возвращает

массив
Массив типов. Действительные типы — 'text' и 'html'

_readFile()source protected 

_readFile( string $path )

Прочитать содержимое файла и вернуть версию содержимого файла в формате base64.

Параметры

строка $path
Полный путь к файлу для чтения.

Возвращает

строка
Содержимое файла в кодировке base64

_render()source protected 

_render( array $content )

Отобразить тело электронного письма.

Параметры

массив $content
Содержимое для отображения

Возвращает

массив
Тело электронного письма, готовое к отправке

_renderTemplates()source protected 

_renderTemplates( string $content )

Создать и установить все свойства представления, необходимые для отображения шаблонизированных электронных писем. Если шаблон не задан, $content будет возвращён в виде хеша типов текстового содержимого для электронного письма.

Параметры

строка $content
Содержимое, переданное из send() в большинстве случаев.

Возвращает

массив
Отформатированное содержимое с ключами html и text.

_setEmail()source protected 

_setEmail( string $varName , string|array $email , string $name )

Установить электронную почту

Параметры

строка $varName
Имя свойства
строка|массив $email

Строка с адресом электронной почты, массив с адресом электронной почты в качестве ключа, именем в качестве значения или адресом электронной почты в качестве значения (без имени)

строка $name
Имя

Возвращает

CakeEmail

_setEmailSingle()source protected 

_setEmailSingle( string $varName , string|array $email , string $name , string $throwMessage )

Установить только 1 электронную почту

Параметры

строка $varName
Имя свойства
строка|массив $email

Строка с адресом электронной почты, массив с адресом электронной почты в качестве ключа, именем в качестве значения или адресом электронной почты в качестве значения (без имени)

строка $name
Имя
строка $throwMessage
Сообщение об ошибке

Возвращает

CakeEmail

Исключения

SocketException

_validateEmail()source protected 

_validateEmail( string $email )

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

Параметры

строка $email
Электронная почта

Исключения

SocketException
Если адрес электронной почты не проходит проверку

_wrap()source protected 

_wrap( string $message , integer $wrapLength CakeEmail::LINE_LENGTH_MUST )

Обернуть сообщение в соответствии с RFC 2822 - 2.1.1

Параметры

строка $message
Сообщение для обертывания
целое число $wrapLength необязательно CakeEmail::LINE_LENGTH_MUST
Длина строки

Возвращает

массив
Обернутое сообщение

addAttachments()source public 

addAttachments( string|array $attachments )

Добавить вложения

Параметры

строка|массив $attachments
Строка с именем файла или массив с именами файлов

Возвращает

CakeEmail

Исключения

SocketException

См. также

CakeEmail::attachments()

addBcc()source public 

addBcc( string|array $email , string $name null )

Добавить Bcc

Параметры

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

Null для получения, строка с адресом электронной почты, массив с адресом электронной почты в качестве ключа, именем в качестве значения или адресом электронной почты в качестве значения (без имени)

строка $name необязательно null
Имя

Возвращает

CakeEmail

addCc()source public 

addCc( string|array $email , string $name null )

Добавить Cc

Параметры

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

Null для получения, строка с адресом электронной почты, массив с адресом электронной почты в качестве ключа, именем в качестве значения или адресом электронной почты в качестве значения (без имени)

строка $name необязательно null
Имя

Возвращает

CakeEmail

addHeaders()source public 

addHeaders( array $headers )

Добавить заголовок к сообщению

Параметры

массив $headers
Заголовки для установки.

Возвращает

CakeEmail

Исключения

SocketException
END_OF_DOCUMENT_MARKER

addTo()source public 

addTo( string|array $email , string $name null )

Добавить получателя

Параметры

string|array $email

Null для получения, Строка с адресом электронной почты, Массив с адресом электронной почты в качестве ключа, именем в качестве значения или адресом электронной почты в качестве значения (без имени)

string $name необязательно null
Имя

Возвращает

CakeEmail

attachments()source public 

attachments( string|array $attachments null )

Добавить вложения к сообщению электронной почты

Вложения можно определить несколькими способами, в зависимости от требуемого уровня управления:

Прикрепить один файл:

$email->attachments('path/to/file');

Прикрепить файл с другим именем файла:

$email->attachments(array('custom_name.txt' => 'path/to/file.txt'));

Прикрепить файл и указать дополнительные свойства:

$email->attachments(array('custom_name.png' => array(
    'file' => 'path/to/file',
    'mimetype' => 'image/png',
    'contentId' => 'abc123',
    'contentDisposition' => false
));

Прикрепить файл из строки и указать дополнительные свойства:

$email->attachments(array('custom_name.png' => array(
    'data' => file_get_contents('path/to/file'),
    'mimetype' => 'image/png'
));

Ключ contentId позволяет указать встроенное вложение. В тексте вашего электронного письма вы можете использовать <img src="cid:abc123" /> для отображения изображения встраиваемо.

Ключ contentDisposition позволяет отключить заголовок Content-Disposition, что может улучшить совместимость вложений с клиентами электронной почты Outlook.

Параметры

string|array $attachments необязательно null
Строка с именем файла или массив с именами файлов

Возвращает

array|CakeEmail
либо массив вложений при получении, либо $this при установке.

Исключения

SocketException

bcc()source public 

bcc( string|array $email null , string $name null )

Скрытые копии

Параметры

string|array $email необязательно null

Null для получения, Строка с адресом электронной почты, Массив с адресом электронной почты в качестве ключа, именем в качестве значения или адресом электронной почты в качестве значения (без имени)

string $name необязательно null
Имя

Возвращает

array|CakeEmail

cc()source public 

cc( string|array $email null , string $name null )

Копии

Параметры

string|array $email необязательно null

Null для получения, Строка с адресом электронной почты, Массив с адресом электронной почты в качестве ключа, именем в качестве значения или адресом электронной почты в качестве значения (без имени)

string $name необязательно null
Имя

Возвращает

array|CakeEmail

charset()source public 

charset( string $charset null )

Установка/получение кодировки символов

Параметры

string $charset необязательно null
Кодировка символов.

Возвращает

string
this->charset

config()source public 

config( string|array $config null )

Конфигурация для отправки электронного письма

Использование

Загрузка конфигурации из app/Config/email.php:

$email->config('default');

Слияние массива конфигурации в экземпляр:

$email->config(array('to' => 'bill@example.com'));

Параметры

string|array $config необязательно null
Название конфигурации (из email.php), массив с конфигурацией или null для возврата текущей конфигурации

Возвращает

string|array|CakeEmail

deliver()source public static 

deliver( string|array $to null , string $subject null , string|array $message null , string|array $transportConfig 'fast' , boolean $send true )

Статический метод для быстрого создания экземпляра CakeEmail

Параметры

string|array $to необязательно null
Адрес для отправки (см. CakeEmail::to()). Если null, будет использоваться 'to' из конфигурации транспорта
string $subject необязательно null
Строка темы или null для использования 'subject' из конфигурации транспорта
string|array $message необязательно null
Строка сообщения или массив с переменными, которые будут использованы в рендеринге
string|array $transportConfig необязательно 'fast'
Строка для использования конфигурации из EmailConfig или массив с конфигурациями
boolean $send необязательно true
Отправить электронное письмо или просто вернуть экземпляр предварительно настроенный

Возвращает

CakeEmail
Экземпляр CakeEmail

Исключения

SocketException

domain()source public 

domain( string $domain null )

Домен верхнего уровня (часть после @)

Параметры

string $domain необязательно null
Вручную установить домен для рассылки из командной строки

Возвращает

string|CakeEmail

emailFormat()source public 

emailFormat( string $format null )

Формат электронного письма

Параметры

string $format необязательно null
Строка форматирования.

Возвращает

string|CakeEmail

Исключения

SocketException

emailPattern()source public 

emailPattern( string|boolean|null $regex false )

Установка/получение шаблона электронной почты

Параметры

string|boolean|null $regex необязательно false

Шаблон, используемый для проверки адресов электронной почты, null для отключения шаблона и использования filter_var(), false или ничего для возвращения текущего значения

Возвращает

string|CakeEmail

from()source public 

from( string|array $email null , string $name null )

Отправитель

Параметры

string|array $email необязательно null

Null для получения, Строка с адресом электронной почты, Массив с адресом электронной почты в качестве ключа, именем в качестве значения или адресом электронной почты в качестве значения (без имени)

string $name необязательно null
Имя

Возвращает

array|CakeEmail

Исключения

SocketException

getHeaders()source public 

getHeaders( array $include array() )

Получить список заголовков

Включает:

  • from
  • replyTo
  • readReceipt
  • returnPath
  • to
  • cc
  • bcc
  • subject

Параметры

array $include необязательно array()
Список заголовков.

Возвращает

array

headerCharset()source public 

headerCharset( string $charset null )

Установка/получение кодировки заголовков

Параметры

string $charset необязательно null
Кодировка символов.

Возвращает

string
this->charset

helpers()source public 

helpers( array $helpers null )

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

Параметры

array $helpers необязательно null
Список помощников.

Возвращает

array|CakeEmail

message()source public 

message( string $type null )

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

Параметры

string $type необязательно null
Использовать константы MESSAGE_* или null для возврата полного сообщения в виде массива

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

string|array
Строка, если тип есть, массив, если тип равен null

messageId()source public 

messageId( boolean|string $message null )

Идентификатор сообщения

Параметры

boolean|string $message необязательно null
True для генерации нового Message-ID, False для игнорирования (не отправлять в письме), Строка для установки Message-ID

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

boolean|string|CakeEmail

Исключения

SocketException

readReceipt()source public 

readReceipt( string|array $email null , string $name null )

Подтверждение чтения (заголовок Disposition-Notification-To)

Параметры

string|array $email необязательно null

Null для получения, Строка с адресом электронной почты, Массив с адресом электронной почты в качестве ключа, именем в качестве значения или адресом электронной почты в качестве значения (без имени)

string $name необязательно null
Имя

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

array|CakeEmail

Исключения

SocketException

replyTo()source public 

replyTo( string|array $email null , string $name null )

Reply-To

Параметры

string|array $email необязательно null

Null для получения, Строка с адресом электронной почты, Массив с адресом электронной почты в качестве ключа, именем в качестве значения или адресом электронной почты в качестве значения (без имени)

string $name необязательно null
Имя

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

array|CakeEmail

Исключения

SocketException

reset()source public 

reset( )

Сбросить все внутренние переменные CakeEmail, чтобы можно было отправить новое письмо.

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

CakeEmail

returnPath()source public 

returnPath( string|array $email null , string $name null )

Возвращаемый путь

Параметры

string|array $email необязательно null

Null для получения, Строка с адресом электронной почты, Массив с адресом электронной почты в качестве ключа, именем в качестве значения или адресом электронной почты в качестве значения (без имени)

string $name необязательно null
Имя

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

array|CakeEmail

Исключения

SocketException

send()source public 

send( string|array $content null )

Отправить электронное письмо с указанным содержимым, шаблоном и макетом

Параметры

string|array $content необязательно null
Строка с сообщением или массив с сообщениями

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

array

Исключения

SocketException

sender()source public 

sender( string|array $email null , string $name null )

Отправитель

Параметры

string|array $email необязательно null

Null для получения, Строка с адресом электронной почты, Массив с адресом электронной почты в качестве ключа, именем в качестве значения или адресом электронной почты в качестве значения (без имени)

string $name необязательно null
Имя

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

array|CakeEmail

Исключения

SocketException

setHeaders()source public 

setHeaders( array $headers )

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

Параметры

array $headers
Ассоциативный массив, содержащий заголовки, которые нужно установить.

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

CakeEmail

Исключения

SocketException

subject()source public 

subject( string $subject null )

Получение/установка темы.

Параметры

string $subject необязательно null
Строка темы.

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

string|CakeEmail

template()source public 

template( boolean|string $template false , boolean|string $layout false )

Шаблон и макет

Параметры

boolean|string $template необязательно false
Имя шаблона или null для отказа от использования
boolean|string $layout необязательно false
Имя макета или null для отказа от использования

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

array|CakeEmail

theme()source public 

theme( string $theme null )

Тема для использования при рендеринге

Параметры

string $theme необязательно null
Имя темы.

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

string|CakeEmail

to()source public 

to( string|array $email null , string $name null )

Кому

Параметры

string|array $email необязательно null

Null для получения, Строка с адресом электронной почты, Массив с адресом электронной почты в качестве ключа, именем в качестве значения или адресом электронной почты в качестве значения (без имени)

string $name необязательно null
Имя

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

array|CakeEmail

transport()source public 

transport( string $name null )

Имя транспорта

Параметры

string $name необязательно null
Имя транспорта.

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

string|CakeEmail

transportClass()source public 

transportClass( )

Возвратить класс транспорта

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

AbstractTransport

Исключения

SocketException

viewRender()source public 

viewRender( string $viewClass null )

Класс представления для рендеринга

Параметры

string $viewClass необязательно null
Имя класса представления.

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

string|CakeEmail

viewVars()source public 

viewVars( array $viewVars null )

Переменные, которые нужно установить при рендеринге

Параметры

array $viewVars необязательно null
Переменные для установки для представления.

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

array|CakeEmail

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

$_appCharsetsource

protected string

Charset приложения, используемый для кодирования заголовков и тела

null
END_OF_DOCUMENT_MARKER

$_attachmentssource

protected array

Список файлов, которые должны быть прикреплены к письму.

Только абсолютные пути

array()

$_bccsource

protected array

Скрытая копия

Список адресов электронной почты, которые должны получить копию письма. Получатель НЕ сможет увидеть этот список.

array()

$_boundarysource

protected string

Если задано, граница для использования multipart mime сообщений

null

$_ccsource

protected array

Копия

Список адресов электронной почты, которые должны получить копию письма. Получатель сможет увидеть этот список.

array()

$_charset8bitsource

protected array

8-битные наборы символов

array('UTF-8', 'SHIFT_JIS')

$_configsource

protected string|array

Конфигурация для передачи

array()

$_configClasssource

protected string

Имя класса, используемого для конфигурации электронной почты.

'EmailConfig'

$_configInstancesource

protected EmailConfig

Здесь можно установить экземпляр класса EmailConfig

$_contentTypeCharsetsource

protected array

Определение имени набора символов Content-Type

array(
    'ISO-2022-JP-MS' => 'ISO-2022-JP'
)

$_domainsource

protected string

Домен для генерации messageId. Необходимо вручную установить для рассылки по командной строке, так как env('HTTP_HOST') пуст

null

$_emailFormatsource

protected string

В каком формате должно отправляться письмо

'text'

$_emailFormatAvailablesource

protected array

Доступные форматы для отправки.

array('text', 'html', 'both')

$_emailPatternsource

protected string

Регулярное выражение для проверки адреса электронной почты

Если null, будет использоваться filter_var(). Используйте метод emailPattern() для установки пользовательского шаблона.

self::EMAIL_PATTERN

$_fromsource

protected array

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

array()

$_headerssource

protected array

Ассоциативный массив пользовательских заголовков. Ключи будут иметь префикс 'X-' в соответствии с RFC2822 Раздел 4.7.5

array()

$_helperssource

protected array

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

array('Html')

$_htmlMessagesource

protected string

HTML сообщение

''

$_layoutsource

protected string

Макет для представления

'default'

$_messagesource

protected array

Финальное сообщение для отправки

array()

$_messageIdsource

protected boolean|string

Идентификатор сообщения

true

$_readReceiptsource

protected array

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

array()

$_replyTosource

protected array

Адрес электронной почты, на который будет отвечать получатель

array()

$_returnPathsource

protected array

Адрес электронной почты, который будет использоваться в случае ошибок, таких как: - удаленный сервер электронной почты недоступен - удаленный пользователь превысил квоту - неизвестный пользователь

array()

$_sendersource

protected array

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

array()

$_subjectsource

protected string

Тема письма

''

$_templatesource

protected string

Шаблон для представления

''

$_textMessagesource

protected string

Текст сообщения

''

$_themesource

protected array

Тема для представления

null
END_OF_DOCUMENT_MARKER

$_tosource

protected array

Получатель электронной почты

array()

$_transportClasssource

protected AbstractTransport

Экземпляр класса транспорта

null

$_transportNamesource

protected string

Метод отправки электронной почты

'Mail'

$_viewRendersource

protected string

Шаблон для рендеринга

'View'

$_viewVarssource

protected array

Переменные для отправки в рендеринг

array()

$charsetsource

public string

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

'utf-8'

$headerCharsetsource

public string

Кодировка заголовка электронного письма. Если null, используется кодировка свойства $charset

null

© 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-CakeEmail.html

Spec-Zone.ru

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