Класс CakeEmail

__construct()source public

__construct( array|string $config null )

Конструктор

Параметры

массив|строка $config необязательно null

Массив конфигураций или строка для загрузки конфигураций из email.php

_addEmail()source protected

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

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

Параметры

строка $varName

Имя свойства

строка|массив $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 )

Преобразует строку из одного кодирования в другое, если значение App.encoding отличается и функция 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

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 )

Bcc

Параметры

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

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

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

Имя

Возвращает

array|CakeEmail

cc()source public

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

Cc

Параметры

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 для получения, Строка с email, Массив с email в качестве ключа, имя в качестве значения или email в качестве значения (без имени)

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

Имя

Возвращает

array|CakeEmail

Выбрасывает

SocketException

replyTo()source public

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

Reply-To

Параметры

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

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

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 для получения, Строка с email, Массив с email в качестве ключа, имя в качестве значения или email в качестве значения (без имени)

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 для получения, Строка с email, Массив с email в качестве ключа, имя в качестве значения или email в качестве значения (без имени)

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 для получения, Строка с email, Массив с email в качестве ключа, имя в качестве значения или email в качестве значения (без имени)

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

null

array()

array()

null

array()

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

array()

'EmailConfig'

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

null

'text'

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

self::EMAIL_PATTERN

array()

array()

array('Html')

''

'default'

array()

true

array()

array()

array()

array()

''

''

''

null

array()

null

'Mail'

'View'

array()

'utf-8'

null