Класс Email

__clone()source public

__clone( )

Клонирование экземпляра ViewBuilder при клонировании объекта email.

__construct()source public

__construct( array|string|null $config = null )

Конструктор

Параметры

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

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

_addEmail()source protected

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

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

Параметры

строка $varName

Имя свойства

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

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

строка $name

Имя

Возвращает

$this

Исключения

InvalidArgumentException

_applyConfig()source protected

_applyConfig( string|array $config )

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

Параметры

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

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

Исключения

InvalidArgumentException
При использовании конфигурации, которой нет.

_attachFiles()source protected

_attachFiles( string|null $boundary = null )

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

Параметры

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

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

Возвращает

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

_attachInlineFiles()source protected

_attachInlineFiles( string|null $boundary = null )

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

Параметры

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

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

Возвращает

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

_checkViewVars()source protected

_checkViewVars( mixed $item , string $key )

Итерирует по хэшу для очистки и нормализации.

Параметры

смешанное $item

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

строка $key

Ключ переменной представления.

_createBoundary()source protected

_createBoundary( )

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

_decode()source protected

_decode( string $text )

Декодировать указанную строку

Параметры

строка $text

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

Возвращает

строка
Декодированная строка

_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 на основе установленного transferEncoding или установленного набора символов.

Возвращает

строка

_getContentTypeCharset()source protected

_getContentTypeCharset( )

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

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

Возвращает

строка

_getTypes()source protected

_getTypes( )

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

Возвращает

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

_logDelivery()source protected

_logDelivery( array $contents )

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

Параметры

массив $contents

Содержимое с ключами 'headers' и 'message'.

_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 и текст.

_setEmail()source protected

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

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

Параметры

строка $varName

Имя свойства

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

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

строка $name

Имя

Возвращает

$this

Исключения

InvalidArgumentException

_setEmailSingle()source protected

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

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

Параметры

строка $varName

Имя свойства

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

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

строка $name

Имя

строка $throwMessage

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

Возвращает

$this

Исключения

InvalidArgumentException

_validateEmail()source protected

_validateEmail( string $email , string $context )

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

Параметры

строка $email

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

строка $context

Установленное свойство

Исключения

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

_wrap()source protected

_wrap( string $message , integer $wrapLength = Email::LINE_LENGTH_MUST )

Оборачивает сообщение в соответствии с RFC 2822 - 2.1.1

Параметры

строка $message

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

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

Длина строки

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

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

addAttachments()source public

addAttachments( string|array $attachments )

Добавление вложений

Параметры

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

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

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

$this

Исключения

InvalidArgumentException

См. также

\Cake\Mailer\Email::attachments()

addBcc()source public

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

Добавление Bcc

Параметры

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

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

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

Имя

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

$this

addCc()source public

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

Добавление Cc

Параметры

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

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

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

Имя

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

$this

addHeaders()source public

addHeaders( array $headers )

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

Параметры

массив $headers

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

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

$this

addTo()source public

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

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

Параметры

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

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

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

Имя

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

$this

attachments()source public deprecated

attachments( string|array|null $attachments = null )

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

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

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

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

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

$email->setAttachments(['custom_name.txt' => 'path/to/file.txt']);

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

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

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

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

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

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

Устарело

3.4.0 Используйте setAttachments()/getAttachments() вместо этого.

Параметры

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

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

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

массив|Cake\Mailer\Email
$this либо массив вложений при получении, либо $this при установке.

Исключения

InvalidArgumentException

bcc()source public deprecated

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

Bcc

Устарело

3.4.0 Используйте setBcc()/getBcc() вместо этого.

Параметры

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

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

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

Имя

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

массив|Cake\Mailer\Email
$this

cc()source public deprecated

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

Cc

Устарело

3.4.0 Используйте setCc()/getCc() вместо этого.

Параметры

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

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

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

Имя

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

массив|Cake\Mailer\Email
$this

charset()source public deprecated

charset( string|null $charset = null )

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

Устарело

3.4.0 Используйте setCharset()/getCharset() вместо этого.

Параметры

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

Набор символов.

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

строка
Набор символов

configTransport()source public static deprecated

configTransport( string|array $key , array|Cake\Mailer\AbstractTransport|null $config = null )

Добавление или чтение конфигурации транспорта.

Используйте этот метод для определения транспортов, которые нужно использовать в профилях доставки. После определения конфигурации вы не сможете её изменить, и вам нужно использовать Email::dropTransport() для очистки конфигурации.

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

Ключ className используется для определения класса, который нужно использовать для транспорта. Это может быть короткое имя или полное имя класса.

Устарело

3.4.0 Используйте TransportFactory::setConfig()/getConfig() вместо этого.

Параметры

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

Имя конфигурации для чтения/записи. Или массив нескольких транспортов для установки.

массив|Cake\Mailer\AbstractTransport|null $config необязательно null

Массив данных конфигурации или экземпляр транспорта.

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

массив|null
Null при установке или массив данных при чтении.

Исключения

BadMethodCallException
При изменении существующей конфигурации.

configuredTransport()source public static deprecated

configuredTransport( )

Возвращает массив, содержащий конфигурации транспортов с указанным именем

Устарело

3.7.0 Используйте TransportFactory::configured() вместо этого.

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

массив
Массив конфигураций.

createFromArray()source public

createFromArray( array $config )

Настраивает объект экземпляра электронной почты из сериализованной конфигурации.

Параметры

массив $config

Массив конфигурации электронной почты.

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

$this Настроенный экземпляр электронной почты.

deliver()source public static

deliver( string|array|null $to = null , string|null $subject = null , string|array|null $message = null , string|array $config = 'default' , boolean $send = true )

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

Параметры

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

Адрес для отправки (см. Cake\Mailer\Email::to()). Если null, будет использоваться значение 'to' из конфигурации транспорта

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

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

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

Строка с сообщением или массив с переменными, используемыми в шаблоне

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

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

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

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

Возвращает

Cake\Mailer\Email
Экземпляр Cake\Mailer\Email

Исключения

InvalidArgumentException

domain()source public deprecated

domain( string|null $domain = null )

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

Устаревшая функция

3.4.0 Используйте setDomain()/getDomain() вместо этого.

Параметры

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

Ручная установка домена для отправки по CLI

Возвращает

string|Cake\Mailer\Email
$this

dropTransport()source public static deprecated

dropTransport( string $key )

Удалить конфигурацию транспорта.

Устаревшая функция

3.7.0 Используйте TransportFactory::drop() вместо этого.

Параметры

string $key

Имя транспорта для удаления.

emailFormat()source public deprecated

emailFormat( string|null $format = null )

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

Устаревшая функция

3.4.0 Используйте setEmailFormat()/getEmailFormat() вместо этого.

Параметры

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

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

Возвращает

string|Cake\Mailer\Email
$this

Исключения

InvalidArgumentException

emailPattern()source public deprecated

emailPattern( string|boolean|null $regex = false )

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

Устаревшая функция

3.4.0 Используйте setEmailPattern()/getEmailPattern() вместо этого.

Параметры

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

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

Возвращает

string|Cake\Mailer\Email
$this

flatten()source protected

flatten( string|array $value )

Преобразует значение в строку

Параметры

string|array $value

Значение для преобразования

Возвращает

string

from()source public deprecated

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

Отправитель

Устаревшая функция

3.4.0 Используйте setFrom()/getFrom() вместо этого.

Параметры

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

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

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

Имя

Возвращает

array|Cake\Mailer\Email
$this

Исключения

InvalidArgumentException

getAttachments()source public

getAttachments( )

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

Возвращает

array
Массив вложений.

getBcc()source public

getBcc( )

Получение адресов "bcc".

Возвращает

array

getCc()source public

getCc( )

Получение адресов "cc".

Возвращает

array

getCharset()source public

getCharset( )

Получение кодировки символов.

Возвращает

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

getConfigTransport()source public static deprecated

getConfigTransport( string $key )

Получение текущей конфигурации транспорта.

Устаревшая функция

3.7.0 Используйте TransportFactory::getConfig() вместо этого.

Параметры

string $key

Имя конфигурации для чтения.

Возвращает

array|null
Конфигурация транспорта.

getDomain()source public

getDomain( )

Получение домена.

Возвращает

string

getEmailFormat()source public

getEmailFormat( )

Получение формата электронной почты.

Возвращает

string

getEmailPattern()source public

getEmailPattern( )

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

Возвращает

string

getFrom()source public

getFrom( )

Получение адреса "from".

Возвращает

array

getHeaderCharset()source public

getHeaderCharset( )

Получение кодировки символов заголовков.

Возвращает

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

getHeaders()source public

getHeaders( array $include = [] )

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

Включает:

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

Параметры

array $include необязательно []

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

Возвращает

array

getHelpers()source public deprecated

getHelpers( )

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

Устаревшая функция

3.7.0 Используйте $email->viewBuilder()->getHelpers() вместо этого.

Возвращает

array

getLayout()source public deprecated

getLayout( )

Получение макета.

Устаревшая функция

3.7.0 Используйте $email->viewBuilder()->getLayout() вместо этого.

Возвращает

string

getMessageId()source public

getMessageId( )

Получение идентификатора сообщения.

Возвращает

boolean|string

getOriginalSubject()source public

getOriginalSubject( )

Получение исходного заголовка без кодирования

Возвращает

string
Исходный заголовок

getPriority()source public

getPriority( )

Получение приоритета.

Возвращает

integer

getProfile()source public

getProfile( )

Получение профиля конфигурации для использования в данном экземпляре.

Возвращает

string|array

getReadReceipt()source public

getReadReceipt( )

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

Возвращает

array

getReplyTo()source public

getReplyTo( )

Получение адреса "Reply-To".

Возвращает

array

getReturnPath()source public

getReturnPath( )

Получение возвращаемого пути.

Возвращает

array

getSender()source public

getSender( )

Получение адреса "отправителя".

Возвращает

array

getSubject()source public

getSubject( )

Получение темы.

Возвращает

string

getTemplate()source public

getTemplate( )

Получение шаблона.

Возвращает

string

getTheme()source public deprecated

getTheme( )

Получение темы для рендеринга.

Устарело

3.7.0 Используйте $email->viewBuilder()->getTheme() вместо этого.

Возвращает

string

getTo()source public

getTo( )

Получение адреса "получателя".

Возвращает

array

getTransferEncoding()source public

getTransferEncoding( )

Получение кодирования передачи.

Возвращает

string|null
Кодирование

getTransport()source public

getTransport( )

Получение транспорта.

Возвращает

Cake\Mailer\AbstractTransport

getViewRenderer()source public

getViewRenderer( )

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

Возвращает

string

getViewVars()source public

getViewVars( )

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

Возвращает

array

headerCharset()source public deprecated

headerCharset( string|null $charset = null )

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

Устарело

3.4.0 Используйте setHeaderCharset()/getHeaderCharset() вместо этого.

Параметры

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

Набор символов.

Возвращает

string
Набор символов

helpers()source public deprecated

helpers( array|null $helpers = null )

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

Устарело

3.4.0 Используйте setHelpers()/getHelpers() вместо этого.

Параметры

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

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

Возвращает

array|Cake\Mailer\Email
$this

jsonSerialize()source public

jsonSerialize( )

Сериализация объекта электронной почты в значение, которое может быть напрямую сериализовано и повторно использовано для клонирования этого экземпляра электронной почты.

Есть определенные ограничения для viewVars, которые стоит знать:

• ORM\Query, выполненные и сохранённые как результат
• SimpleXMLElements, сохранённые как ассоциативный массив
• Исключения, сохранённые как строки
• Ресурсы, \Closure и \PDO не поддерживаются.

Возвращает

array
Сериализуемый массив свойств конфигурации.

Исключения

Exception
Когда объект view var не может быть должным образом сериализован.

Реализация

JsonSerializable::jsonSerialize()

message()source public

message( string|null $type = null )

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

Параметры

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

Используйте константы MESSAGE_* или null, чтобы вернуть полное сообщение как массив

Возвращает

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

messageId()source public deprecated

messageId( boolean|string|null $message = null )

Message-ID

Устарело

3.4.0 Используйте setMessageId()/getMessageId() вместо этого.

Параметры

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

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

Возвращает

boolean|string|Cake\Mailer\Email
$this

Исключения

InvalidArgumentException

profile()source public deprecated

profile( null|string|array $config = null )

Получение/Установка профиля конфигурации для использования в данном экземпляре.

Устарело

3.4.0 Используйте setProfile()/getProfile() вместо этого.

Параметры

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

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

Возвращает

string|array|Cake\Mailer\Email
$this

readReceipt()source public deprecated

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

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

Устарело

3.4.0 Используйте setReadReceipt()/getReadReceipt() вместо этого.

Параметры

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

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

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

Имя

Возвращает

array|Cake\Mailer\Email
$this

Исключения

InvalidArgumentException

replyTo()source public deprecated

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

Ответный адрес

Устаревшее

3.4.0 Используйте setReplyTo()/getReplyTo() вместо этого.

Параметры

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

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

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

Имя

Возвращает

array|Cake\Mailer\Email
$this

Выбрасывает

InvalidArgumentException

reset()source public

reset( )

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

Возвращает

$this

returnPath()source public deprecated

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

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

Устаревшее

3.4.0 Используйте setReturnPath()/getReturnPath() вместо этого.

Параметры

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

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

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

Имя

Возвращает

array|Cake\Mailer\Email
$this

Выбрасывает

InvalidArgumentException

send()source public

send( string|array|null $content = null )

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

Параметры

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

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

Возвращает

array

Выбрасывает

BadMethodCallException

sender()source public deprecated

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

Отправитель

Устаревшее

3.4.0 Используйте setSender()/getSender() вместо этого.

Параметры

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

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

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

Имя

Возвращает

array|Cake\Mailer\Email
$this

Выбрасывает

InvalidArgumentException

serialize()source public

serialize( )

Сериализует объект Email.

Возвращает

string

Реализация

Serializable::serialize()

setAttachments()source public

setAttachments( string|array $attachments )

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

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

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

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

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

$email->setAttachments(['custom_name.txt' => 'path/to/file.txt']);

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

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

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

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

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

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

Параметры

string|array $attachments

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

Возвращает

$this

Выбрасывает

InvalidArgumentException

setBcc()source public

setBcc( string|array $email , string|null $name = null )

Устанавливает адрес "bcc".

Параметры

string|array $email

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

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

Имя

Возвращает

$this

setCc()source public

setCc( string|array $email , string|null $name = null )

Устанавливает адрес "cc".

Параметры

string|array $email

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

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

Имя

Возвращает

$this

setCharset()source public

setCharset( string|null $charset )

Установка набора символов.

Параметры

string|null $charset

Набор символов.

Возвращает

$this

setConfigTransport()source public static deprecated

setConfigTransport( string|array $key , array|Cake\Mailer\AbstractTransport|null $config = null )

Устанавливает конфигурацию транспорта.

Используйте этот метод для определения транспортов, используемых в профилях доставки. После определения вы не сможете редактировать конфигурации и должны использовать Email::dropTransport(), чтобы очистить конфигурацию.

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

className используется для определения класса, который следует использовать для транспорта. Это может быть короткое имя или полное имя класса.

Устаревшее

3.7.0 Используйте TransportFactory::setConfig() вместо этого.

Параметры

string|array $key

Имя конфигурации для записи. Или массив нескольких транспортов для установки.

array|Cake\Mailer\AbstractTransport|null $config необязательно null

Либо массив данных конфигурации, либо экземпляр транспорта. Null при использовании ключа как массива.

setDomain()source public

setDomain( string $domain )

Устанавливает домен.

Домен как верхний уровень (часть после @).

Параметры

string $domain

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

Возвращает

$this

setEmailFormat()source public

setEmailFormat( string $format )

Устанавливает формат электронной почты.

Параметры

string $format

Строка форматирования.

Возвращает

$this

Выбрасывает

InvalidArgumentException

setEmailPattern()source public

setEmailPattern( string|null $regex )

Установщик/получатель EmailPattern

Параметры

string|null $regex

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

Возвращает

$this

setFrom()source public

setFrom( string|array $email , string|null $name = null )

Устанавливает адрес "от".

Параметры

string|array $email

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

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

Имя

Возвращает

$this

Выбрасывает

InvalidArgumentException

setHeaderCharset()source public

setHeaderCharset( string|null $charset )

Установка набора символов заголовка.

Параметры

string|null $charset

Набор символов.

Возвращает

$this

setHeaders()source public

setHeaders( array $headers )

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

Параметры

массив $headers

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

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

$this

setHelpers()source public deprecated

setHelpers( array $helpers )

Устанавливает помощники для использования при рендеринге.

Устаревшее

3.7.0 Используйте $email->viewBuilder()->setHelpers() вместо этого.

Параметры

массив $helpers

Список помощников.

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

$this

setLayout()source public deprecated

setLayout( string|null $layout )

Устанавливает макет.

Устаревшее

3.7.0 Используйте $email->viewBuilder()->setLayout() вместо этого.

Параметры

строка|null $layout

Имя макета или null, чтобы не использовать его

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

$this

setMessageId()source public

setMessageId( boolean|string $message )

Устанавливает идентификатор сообщения.

Параметры

логическое значение|строка $message

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

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

$this

Исключения

InvalidArgumentException

setPriority()source public

setPriority( integer|null $priority )

Устанавливает приоритет.

Параметры

целое число|null $priority

1 (наивысший) до 5 (наименьший)

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

$this

setProfile()source public

setProfile( string|array $config )

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

Параметры

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

Строка с именем конфигурации или массив с конфигурацией.

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

$this

setReadReceipt()source public

setReadReceipt( string|array $email , string|null $name = null )

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

Параметры

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

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

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

Имя

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

$this

Исключения

InvalidArgumentException

setReplyTo()source public

setReplyTo( string|array $email , string|null $name = null )

Устанавливает адрес "Reply-To".

Параметры

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

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

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

Имя

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

$this

Исключения

InvalidArgumentException

setReturnPath()source public

setReturnPath( string|array $email , string|null $name = null )

Обратный путь

Параметры

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

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

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

Имя

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

$this

Исключения

InvalidArgumentException

setSender()source public

setSender( string|array $email , string|null $name = null )

Устанавливает адрес "отправителя".

Параметры

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

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

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

Имя

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

$this

Исключения

InvalidArgumentException

setSubject()source public

setSubject( string $subject )

Устанавливает тему.

Параметры

строка $subject

Строка темы.

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

$this

setTemplate()source public

setTemplate( string|null $template )

Устанавливает шаблон.

Параметры

строка|null $template

Имя шаблона или null, чтобы не использовать его.

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

$this

setTheme()source public deprecated

setTheme( string $theme )

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

Устаревшее

3.7.0 Используйте $email->viewBuilder()->setTheme() вместо этого.

Параметры

строка $theme

Имя темы.

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

$this

setTo()source public

setTo( string|array $email , string|null $name = null )

Устанавливает адрес "to".

Параметры

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

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

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

Имя

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

$this

setTransferEncoding()source public

setTransferEncoding( string|null $encoding )

Метод установки кодировки перевода.

Параметры

строка|null $encoding

Установленная кодировка.

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

$this

setTransport()source public

setTransport( string|Cake\Mailer\AbstractTransport $name )

Устанавливает транспорт.

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

Параметры

строка|Cake\Mailer\AbstractTransport $name

Имя настроенного транспорта или экземпляр транспорта.

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

$this

Исключения

LogicException
Когда выбранному транспорту не хватает метода send.
InvalidArgumentException
Когда $name не является ни строкой, ни объектом.

setViewRenderer()source public

setViewRenderer( string $viewClass )

Устанавливает класс представления для рендеринга.

Параметры

строка $viewClass

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

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

$this

setViewVars()source public

setViewVars( array $viewVars )

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

Параметры

массив $viewVars

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

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

$this

subject()source public deprecated

subject( string|null $subject = null )

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

Устаревшее

3.4.0 Используйте setSubject()/getSubject() вместо этого.

Параметры

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

Строка темы.

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

строка|Cake\Mailer\Email
$this

template()source public deprecated

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

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

Устарело

3.4.0 Используйте setTemplate()/getTemplate() и setLayout()/getLayout() вместо этого.

Параметры

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

Имя шаблона или null, чтобы не использовать

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

Имя макета или null, чтобы не использовать

Возвращает

array|Cake\Mailer\Email
$this

theme()source public deprecated

theme( string|null $theme = null )

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

Устарело

3.4.0 Используйте setTheme()/getTheme() вместо этого.

Параметры

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

Имя темы.

Возвращает

string|Cake\Mailer\Email
$this

to()source public deprecated

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

Кому

Устарело

3.4.0 Используйте setTo()/getTo() вместо этого.

Параметры

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

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

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

Имя

Возвращает

array|Cake\Mailer\Email
$this

transport()source public deprecated

transport( string|Cake\Mailer\AbstractTransport|null $name = null )

Получение/установка транспорта.

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

Устарело

3.4.0 Используйте setTransport()/getTransport() вместо этого.

Параметры

string|Cake\Mailer\AbstractTransport|null $name необязательно null

Либо имя настроенного транспорта, либо экземпляр транспорта.

Возвращает

Cake\Mailer\AbstractTransport|Cake\Mailer\Email
$this

Исключения

LogicException
Когда выбранный транспорт не имеет метода отправки.
InvalidArgumentException
Когда $name не является ни строкой, ни объектом.

unserialize()source public

unserialize( string $data )

Десериализация объекта Email.

Параметры

string $data

Строка сериализации.

Возвращает

Cake\Mailer\Email
Настроенный экземпляр электронной почты.

Реализация

Serializable::unserialize()

viewRender()source public deprecated

viewRender( string|null $viewClass = null )

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

Устарело

3.4.0 Используйте setViewRenderer()/getViewRenderer() вместо этого.

Параметры

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

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

Возвращает

string|Cake\Mailer\Email
$this

viewVars()source public deprecated

viewVars( array|null $viewVars = null )

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

Устарело

3.4.0 Используйте setViewVars()/getViewVars() вместо этого.

Параметры

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

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

Возвращает

array|Cake\Mailer\Email
$this

config()source public static deprecated

config( string|array $key , array|null $config = null )

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

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

Адаптеры не будут построены до тех пор, пока первое действие не будет выполнено.

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

Предполагая, что имя класса Cache поддерживаются следующие сценарии:

Чтение данных конфигурации обратно:

Cache::config('default');

Настройка движка кеширования.

Cache::config('default', $settings);

Ввод построенного адаптера:

Cache::config('default', $instance);

Настройка нескольких адаптеров сразу:

Cache::config($arrayOfConfig);

Устарело

3.4.0 Используйте setConfig()/getConfig() вместо этого.

Параметры

string|array $key

Имя конфигурации или массив нескольких конфигураций.

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

Массив name => данные конфигурации для адаптера.

Возвращает

array|null
Null при добавлении конфигурации или массив данных конфигурации при чтении.

Исключения

BadMethodCallException
При попытке изменить существующую конфигурацию.

configured()source public static

configured( )

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

Возвращает

string[]
Массив конфигураций.

drop()source public static

drop( string $config )

Удаляет построенный адаптер.

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

Если реализующие объекты поддерживают объект $_registry именованная конфигурация также будет загружена из реестра.

Параметры

string $config

Существующая конфигурация, которую вы хотите удалить.

Возвращает

boolean
Успех удаления, возвращает false, когда конфигурация не существует.

dsnClassMap()source public static deprecated

dsnClassMap( array $map = null )

Возвращает или обновляет карту классов DSN для этого класса.

Устарело

3.4.0 Используйте setDsnClassMap()/getDsnClassMap() вместо этого.

Параметры

array $map необязательно null

Добавления/изменения в карте классов для применения.

Возвращает

array

getConfig()source public static

getConfig( string $key )

Читает существующую конфигурацию.

Параметры

string $key

Имя конфигурации.

Возвращает

mixed
Данные конфигурации по указанному ключу или null, если ключ не существует.

getDsnClassMap()source public static

getDsnClassMap( )

Возвращает карту классов DSN для этого класса.

Возвращает

array

parseDsn()source public static

parseDsn( string $dsn )

Разбирает DSN в корректную конфигурацию подключения

Этот метод позволяет задать DSN с форматированием, похожим на то, которое используется в PEAR::DB. Ниже приведен пример его использования:

$dsn = 'mysql://user:pass@localhost/database?';
$config = ConnectionManager::parseDsn($dsn);

$dsn = 'Cake\Log\Engine\FileLog://?types=notice,info,debug&file=debug&path=LOGS';
$config = Log::parseDsn($dsn);

$dsn = 'smtp://user:secret@localhost:25?timeout=30&client=null&tls=null';
$config = Email::parseDsn($dsn);

$dsn = 'file:///?className=\My\Cache\Engine\FileEngine';
$config = Cache::parseDsn($dsn);

$dsn = 'File://?prefix=myapp_cake_core_&serialize=true&duration=+2 minutes&path=/tmp/persistent/';
$config = Cache::parseDsn($dsn);

Для всех классов значение scheme устанавливается как значение как className, если не указано иное.

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

Параметры

string $dsn

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

Возвращает

array
Массив конфигурации для хранения после анализа DSN

Исключения

InvalidArgumentException
Если не передана строка или передана некорректная строка

setConfig()source public static

setConfig( string|array $key , array $config = null )

Этот метод можно использовать для определения адаптеров конфигурации для приложения.

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

Адаптеры не будут созданы до выполнения первого действия.

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

Предполагая, что имя класса — Cache поддерживаются следующие сценарии:

Настройка движка кеширования.

Cache::setConfig('default', $settings);

Вставка созданного адаптера в:

Cache::setConfig('default', $instance);

Настройка нескольких адаптеров одновременно:

Cache::setConfig($arrayOfConfig);

Параметры

string|array $key

Имя конфигурации или массив из нескольких конфигураций.

array $config optional null

Массив пар имя => данные конфигурации для адаптера.

Исключения

BadMethodCallException
При попытке изменить существующую конфигурацию.
LogicException
При попытке сохранить массив конфигурации с невалидным структурой.

setDsnClassMap()source public static

setDsnClassMap( array $map )

Обновляет карту классов DSN для данного класса.

Параметры

array $map

Добавления/изменения в карту классов для применения.

createView()source public

createView( string|null $viewClass = null )

Создаёт экземпляр класса представления на основе текущей конфигурации.

Параметры

string|null $viewClass optional null

Необязательное имя класса представления с указанием пространства имён для создания экземпляра.

Возвращает

Cake\View\View

Исключения

Cake\View\Exception\MissingViewException
Если класс представления не найден.

set()source public

set( string|array $name , mixed $value = null )

Сохраняет переменную или ассоциативный массив переменных для использования внутри шаблона.

Параметры

string|array $name

Строка или массив данных.

mixed $value optional null

Значение в случае, если $name является строкой (в таком случае она используется в качестве ключа). Не используется, если $name — ассоциативный массив, иначе служит значениями для ключей $name.

Возвращает

$this

viewBuilder()source public

viewBuilder( )

Получить используемый билдер представлений.

Возвращает

Cake\View\ViewBuilder

viewOptions()source public deprecated

viewOptions( string|array|null $options = null , boolean $merge = true )

Получить/установить допустимые опции представления в свойстве _validViewOptions объекта. Свойство создаётся как пустой массив, если оно не задано. Если вызывается без параметров, возвращает текущий список допустимых опций представления. См. createView().

Устарело

3.7.0 Используйте ViewBuilder::setOptions() или любой из методов-сеттеров вместо него.

Параметры

string|array|null $options optional null

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

boolean $merge optional true

Объединять или перезаписывать существующие допустимые опции представления. По умолчанию true.

Возвращает

array
Обновлённые опции представления в виде массива.

[]

[]

[]

['UTF-8', 'SHIFT_JIS']

[
    'ISO-2022-JP-MS' => 'ISO-2022-JP'
]

[]

'text'

['text', 'html', 'both']

self::EMAIL_PATTERN

[]

[]

''

[]

true

[]

[]

[]

[]

[]

''

''

[]

[
    '7bit',
    '8bit',
    'base64',
    'binary',
    'quoted-printable'
]

'utf-8'