Класс Email

__clone()source public

__clone( )

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

__construct()source public

__construct( array|string|null $config null )

Конструктор

Параметры

array|string|null $config необязательно 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, основанное на установленном наборе символов

Возвращает

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 )

Прочитать содержимое файла и вернуть базовый64-версию содержимого файла.

Параметры

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

Параметры

string $message

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

integer $wrapLength необязательный Email::LINE_LENGTH_MUST

Длина строки

Возвращает

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

addAttachments()source public

addAttachments( string|array $attachments )

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

Параметры

string|array $attachments

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

Возвращает

$this

Исключение

InvalidArgumentException

См. также

\Cake\Mailer\Email::attachments()

addBcc()source public

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

Добавить Bcc

Параметры

string|array $email

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

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

Имя

Возвращает

$this

addCc()source public

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

Добавить Cc

Параметры

string|array $email

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

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

Имя

Возвращает

$this

addHeaders()source public

addHeaders( array $headers )

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

Параметры

array $headers

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

Возвращает

$this

addTo()source public

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

Добавить Получателя

Параметры

string|array $email

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

string|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() вместо этого.

Параметры

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

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

Возвращает

array|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() вместо этого.

Параметры

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

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

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

Имя

Возвращает

array|Cake\Mailer\Email
$this

cc()source public

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

Cc

Устаревшее

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

Параметры

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

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

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

Имя

Возвращает

array|Cake\Mailer\Email
$this

charset()source public

charset( string|null $charset null )

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

Устаревшее

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

Параметры

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

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

Возвращает

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

configTransport()source public static

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

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

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

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

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

Устаревшее

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

Параметры

string|array $key

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

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

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

Возвращает

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

Выбрасывает

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

configuredTransport()source public static

configuredTransport( )

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

Возвращает

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

createFromArray()source public

createFromArray( array $config )

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

Параметры

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

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

Возвращает

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 )

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

Устарело

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

Параметры

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

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

Возвращает

string|Cake\Mailer\Email
$this

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

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

Возвращает

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

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

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

Возвращает

string
Кодировка

helpers()source public

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

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

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

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

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

Reply-To

Устарело

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

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

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

Устанавливает адрес "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

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

subject( string|null $subject null )

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

Устарело

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

Параметры

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

Строка темы.

Возвращает

string|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
При отсутствии метода отправки выбранного транспорта.
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

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

Возвращает

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

[]

[]

[]

[]

[]

''

''

[]

[]

'utf-8'