Класс Email

__clone()source public

__clone( )

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

__construct()source public

__construct( array|string|null $config null )

Конструктор

Параметры

array|string|null $config optional null

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

_addEmail()source protected

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

Добавление email

Параметры

string $varName

Имя свойства

string|array $email

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

string $name

Имя

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

$this

Исключения

InvalidArgumentException

_applyConfig()source protected

_applyConfig( string|array $config )

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

Параметры

string|array $config

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

Исключения

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

_attachFiles()source protected

_attachFiles( string|null $boundary null )

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

Параметры

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

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

Возвращает

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

_attachInlineFiles()source protected

_attachInlineFiles( string|null $boundary null )

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

Параметры

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

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

Возвращает

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

_checkViewVars()source protected

_checkViewVars( mixed $item , string $key )

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

Параметры

mixed $item

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

string $key

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

_constructTransport()source protected

_constructTransport( string $name )

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

Параметры

string $name

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

Возвращает

Cake\Mailer\AbstractTransport

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

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

_createBoundary()source protected

_createBoundary( )

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

_decode()source protected

_decode( string $text )

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

Параметры

string $text

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

Возвращает

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

_encode()source protected

_encode( string $text )

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

Параметры

string $text

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

Возвращает

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

_encodeString()source protected

_encodeString( string $text , string $charset )

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

Параметры

string $text

Текст, подлежащий преобразованию

string $charset

Кодировка назначения

Возвращает

string

_formatAddress()source protected

_formatAddress( array $address )

Форматирует адреса.

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

Параметры

array $address

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

Возвращает

array

_getContentTransferEncoding()source protected

_getContentTransferEncoding( )

Возвращает значение Content-Transfer Encoding на основе установленного transferEncoding или установленной кодировки.

Возвращает

string

_getContentTypeCharset()source protected

_getContentTypeCharset( )

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

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

Возвращает

string

_getTypes()source protected

_getTypes( )

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

Возвращает

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

_logDelivery()source protected

_logDelivery( array $contents )

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

Параметры

array $contents

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

_readFile()source protected

_readFile( string $path )

Считывает содержимое файла и возвращает версию содержимого файла в кодировке base64.

Параметры

string $path

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

Возвращает

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

_render()source protected

_render( array $content )

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

Параметры

array $content

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

Возвращает

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

_renderTemplates()source protected

_renderTemplates( string $content )

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

Параметры

string $content

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

Возвращает

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

_setEmail()source protected

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

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

Параметры

string $varName

Имя свойства

string|array $email

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

string $name

Имя

Возвращает

$this

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

InvalidArgumentException

_setEmailSingle()source protected

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

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

Параметры

string $varName

Имя свойства

string|array $email

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

string $name

Имя

string $throwMessage

Сообщение об исключении

Возвращает

$this

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

InvalidArgumentException

_validateEmail()source protected

_validateEmail( string $email , string $context )

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

Параметры

string $email

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

string $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

attachments( string|array|null $attachments null )

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

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

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

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

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

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

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

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

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

$email->attachments(['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

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

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

charset( string|null $charset null )

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

Устаревшее

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

Параметры

строка|null $charset опционально null

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

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

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

configTransport()source public static

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

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

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

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

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

Устаревшее

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

Параметры

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

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

массив|Cake\Mailer\AbstractTransport|null $config опционально null

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

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

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

Исключения

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

configuredTransport()source public static

configuredTransport( )

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

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

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

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 $transportConfig '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 $transportConfig необязательно 'default'

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

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

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

Возвращает

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

Выбрасывает

InvalidArgumentException

domain()source public

domain( string|null $domain null )

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

Устарело

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

Параметры

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

Вручную задайте домен для отправки по CLI

Возвращает

string|Cake\Mailer\Email
$this

dropTransport()source public static

dropTransport( string $key )

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

Параметры

string $key

Название транспорта для удаления.

emailFormat()source public

emailFormat( string|null $format null )

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

Устарело

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

Параметры

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

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

Возвращает

string|Cake\Mailer\Email
$this

Выбрасывает

InvalidArgumentException

emailPattern()source public

emailPattern( string|boolean|null $regex false )

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

Устарело

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

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

getConfigTransport( string $key )

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

Параметры

string $key

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

Возвращает

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

getDomain()source public

getDomain( )

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

Возвращает

string

getEmailFormat()source public

getEmailFormat( )

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

Возвращает

string

getEmailPattern()source public

getEmailPattern( )

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

Возвращает

string

getFrom()source public

getFrom( )

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

Возвращает

array

getHeaderCharset()source public

getHeaderCharset( )

Получение HeaderCharset.

Возвращает

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

getHeaders()source public

getHeaders( array $include [] )

Получение списка заголовков

Включает:

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

Параметры

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

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

Возвращает

array

getHelpers()source public

getHelpers( )

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

Возвращает

array

getLayout()source public

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

Получить адрес "Ответ".

Возвращает

array

getReturnPath()source public

getReturnPath( )

Получить обратный путь.

Возвращает

array

getSender()source public

getSender( )

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

Возвращает

array

getSubject()source public

getSubject( )

Получить тему.

Возвращает

string

getTemplate()source public

getTemplate( )

Получить шаблон.

Возвращает

string

getTheme()source public

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

headerCharset( string|null $charset null )

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

Устарело

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

Параметры

string|null $charset optional null

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

Возвращает

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

helpers()source public

helpers( array|null $helpers null )

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

Устарело

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

Параметры

array|null $helpers optional 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 optional null

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

Возвращает

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

messageId()source public

messageId( boolean|string|null $message null )

Message-ID

Устарело

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

Параметры

boolean|string|null $message optional null

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

Возвращает

boolean|string|Cake\Mailer\Email
$this

Выбрасывает

InvalidArgumentException

profile()source public

profile( null|string|array $config null )

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

Устарело

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

Параметры

null|string|array $config optional null

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

Возвращает

string|array|Cake\Mailer\Email
$this

readReceipt()source public

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

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

Устарело

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

Параметры

string|array|null $email optional null

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

string|null $name optional null

Имя

Возвращает

array|Cake\Mailer\Email
$this

Выбрасывает

InvalidArgumentException

replyTo()source public

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

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

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->attachments('path/to/file');

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

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

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

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

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

$email->attachments(['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

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

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

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

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

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

Параметры

string|array $key

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

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

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

Выбрасывает

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

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

setHelpers( array $helpers )

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

Параметры

массив $helpers

Список помогающих функций.

Возвращает

$this

setLayout()source public

setLayout( string|null $layout )

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

Параметры

строка|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

setTheme( string $theme )

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

Параметры

строка $theme

Имя темы.

Возвращает

$this

setTo()source public

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

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

Параметры

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

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

строка|null $name дополнительно null

Имя

Возвращает

$this

setTransferEncoding()source public

setTransferEncoding( string|null $encoding )

Установщик TransferEncoding.

Параметры

строка|null $encoding

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

Возвращает

$this

setTransport()source public

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

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

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

Параметры

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

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

Возвращает

$this

Выбрасывает

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

setViewRenderer()source public

setViewRenderer( string $viewClass )

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

Параметры

строка $viewClass

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

Возвращает

$this

setViewVars()source public

setViewVars( array $viewVars )

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

Параметры

массив $viewVars

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

Возвращает

$this

subject()source public

subject( string|null $subject null )

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

Устарело

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

Параметры

строка|null $subject дополнительно null

Строка темы.

Возвращает

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

template()source public

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

theme( string|null $theme null )

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

Устарело

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

Параметры

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

Имя темы.

Возвращает

string|Cake\Mailer\Email
$this

to()source public

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

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
Если выбранный транспорт не имеет метода send.
InvalidArgumentException
Если $name не является строкой или объектом.

unserialize()source public

unserialize( string $data )

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

Параметры

string $data

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

Возвращает

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

Реализация

Serializable::unserialize()

viewRender()source public

viewRender( string|null $viewClass null )

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

Устарело

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

Параметры

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

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

Возвращает

string|Cake\Mailer\Email
$this

viewVars()source public

viewVars( array|null $viewVars null )

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

Устарело

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

Параметры

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

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

Возвращает

array|Cake\Mailer\Email
$this

config()source public static

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

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

Возвращает

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

Исключения

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

configured()source public static

configured( )

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

Возвращает

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

drop()source public static

drop( string $config )

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

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

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

Параметры

string $config

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

Возвращает

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

dsnClassMap()source public static

dsnClassMap( array $map null )

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

Устарело

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

Параметры

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

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

Возвращает

array

getConfig()source public static

getConfig( string $key )

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

Параметры

string $key

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

Возвращает

array|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 необязательно null

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

Исключения

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

setDsnClassMap()source public static

setDsnClassMap( array $map )

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

Параметры

array $map

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

createView()source public

createView( string|null $viewClass null )

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

Параметры

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

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

Возвращает

Cake\View\View

Исключения

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

set()source public

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

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

Параметры

string|array $name

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

mixed $value необязательно null

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

Возвращает

$this

viewBuilder()source public

viewBuilder( )

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

Возвращает

Cake\View\ViewBuilder

viewOptions()source public

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

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

Параметры

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

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

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

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

Возвращает

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

[]

[]

[]

['UTF-8', 'SHIFT_JIS']

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

[
    'debug' => 'Cake\Mailer\Transport\DebugTransport',
    'mail' => 'Cake\Mailer\Transport\MailTransport',
    'smtp' => 'Cake\Mailer\Transport\SmtpTransport',
]

'text'

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

self::EMAIL_PATTERN

[]

[]

''

[]

true

[]

[]

[]

[]

[]

''

''

[]

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

[]

'utf-8'