Класс CakeEmail

__constructsource public

__construct( array|string $config null )

Конструктор

Параметры

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

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

_addEmailsource protected

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

Добавление адресата

Параметры

string $varName

Имя свойства

string|array $email

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

string $name

Имя

Возвращает

self
self

Вызывает исключение

SocketException
SocketException

_applyConfigsource protected

_applyConfig( array $config )

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

Параметры

array $config

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

Вызывает исключение

ConfigureException
При ошибке поиска или отсутствии указанной конфигурации в файле конфигурации.

_attachFilessource protected

_attachFiles( string $boundary null )

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

Параметры

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

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

Возвращает

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

_attachInlineFilessource protected

_attachInlineFiles( string $boundary null )

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

Параметры

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

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

Возвращает

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

_createBoundarysource protected

_createBoundary( )

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

_encodesource protected

_encode( string $text )

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

Параметры

string $text

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

Возвращает

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

_encodeStringsource protected

_encodeString( string $text , string $charset )

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

Параметры

string $text

Текст, который нужно преобразовать

string $charset

Целевой набор символов

Возвращает

string
строка

_formatAddresssource protected

_formatAddress( array $address )

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

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

Параметры

array $address

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

Возвращает

array
массив

_getContentTransferEncodingsource protected

_getContentTransferEncoding( )

Возвращение значения Content-Transfer Encoding, основанного на заданном наборе символов

Возвращает

string
строка

_getContentTypeCharsetsource protected

_getContentTypeCharset( )

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

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

Возвращает

string
строка

_getTypessource protected

_getTypes( )

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

Возвращает

array
Массив типов. Допустимые типы — 'text' и 'html'

_readFilesource protected

_readFile( string $path )

Чтение содержимого файла и возврат версии содержимого файла в base64.

Параметры

string $path

Абсолютный путь к файлу для чтения.

Возвращает

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

_rendersource protected

_render( array $content )

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

Параметры

array $content

Содержимое для рендеринга

Возвращает

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

_renderTemplatessource protected

_renderTemplates( string $content )

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

Параметры

string $content

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

Возвращает

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

_setEmailsource protected

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

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

Параметры

string $varName

Имя свойства

string|array $email

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

string $name

Имя

Возвращает

self
self

_setEmailSinglesource protected

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

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

Параметры

string $varName

Имя свойства

string|array $email

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

string $name

Имя

string $throwMessage

Сообщение об ошибке

Возвращает

self
self

Вызывает исключение

SocketException
SocketException

_validateEmailsource protected

_validateEmail( string $email )

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

Параметры

string $email

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

Вызывает исключение

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

_wrapsource protected

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

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

Параметры

строка $message

Сообщение для обёртывания

целое число $wrapLength необязательно CakeEmail::LINE_LENGTH_MUST

Длина строки

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

array
Обёрнутое сообщение

addAttachmentssource public

addAttachments( string|array $attachments )

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

Параметры

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

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

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

self
self

Исключения

SocketException
SocketException

См. также

CakeEmail::attachments()

addBccsource public

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

Добавить Bcc

Параметры

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

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

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

Имя

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

self
self

addCcsource public

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

Добавить Cc

Параметры

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

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

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

Имя

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

self
self

addHeaderssource public

addHeaders( array $headers )

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

Параметры

массив $headers

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

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

self
self

Исключения

SocketException
SocketException

addTosource public

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

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

Параметры

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

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

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

Имя

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

self
self

attachmentssource 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.

Параметры

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

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

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

array|self
Массив вложений при получении или $this при установке.

Исключения

SocketException
SocketException

bccsource public

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

Bcc

Параметры

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

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

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

Имя

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

array|self
массив|self

ccsource public

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

Cc

Параметры

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

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

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

Имя

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

array|self
массив|self

charsetsource public

charset( string $charset null )

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

Параметры

строка $charset необязательно null

Кодировка символов.

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

string
this->charset

configsource public

config( string|array $config null )

Конфигурация для отправки электронной почты

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

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

$email->config('default');

Объединение массива конфигураций в экземпляр:

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

Параметры

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

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

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

string|array|self
строка|массив|self

deliversource public static

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

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

Параметры

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

Адрес для отправки (см. CakeEmail::to()). Если null, попытается использовать 'to' из конфигурации транспорта

строка $subject необязательно null

Строка темы или null для использования 'subject' из конфигурации транспорта

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

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

строка|массив $transportConfig необязательно 'fast'

Строка для использования конфигурации из EmailConfig или массив с конфигурациями

булево $send необязательно true

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

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

self
Экземпляр CakeEmail

Исключения

SocketException
SocketException

domainsource public

domain( string $domain null )

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

Параметры

строка $domain необязательно null

Вручную задать домен для отправки почты через консоль

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

string|self
строка|self

emailFormatsource public

emailFormat( string $format null )

Формат электронной почты

Параметры

строка $format необязательно null

Форматирующая строка.

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

string|self
строка|self

Исключения

SocketException
SocketException

emailPatternsource public

emailPattern( string|boolean|null $regex false )

Установка/получение emailPattern

Параметры

строка|булево|null $regex необязательно false

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

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

string|self
строка|self

отправительисходный код public

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

Отправитель

Параметры

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

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

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

Имя

Возвращает

array|CakeEmail
массив|CakeEmail

Исключения

SocketException
SocketException

getHeadersисходный код public

getHeaders( array $include array() )

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

Включает:

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

Параметры

массив $include необязательно array()

Список заголовков.

Возвращает

array
массив

headerCharsetисходный код public

headerCharset( string $charset null )

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

Параметры

строка $charset необязательно null

Кодировка символов.

Возвращает

string
this->charset

helpersисходный код public

helpers( array $helpers null )

Вспомогательные модули для использования в рендеринге

Параметры

массив $helpers необязательно null

Список вспомогательных модулей.

Возвращает

array|self
массив|self

сообщениеисходный код public

message( string $type null )

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

Параметры

строка $type необязательно null

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

Возвращает

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

messageIdисходный код public

messageId( boolean|string $message null )

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

Параметры

boolean|строка $message необязательно null

True для генерации нового Message-ID, False для игнорирования (не отправлять в электронном письме), Строка для установки в качестве Message-ID

Возвращает

boolean|string|self
bool|строка|self

Исключения

SocketException
SocketException

readReceiptисходный код public

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

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

Параметры

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

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

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

Имя

Возвращает

array|CakeEmail
массив|CakeEmail

Исключения

SocketException
SocketException

replyToисходный код public

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

Ответ

Параметры

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

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

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

Имя

Возвращает

array|CakeEmail
массив|CakeEmail

Исключения

SocketException
SocketException

сбросисходный код public

reset( )

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

Возвращает

self
self

адрес_возвратаисходный код public

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

Адрес возврата

Параметры

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

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

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

Имя

Возвращает

array|CakeEmail
массив|CakeEmail

Исключения

SocketException
SocketException

отправитьисходный код public

send( string|array $content null )

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

Параметры

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

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

Возвращает

array
массив

Исключения

SocketException
SocketException

отправительисходный код public

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

Отправитель

Параметры

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

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

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

Имя

Возвращает

array|CakeEmail
массив|CakeEmail

Исключения

SocketException
SocketException

setHeadersисходный код public

setHeaders( array $headers )

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

Параметры

массив $headers

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

Возвращает

self
self

Исключения

SocketException
SocketException

темаисходный код public

subject( string $subject null )

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

Параметры

строка $subject необязательно null

Строка темы.

Возвращает

string|self
строка|self

шаблонисходный код public

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

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

Параметры

boolean|строка $template необязательно false

Имя шаблона или null для его игнорирования

boolean|строка $layout необязательно false

Имя макета или null для его игнорирования

Возвращает

array|self
массив|self

темаисходный код public

theme( string $theme null )

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

Параметры

строка $theme необязательно null

Имя темы.

Возвращает

string|self
строка|self

tosource public

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

Кому

Параметры

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

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

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

Имя

Возвращает

array|self
массив|self

transportsource public

transport( string $name null )

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

Параметры

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

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

Возвращает

string|self
строка|self

transportClasssource public

transportClass( )

Возвращает класс транспорта

Возвращает

AbstractTransport
AbstractTransport

Выбрасывает

SocketException
SocketException

viewRendersource public

viewRender( string $viewClass null )

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

Параметры

строка $viewClass необязательно null

Имя класса представления.

Возвращает

string|self
строка|self

viewVarssource public

viewVars( array $viewVars null )

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

Параметры

массив $viewVars необязательно null

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

Возвращает

array|self
массив|self

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')

CakeEmail::EMAIL_PATTERN

array()

array()

array('Html')

''

'default'

array()

true

array()

array()

array()

array()

''

''

''

null

array()

null

'Mail'

'View'

array()

'utf-8'

null