Класс Message

Класс сообщения электронной почты.

Этот класс используется для отправки сообщений в формате Internet Message Format, основанном на стандарте, описанном в https://www.rfc-editor.org/rfc/rfc2822.txt

Пространство имён: Cake\Mailer

Константы

string

EMAIL_PATTERN
```
'/^((?:[\\p{L}0-9.!#$%&\'*+\\/=?^_`{|}~-]+)*@[\\p{L}0-9-._]+)$/ui'
```
Содержит шаблон регулярных выражений для проверки адреса электронной почты
int

LINE_LENGTH_MUST
```
998
```
Длина строки — не должна превышать — RFC 2822 — 2.1.1
int

LINE_LENGTH_SHOULD
```
78
```
Длина строки — не рекомендуется превышать — RFC 2822 — 2.1.1
string

MESSAGE_BOTH
```
'both'
```
Тип сообщения — BOTH
string

MESSAGE_HTML
```
'html'
```
Тип сообщения — HTML
string

MESSAGE_TEXT
```
'text'
```
Тип сообщения — TEXT

Краткое описание свойств

$appCharset protected

string|null

Кодировка символов приложения, используемая для кодирования заголовков и тела
$attachments protected

array<string, array>

Список файлов, которые должны быть прикреплены к электронной почте.
$bcc protected

array

Скрытая копия
$boundary protected

string|null

Если установлено, граница для использования multipart mime сообщений
$cc protected

array

Копия
$charset protected

string

Кодировка символов, в которой отправляется тело электронной почты
$charset8bit protected

array<string>

Кодировки символов 8 бит
$contentTypeCharset protected

array<string, string>

Определение имени набора символов Content-Type
$domain protected

string

Домен для генерации messageId. Необходимо установить вручную для рассылки из командной строки, так как env('HTTP_HOST') пуст
$emailFormat protected

string

В каком формате должна быть отправлена электронная почта
$emailFormatAvailable protected

array<string>

Доступные форматы для отправки.
$emailPattern protected

string|null

Регулярное выражение для проверки адреса электронной почты
$from protected

array

Адрес электронной почты, с которого отправляется электронное письмо
$headerCharset protected

string|null

Кодировка символов заголовка электронной почты. Если null, свойство $charset будет использоваться по умолчанию
$headers protected

array

Ассоциативный массив пользовательских заголовков. Ключи будут иметь префикс 'X-' в соответствии с RFC2822, раздел 4.7.5
$htmlMessage protected

string

Сообщение HTML
$message protected

array

Окончательное сообщение для отправки
$messageId protected

string|bool

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

int|null

Содержит необязательный приоритет электронной почты.
$readReceipt protected

array

Электронная почта для подтверждения прочтения
$replyTo protected

array

Список адресов электронной почты, на которые будет отправлен ответ
$returnPath protected

array
Адрес электронной почты, который будет использоваться в случае ошибок, таких как:
- Сервер электронной почты недоступен
- Пользователь превысил квоту
- Неизвестный пользователь
$sender protected

array

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

string

Тема электронного письма
$textMessage protected

string

Текстовое сообщение
$to protected

array

Получатель электронной почты
$transferEncoding protected

string|null

Используемая кодировка передачи электронной почты. Если null, свойство $charset используется для определения кодировки передачи.
$transferEncodingAvailable protected

array<string>

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

END_OF_DOCUMENT_MARKER

Краткое описание методов

__construct()public
Конструктор
__serialize()public
Магический метод, используемый для сериализации объекта Message.
__unserialize()public
Магический метод, используемый для восстановления объекта Message.
addAttachments()public
Добавить вложения
addBcc()public
Добавить адрес "bcc".
addCc()public
Добавить адрес "cc".
addEmail()protected
Добавить электронную почту
addHeaders()public
Добавить заголовок для сообщения
addReplyTo()public
Добавить адрес "Reply-To".
addTo()public
Добавить адрес "To".
attachFiles()protected
Прикрепить файлы, не встроенные в сообщение, добавив содержимое файлов внутри границ.
attachInlineFiles()protected
Прикрепить встроенные файлы к сообщению.
createBoundary()protected
Создать уникальный идентификатор границы
createFromArray()public
Настраивает объект экземпляра электронной почты из сериализованной конфигурации.
decodeForHeader()protected
Декодировать указанную строку
encodeForHeader()protected
Кодировать указанную строку с помощью текущего набора символов
encodeString()protected
Преобразует строку из одного набора символов в другой, если значение App.encoding отличается, и функция mb_convert_encoding существует
formatAddress()protected
Форматировать адреса
generateMessage()protected
Сгенерировать полное сообщение.
getAttachments()public
Получить вложения к сообщению электронной почты.
getBcc()public
Получить адрес "bcc".
getBody()public
Получить сгенерированное тело сообщения в виде массива.
getBodyHtml()public
Получить HTML тело сообщения.
getBodyString()public
Получить сгенерированное тело в виде строки.
getBodyText()public
Получить текстовое тело сообщения.
getBodyTypes()public
Получить типы тел, которые содержатся в данном электронном письме
getCc()public
Получить адрес "cc".
getCharset()public
Получить кодировку символов.
getContentTransferEncoding()public
Возвращает значение Content-Transfer Encoding на основе установленного transferEncoding или установленного набора символов.
getContentTypeCharset()public
Возвращает значение набора символов для Content-Type.
getDomain()public
Получить домен.
getEmailFormat()public
Получить формат электронной почты.
getEmailPattern()public
Установка/получение EmailPattern
getFrom()public
Получить адрес "от".
getHeaderCharset()public
Получить кодировку символов заголовков.
getHeaders()public
Получить список заголовков
getHeadersString()public
Получить заголовки в виде строки.
getMessageId()public
Получить идентификатор сообщения.
getOriginalSubject()public
Получить исходный предмет без кодирования
getPriority()public
Получить приоритет.
getReadReceipt()public
Получить подтверждение прочтения (заголовок Disposition-Notification-To).
getReplyTo()public
Получить адрес "Ответить кому".
getReturnPath()public
Получить обратный путь.
getSender()public
Получить адрес "отправителя". См. ссылку RFC ниже для полного объяснения.
getSubject()public
Получить предмет.
getTo()public
Получить адрес "получателя".
getTransferEncoding()public
Получить TransferEncoding.
jsonSerialize()public
Сериализует объект электронной почты в значение, которое может быть напрямую сериализован и повторно использован для клонирования этого экземпляра электронной почты.
readFile()protected
Прочитать содержимое файла и вернуть его базовый64-версию.
reset()public
Сбросить все внутренние переменные, чтобы можно было отправить новое электронное письмо.
serialize()public
Сериализует объект Email.
setAttachments()public
Добавить вложения к сообщению электронной почты.
setBcc()public
Установить адрес "bcc".

setBody() public

Установить тело сообщения.
setBodyHtml() public

Установить HTML тело сообщения.
setBodyText() public

Установить текстовое тело сообщения.
setCc() public

Устанавливает адрес "cc".
setCharset() public

Установка кодировки символов.
setConfig() public

Устанавливает конфигурацию для данного экземпляра.
setDomain() public

Устанавливает домен.
setEmail() protected

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

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

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

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

Устанавливает адрес "от".
setHeaderCharset() public

Установка кодировки заголовков.
setHeaders() public

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

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

Устанавливает приоритет.
setReadReceipt() public

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

Устанавливает адрес "Ответ".
setReturnPath() public

Устанавливает обратный путь.
setSender() public

Устанавливает адрес "отправитель". См. ссылку RFC ниже для полного объяснения.
setSubject() public

Устанавливает тему.
setTo() public

Устанавливает адрес "кому".
setTransferEncoding() public

Установка кодировки передачи.
unserialize() public

Десериализует объект Message.
validateEmail() protected

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

Упаковать сообщение в соответствии с RFC 2822 - 2.1.1

Подробное описание методов

__construct() public

__construct(array<string, mixed>|null $config = null)

Конструктор

Параметры

array<string, mixed>|null $config optional: Массив конфигураций или строка для загрузки конфигураций из app.php

__serialize() public

__serialize(): array

Магический метод, используемый для сериализации объекта Message.

Возвращает

array

__unserialize() public

__unserialize(array $data): void

Магический метод, используемый для восстановления объекта Message.

Параметры

array $data: Массив данных.

Возвращает

void

addAttachments() public

addAttachments(array $attachments): $this

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

Параметры

array $attachments: Массив имён файлов.

Возвращает

$this

Исключения

InvalidArgumentException

См. также

\Cake\Mailer\Email::setAttachments()

addBcc() public

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

Добавить адрес "bcc".

Параметры

array|string $email: Строка с адресом электронной почты, массив с адресом электронной почты в качестве ключа, именем в качестве значения или адресом электронной почты в качестве значения (без имени)
string|null $name optional: Имя

Возвращает

$this

addCc() public

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

Добавить адрес "cc".

Параметры

array|string $email: Строка с адресом электронной почты, массив с адресом электронной почты в качестве ключа, именем в качестве значения или адресом электронной почты в качестве значения (без имени)
string|null $name optional: Имя

Возвращает

$this

addEmail() protected

addEmail(string $varName, array|string $email, string|null $name): $this

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

Параметры

string $varName: Имя свойства
array|string $email: Строка с адресом электронной почты, массив с адресом электронной почты в качестве ключа, именем в качестве значения или адресом электронной почты в качестве значения (без имени)
string|null $name: Имя

Возвращает

$this

Исключения

InvalidArgumentException

addHeaders() public

addHeaders(array $headers): $this

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

Параметры

array $headers: Заголовки для установки.

Возвращает

$this

addReplyTo() public

addReplyTo(array|string $email, string|null $name = null): $this

Добавить адрес "Reply-To".

Параметры

array|string $email: Строка с адресом электронной почты, массив с адресом электронной почты в качестве ключа, именем в качестве значения или адресом электронной почты в качестве значения (без имени)
string|null $name optional: Имя

Возвращает

$this

addTo() public

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

Добавить адрес "To".

Параметры

array|string $email: Строка с адресом электронной почты, массив с адресом электронной почты в качестве ключа, именем в качестве значения или адресом электронной почты в качестве значения (без имени)
string|null $name optional: Имя

Возвращает

$this

attachFiles() protected

attachFiles(string|null $boundary = null): array<string>

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

Параметры

string|null $boundary optional: Граница для использования. Если null, будет использоваться $this->boundary

Возвращает

array<string>

attachInlineFiles() protected

attachInlineFiles(string|null $boundary = null): array<string>

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

Параметры

string|null $boundary optional: Граница для использования. Если null, будет использоваться $this->boundary

Возвращает

array<string>

createBoundary() protected

createBoundary(): void

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

Возвращает

void

createFromArray() public

createFromArray(array<string, mixed> $config): $this

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

Параметры

array<string, mixed> $config: Массив конфигурации электронной почты.

Возвращает

$this

decodeForHeader() protected

decodeForHeader(string $text): string

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

Параметры

string $text: Строка для декодирования

Возвращает

string

encodeForHeader() protected

encodeForHeader(string $text): string

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

Параметры

string $text: Строка для кодирования

Возвращает

string

encodeString() protected

encodeString(string $text, string $charset): string

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

Параметры

string $text: Текст, который нужно преобразовать
string $charset: Целевая кодировка

Возвращает

string

formatAddress() protected

formatAddress(array $address): array

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

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

Параметры

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

Возвращает

array

generateMessage() protected

generateMessage(): array<string>

Сгенерировать полное сообщение.

Возвращает

array<string>

getAttachments() public

getAttachments(): array<string, array>

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

Возвращает

array<string, array>

getBcc() public

getBcc(): array

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

Возвращает

array

getBody() public

getBody(): array

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

Возвращает

array

getBodyHtml() public

getBodyHtml(): string

Получить HTML тело сообщения.

Возвращает

string

getBodyString() public

getBodyString(string $eol = "\r\n"): string

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

Параметры

string $eol опционально: Строка конца строки для объединения.

Возвращает

string

См. также

Message::getBody()

getBodyText() public

getBodyText(): string

Получить текстовое тело сообщения.

Возвращает

string

getBodyTypes() public

getBodyTypes(): array

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

Возвращает

array

getCc() public

getCc(): array

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

Возвращает

array

getCharset() public

getCharset(): string

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

Возвращает

string

getContentTransferEncoding() public

getContentTransferEncoding(): string

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

Возвращает

string

getContentTypeCharset() public

getContentTypeCharset(): string

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

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

Возвращает

string

getDomain() public

getDomain(): string

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

Возвращает

string

getEmailFormat() public

getEmailFormat(): string

Получить формат электронного письма.

Возвращает

string

getEmailPattern() public

getEmailPattern(): string|null

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

Возвращает

string|null

getFrom() public

getFrom(): array

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

Возвращает

array

getHeaderCharset() public

getHeaderCharset(): string

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

Возвращает

string

getHeaders() public

getHeaders(array<string> $include = []): array<string>

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

Включает:

from
replyTo
readReceipt
returnPath
to
cc
bcc
subject

Параметры

array<string> $include опционально: Список заголовков.

Возвращает

array<string>

getHeadersString() public

getHeadersString(array<string> $include = [], string $eol = "\r\n", Closure|null $callback = null): string

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

Параметры

array<string> $include опционально: Список заголовков.
string $eol опционально: Строка конца строки для конкатенации заголовков.
Closure|null $callback опционально: Обратный вызов для обработки каждого значения заголовка перед преобразованием в строку.

Возвращает

string

См. также

Message::getHeaders()

getMessageId() public

getMessageId(): string|bool

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

Возвращает

string|bool

getOriginalSubject() public

getOriginalSubject(): string

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

Возвращает

string

getPriority() public

getPriority(): int|null

Получить приоритет.

Возвращает

int|null

getReadReceipt() public

getReadReceipt(): array

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

Возвращает

array

getReplyTo() public

getReplyTo(): array

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

Возвращает

array

getReturnPath() public

getReturnPath(): array

Получить возвращаемый путь.

Возвращает

array

getSender() public

getSender(): array

Получить адрес "отправителя". См. ссылку на RFC ниже для полного объяснения.

Возвращает

array

Ссылки

https://tools.ietf.org/html/rfc2822.html#section-3.6.2

getSubject() public

getSubject(): string

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

Возвращает

string

getTo() public

getTo(): array

Получить адрес "кому".

Возвращает

array

getTransferEncoding() public

getTransferEncoding(): string|null

Получение TransferEncoding.

Возвращает

string|null

jsonSerialize() public

jsonSerialize(): array

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

Возвращает

array

Исключения

Exception
При невозможности правильной сериализации объекта view var.

readFile() protected

readFile(Psr\Http\Message\UploadedFileInterface|string $file): string

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

Параметры

Psr\Http\Message\UploadedFileInterface|string $file: Абсолютный путь к файлу для чтения или экземпляр UploadedFileInterface.

Возвращает

string

reset() public

reset(): $this

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

Возвращает

$this

serialize() public

serialize(): string

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

Возвращает

string

setAttachments() public

setAttachments(array $attachments): $this

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

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

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

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

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

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

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

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

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

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

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

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

Parameters

array $attachments: Массив имен файлов.

Returns

$this

Throws

InvalidArgumentException

setBcc() public

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

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

Parameters

array|string $email: Строка с адресом электронной почты, массив с адресом электронной почты в качестве ключа, именем в качестве значения или адресом электронной почты в качестве значения (без имени)
string|null $name optional: Имя

Returns

$this

setBody() public

setBody(array<string, string> $content): $this

Установить тело сообщения.

Parameters

array<string, string> $content: Массив содержимого с ключами "text" и/или "html" со строкой содержимого соответствующего типа.

Returns

$this

setBodyHtml() public

setBodyHtml(string $content): $this

Установить HTML-тело сообщения.

Parameters

string $content: Строка содержимого

Returns

$this

setBodyText() public

setBodyText(string $content): $this

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

Parameters

string $content: Строка содержимого

Returns

$this

setCc() public

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

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

Parameters

array|string $email: Строка с адресом электронной почты, массив с адресом электронной почты в качестве ключа, именем в качестве значения или адресом электронной почты в качестве значения (без имени)
string|null $name optional: Имя

Returns

$this

setCharset() public

setCharset(string $charset): $this

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

Parameters

string $charset: Кодировка.

Returns

$this

setConfig() public

setConfig(array<string, mixed> $config): $this

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

Parameters

array<string, mixed> $config: Массив конфигурации.

Returns

$this

setDomain() public

setDomain(string $domain): $this

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

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

Parameters

string $domain: Вручную установить домен для рассылки CLI.

Returns

$this

setEmail() protected

setEmail(string $varName, array|string $email, string|null $name): $this

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

Parameters

string $varName: Имя свойства
array|string $email: Строка с адресом электронной почты, массив с адресом электронной почты в качестве ключа, именем в качестве значения или адресом электронной почты в качестве значения (без имени)
string|null $name: Имя

Returns

$this

Throws

InvalidArgumentException

setEmailFormat() public

setEmailFormat(string $format): $this

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

Parameters

string $format: Форматирующая строка.

Returns

$this

Throws

InvalidArgumentException

setEmailPattern() public

setEmailPattern(string|null $regex): $this

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

Parameters

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

Returns

$this

setEmailSingle() protected

setEmailSingle(string $varName, array|string $email, string|null $name, string $throwMessage): $this

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

Parameters

string $varName: Имя свойства
array|string $email: Строка с адресом электронной почты, массив с адресом электронной почты в качестве ключа, именем в качестве значения или адресом электронной почты в качестве значения (без имени)
string|null $name: Имя
string $throwMessage: Сообщение об исключении

Returns

$this

Throws

InvalidArgumentException

setFrom() public

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

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

Parameters

array|string $email: Строка с адресом электронной почты, массив с адресом электронной почты в качестве ключа, именем в качестве значения или адресом электронной почты в качестве значения (без имени)
string|null $name optional: Имя

Returns

$this

Throws

InvalidArgumentException

setHeaderCharset() public

setHeaderCharset(string|null $charset): $this

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

Parameters

string|null $charset: Кодировка.

Returns

$this

setHeaders() public

setHeaders(array $headers): $this

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

Parameters

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

Returns

$this

setMessageId() public

setMessageId(string|bool $message): $this

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

Parameters

string|bool $message: True для генерации нового Message-ID, False для игнорирования (не отправлять в электронном письме), строка для установки в качестве Message-ID.

Returns

$this

Throws

InvalidArgumentException

setPriority() public

setPriority(int|null $priority): $this

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

Parameters

int|null $priority: От 1 (наивысший) до 5 (наинизший)

Returns

$this

setReadReceipt() public

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

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

Parameters

array|string $email: Строка с адресом электронной почты, массив с адресом электронной почты в качестве ключа, именем в качестве значения или адресом электронной почты в качестве значения (без имени)
string|null $name optional: Имя

Returns

$this

Throws

InvalidArgumentException

setReplyTo() public

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

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

Параметры

array|string $email: Строка с адресом электронной почты, Массив с адресом электронной почты в качестве ключа, именем в качестве значения или адресом электронной почты в качестве значения (без имени)
string|null $name необязательно: Имя

Возвращает

$this

Исключения

InvalidArgumentException

setReturnPath() public

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

Устанавливает обратный путь.

Параметры

array|string $email: Строка с адресом электронной почты, Массив с адресом электронной почты в качестве ключа, именем в качестве значения или адресом электронной почты в качестве значения (без имени)
string|null $name необязательно: Имя

Возвращает

$this

Исключения

InvalidArgumentException

setSender() public

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

Устанавливает адрес "отправителя". См. ссылку RFC ниже для полного объяснения.

Параметры

array|string $email: Строка с адресом электронной почты, Массив с адресом электронной почты в качестве ключа, именем в качестве значения или адресом электронной почты в качестве значения (без имени)
string|null $name необязательно: Имя

Возвращает

$this

Исключения

InvalidArgumentException

Ссылки

https://tools.ietf.org/html/rfc2822.html#section-3.6.2

setSubject() public

setSubject(string $subject): $this

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

Параметры

string $subject: Строка темы.

Возвращает

$this

setTo() public

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

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

Параметры

array|string $email: Строка с адресом электронной почты, Массив с адресом электронной почты в качестве ключа, именем в качестве значения или адресом электронной почты в качестве значения (без имени)
string|null $name необязательно: Имя

Возвращает

$this

setTransferEncoding() public

setTransferEncoding(string|null $encoding): $this

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

Параметры

string|null $encoding: Установленное кодирование.

Возвращает

$this

Исключения

InvalidArgumentException

unserialize() public

unserialize(string $data): void

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

Параметры

string $data: Сериализованная строка.

Возвращает

void

validateEmail() protected

validateEmail(string $email, string $context): void

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

Параметры

string $email: Адрес электронной почты для проверки
string $context: Свойство, которое было установлено

Возвращает

void

Исключения

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

wrap() protected

wrap(string|null $message = null, int $wrapLength = self::LINE_LENGTH_MUST): array<string>

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

Параметры

string|null $message необязательно: Сообщение для обертывания
int $wrapLength необязательно: Длина строки

Возвращает

array<string>

Подробное описание свойства

`$appCharset` protected

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

Тип

string|null

`$attachments` protected

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

Только абсолютные пути

Тип

array<string, array>

`$bcc` protected

Скрытая копия.

Список адресов электронной почты, которые должны получить копию письма. Получатель НЕ сможет увидеть этот список.

Тип

array

`$boundary` protected

Если задано, граница для использования в сообщениях MIME с несколькими частями.

Тип

string|null

`$cc` protected

Копия.

Список адресов электронной почты, которые должны получить копию письма. Получатель СМОЖЕТ увидеть этот список.

Тип

array

`$charset` protected

Кодировка символов тела письма.

Тип

string

`$charset8bit` protected

Наборы символов 8-битных.

Тип

array<string>

`$contentTypeCharset` protected

Определяет имя кодировки символов Content-Type.

Тип

array<string, string>

`$domain` protected

Домен для генерации идентификатора сообщения. Необходимо вручную установить для отправки почты из командной строки, так как env('HTTP_HOST') пуст.

Тип

string

`$emailFormat` protected

В каком формате должно отправляться письмо.

Тип

string

`$emailFormatAvailable` protected

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

Тип

array<string>

`$emailPattern` protected

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

Если null, будет использоваться filter_var(). Используйте метод emailPattern() для установки пользовательского шаблона.

Тип

string|null

`$from` protected

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

Тип

array

`$headerCharset` protected

Кодировка символов заголовка письма. Если null, в качестве значения по умолчанию используется свойство $charset.

Тип

string|null

`$headers` protected

Ассоциативный массив пользовательских заголовков. Ключи будут префикс «X-» в соответствии с RFC2822 Раздел 4.7.5.

Тип

array

`$htmlMessage` protected

HTML-сообщение.

Тип

string

`$message` protected

Конечное сообщение для отправки.

Тип

array

`$messageId` protected

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

Тип

string|bool

`$priority` protected

Содержит необязательный приоритет письма.

Тип

int|null

`$readReceipt` protected

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

Тип

array

`$replyTo` protected

Список адресов электронной почты, на которые будет отправлен ответ.

Тип

array

`$returnPath` protected

Адрес электронной почты, который будет использован в случае ошибок, таких как:

Отказ сервера удалённого почтового сервера.
Пользователь превысил лимит.
Неизвестный пользователь.

Тип

array

`$sender` protected

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

Тип

array

`$subject` protected

Тема письма.

Тип

string

`$textMessage` protected

Текстовое сообщение.

Тип

string

`$to` protected

Получатель письма.

Тип

array

`$transferEncoding` protected

Используемая кодировка символов передачи письма. Если null, для определения кодировки передачи используется свойство $charset.

Тип

string|null

`$transferEncodingAvailable` protected

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

Тип

array<string>

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.4/class-Cake.Mailer.Message.html

Класс Message

Константы

Краткое описание свойств

Краткое описание методов

__construct()public

__serialize()public

__unserialize()public

addAttachments()public

addBcc()public

addCc()public

addEmail()protected

addHeaders()public

addReplyTo()public

addTo()public

attachFiles()protected

attachInlineFiles()protected

createBoundary()protected

createFromArray()public

decodeForHeader()protected

encodeForHeader()protected

encodeString()protected

formatAddress()protected

generateMessage()protected

getAttachments()public

getBcc()public

getBody()public

getBodyHtml()public

getBodyString()public

getBodyText()public

getBodyTypes()public

getCc()public

getCharset()public

getContentTransferEncoding()public

getContentTypeCharset()public

getDomain()public

getEmailFormat()public

getEmailPattern()public

getFrom()public

getHeaderCharset()public

getHeaders()public

getHeadersString()public

getMessageId()public

getOriginalSubject()public

getPriority()public

getReadReceipt()public

getReplyTo()public

getReturnPath()public

getSender()public

getSubject()public

getTo()public

getTransferEncoding()public

jsonSerialize()public

readFile()protected

reset()public

serialize()public

setAttachments()public

setBcc()public

setBody() public

setBodyHtml() public

setBodyText() public

setCc() public

setCharset() public

setConfig() public

setDomain() public

setEmail() protected

setEmailFormat() public

setEmailPattern() public

setEmailSingle() protected

setFrom() public

setHeaderCharset() public

setHeaders() public

setMessageId() public

setPriority() public

setReadReceipt() public

setReplyTo() public

setReturnPath() public

setSender() public

setSubject() public

setTo() public

setTransferEncoding() public