Класс 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

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

строка $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, основанное на установленной передаче кодировки или кодировке символов.

Возвращает

string

_getContentTypeCharset()source protected

_getContentTypeCharset( )

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

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

Возвращает

string

_getTypes()source protected

_getTypes( )

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

Возвращает

array
Массив типов. Допустимые типы — 'текст' и '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 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 Используйте 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 $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'

Строка для использования профиля доставки Email из 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

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

Возвращает

string|Cake\Mailer\Email
$this

dropTransport()source public static

dropTransport( string $key )

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

Параметры

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

getConfigTransport( string $key )

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

Параметры

string $key

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

Возвращает

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

getDomain()source public

getDomain( )

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

Возвращает

string

getEmailFormat()source public

getEmailFormat( )

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

Возвращает

string

getEmailPattern()source public

getEmailPattern( )

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

Возвращает

string

getFrom()source public

getFrom( )

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

Возвращает

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

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

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

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

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

Возвращает

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

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

Параметры

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 )

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

Параметры

array $headers

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

Возвращает

$this

setHelpers()source public

setHelpers( array $helpers )

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

Параметры

array $helpers

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

Возвращает

$this

setLayout()source public

setLayout( string|null $layout )

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

Параметры

string|null $layout

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

Возвращает

$this

setMessageId()source public

setMessageId( boolean|string $message )

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

Параметры

boolean|string $message

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

Возвращает

$this

Исключения

InvalidArgumentException

setPriority()source public

setPriority( integer|null $priority )

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

Параметры

integer|null $priority

1 (высший) до 5 (низший)

Возвращает

$this

setProfile()source public

setProfile( string|array $config )

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

Параметры

string|array $config

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

Возвращает

$this

setReadReceipt()source public

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

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

Параметры

string|array $email

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

string|null $name опционально null

Имя

Возвращает

$this

Исключения

InvalidArgumentException

setReplyTo()source public

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

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

Параметры

string|array $email

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

string|null $name опционально null

Имя

Возвращает

$this

Исключения

InvalidArgumentException

setReturnPath()source public

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

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

Параметры

string|array $email

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

string|null $name опционально null

Имя

Возвращает

$this

Исключения

InvalidArgumentException

setSender()source public

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

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

Параметры

string|array $email

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

string|null $name опционально null

Имя

Возвращает

$this

Исключения

InvalidArgumentException

setSubject()source public

setSubject( string $subject )

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

Параметры

string $subject

Строка темы.

Возвращает

$this

setTemplate()source public

setTemplate( string|null $template )

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

Параметры

string|null $template

Имя шаблона или null для отключения шаблона.

Возвращает

$this

setTheme()source public

setTheme( string $theme )

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

Параметры

string $theme

Имя темы.

Возвращает

$this

setTo()source public

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

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

Параметры

string|array $email

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

string|null $name опционально null

Имя

Возвращает

$this

setTransferEncoding()source public

setTransferEncoding( string|null $encoding )

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

Параметры

string|null $encoding

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

Возвращает

$this

setTransport()source public

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

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

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

Параметры

string|Cake\Mailer\AbstractTransport $name

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

Возвращает

$this

Исключения

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

setViewRenderer()source public

setViewRenderer( string $viewClass )

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

Параметры

string $viewClass

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

Возвращает

$this

setViewVars()source public

setViewVars( array $viewVars )

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

Параметры

array $viewVars

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

Возвращает

$this

subject()source public deprecated

subject( string|null $subject = null )

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

Устаревшее

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

Параметры

string|null $subject опционально null

Строка темы.

Возвращает

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

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

Возвращает

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 deprecated

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 если не указано иное.

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

Параметры

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

Параметры

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

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

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

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

Исключения

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

setDsnClassMap()source public static

setDsnClassMap( array $map )

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

Параметры

массив $map

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

createView()source public

createView( string|null $viewClass = null )

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

Параметры

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

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

Возвращает

Cake\View\View

Исключения

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

set()source public

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

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

Параметры

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

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

смешанное $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().

Параметры

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

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

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

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

Возвращает

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

[]

[]

[]

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