Spec-Zone.ru › CakePHP 4.2

Класс Message

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

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

Namespace: 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

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

  • $bcc protected
    array

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

  • $boundary protected
    string|null

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

  • $cc protected
    array

    Копия

  • $charset protected
    string

    Кодировка, в которой отправляется тело электронного письма

  • $charset8bit protected
    array

    8-битные кодировки

  • $contentTypeCharset protected
    array

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

  • $domain protected
    string

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

  • $emailFormat protected
    string

    В каком формате должно быть отправлено электронное письмо

  • $emailFormatAvailable protected
    array

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

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

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

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

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

END_OF_DOCUMENT_MARKER

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

  • __construct() public

    Конструктор

  • 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

    Возвращает значение кодировки передачи контента на основе установленной transferEncoding или установленной кодировки.

  • getContentTypeCharset() public

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

  • getDomain() public

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

  • getEmailFormat() public

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

  • getEmailPattern() public

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

  • getFrom() public

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

  • getHeaderCharset() public

    Получение HeaderCharset.

  • getHeaders() public

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

  • getHeadersString() public

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

  • getMessageId() public

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

  • getOriginalSubject() public

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

  • getPriority() public

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

  • getReadReceipt() public

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

  • getReplyTo() public

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

  • getReturnPath() public

    Получает путь возврата.

  • getSender() public

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

  • getSubject() public

    Получает тему.

  • getTo() public

    Получает адрес "to"

  • getTransferEncoding() public

    Получение TransferEncoding.

  • jsonSerialize() public

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

  • readFile() protected

    Прочитать содержимое файла и вернуть base64 версию содержимого файла.

  • 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

    Установить email

  • setEmailFormat() public

    Устанавливает формат email.

  • setEmailPattern() public

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

  • setEmailSingle() protected

    Установить только 1 email

  • setFrom() public

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

  • setHeaderCharset() public

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

  • setHeaders() public

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

  • setMessageId() public

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

  • setPriority() public

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

  • setReadReceipt() public

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

  • setReplyTo() public

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

  • setReturnPath() public

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

  • setSender() public

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

  • setSubject() public

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

  • setTo() public

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

  • setTransferEncoding() public

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

  • unserialize() public

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

  • validateEmail() protected

    Проверить адрес email

  • wrap() protected

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

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

__construct() public

__construct(array|null $config = null)

Конструктор

Параметры

array|null $config optional

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

addAttachments() public

addAttachments(array $attachments): $this

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

Параметры

array $attachments

Массив имен файлов.

Возвращает

$this

Исключения

InvalidArgumentException

См. также

\Cake\Mailer\Email::setAttachments()

addBcc() public

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

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

Параметры

string|array $email

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

string|null $name optional

Имя

Возвращает

$this

addCc() public

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

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

Параметры

string|array $email

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

string|null $name optional

Имя

Возвращает

$this

addEmail() protected

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

Добавить email

Параметры

string $varName

Имя свойства

string|array $email

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

string|null $name

Имя

Возвращает

$this

Исключения

InvalidArgumentException

addHeaders() public

addHeaders(array $headers): $this

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

Параметры

array $headers

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

Возвращает

$this

addReplyTo() public

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

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

Параметры

string|array $email

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

string|null $name optional

Имя

Возвращает

$this

addTo() public

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

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

Параметры

string|array $email

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

string|null $name optional

Имя

Возвращает

$this

attachFiles() protected

attachFiles(string|null $boundary = null): string[]

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

Параметры

string|null $boundary optional

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

Возвращает

string[]

attachInlineFiles() protected

attachInlineFiles(string|null $boundary = null): string[]

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

Параметры

string|null $boundary optional

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

Возвращает

string[]

createBoundary() protected

createBoundary(): void

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

Возвращает

void

createFromArray() public

createFromArray(array $config): $this

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

Параметры

array $config

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

Возвращает

$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(): string[]

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

Возвращает

string[]

getAttachments() public

getAttachments(): array

Получает вложения к сообщению email.

Возвращает

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 optional

Строка конца строки для объединения.

Возвращает

string

См. также

Message::getBody()

getBodyText() public

getBodyText(): string

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

Возвращает

string

getBodyTypes() public

getBodyTypes(): array

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

Returns

array

getCc() public

getCc(): array

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

Returns

array

getCharset() public

getCharset(): string

Геттер кодировки символов.

Returns

string

getContentTransferEncoding() public

getContentTransferEncoding(): string

Возвращает значение кодировки передачи контента на основе установленной transferEncoding или установленной кодировки символов.

Returns

string

getContentTypeCharset() public

getContentTypeCharset(): string

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

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

Returns

string

getDomain() public

getDomain(): string

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

Returns

string

getEmailFormat() public

getEmailFormat(): string

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

Returns

string

getEmailPattern() public

getEmailPattern(): string|null

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

Returns

string|null

getFrom() public

getFrom(): array

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

Returns

array

getHeaderCharset() public

getHeaderCharset(): string

Геттер HeaderCharset.

Returns

string

getHeaders() public

getHeaders(string[] $include = []): string[]

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

Includes:

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

Parameters

string[] $include optional

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

Returns

string[]

getHeadersString() public

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

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

Parameters

string[] $include optional

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

string $eol optional

Строка конца строки для конкатенации заголовков.

Closure $callback optional

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

Returns

string

See Also

Message::getHeaders()

getMessageId() public

getMessageId(): bool|string

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

Returns

bool|string

getOriginalSubject() public

getOriginalSubject(): string

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

Returns

string

getPriority() public

getPriority(): int|null

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

Returns

int|null

getReadReceipt() public

getReadReceipt(): array

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

Returns

array

getReplyTo() public

getReplyTo(): array

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

Returns

array

getReturnPath() public

getReturnPath(): array

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

Returns

array

getSender() public

getSender(): array

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

Returns

array

Links

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

getSubject() public

getSubject(): string

Получает тему.

Returns

string

getTo() public

getTo(): array

Получает адрес "to"

Returns

array

getTransferEncoding() public

getTransferEncoding(): string|null

Геттер TransferEncoding.

Returns

string|null

jsonSerialize() public

jsonSerialize(): array

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

Returns

array

Throws

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

readFile() protected

readFile(stringPsr\Http\Message\UploadedFileInterface $file): string

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

Parameters

stringPsr\Http\Message\UploadedFileInterface $file

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

Returns

string

reset() public

reset(): $this

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

Returns

$this

serialize() public

serialize(): string

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

Returns

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(string|array $email, string|null $name = null): $this

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

Parameters

string|array $email

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

string|null $name optional

Имя

Returns

$this

setBody() public

setBody(array $content): $this

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

Parameters

array $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(string|array $email, string|null $name = null): $this

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

Parameters

string|array $email

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

string|null $name optional

Имя

Returns

$this

setCharset() public

setCharset(string $charset): $this

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

Parameters

string $charset

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

Returns

$this

setConfig() public

setConfig(array $config): $this

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

Parameters

array $config

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

Returns

$this

setDomain() public

setDomain(string $domain): $this

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

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

Parameters

string $domain

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

Returns

$this

setEmail() protected

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

Установить email

Parameters

string $varName

Имя свойства

string|array $email

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

string|null $name

Имя

Returns

$this

Throws

InvalidArgumentException

setEmailFormat() public

setEmailFormat(string $format): $this

Устанавливает формат email.

Parameters

string $format

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

Returns

$this

Throws

InvalidArgumentException

setEmailPattern() public

setEmailPattern(string|null $regex): $this

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

Parameters

string|null $regex

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

Returns

$this

setEmailSingle() protected

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

Установить только 1 email

Parameters

string $varName

Имя свойства

string|array $email

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

string|null $name

Имя

string $throwMessage

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

Returns

$this

Throws

InvalidArgumentException

setFrom() public

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

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

Parameters

string|array $email

Строка с email, массив с email как ключом, именем как значением или 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(bool|string $message): $this

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

Parameters

bool|string $message

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

Returns

$this

Throws

InvalidArgumentException

setPriority() public

setPriority(int|null $priority): $this

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

Parameters

int|null $priority

От 1 (самый высокий) до 5 (самый низкий)

Returns

$this

setReadReceipt() public

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

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

Parameters

string|array $email

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

string|null $name optional

Имя

Returns

$this

Throws

InvalidArgumentException

setReplyTo() public

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

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

Parameters

string|array $email

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

string|null $name optional

Имя

Returns

$this

Throws

InvalidArgumentException

setReturnPath() public

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

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

Parameters

string|array $email

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

string|null $name optional

Имя

Returns

$this

Throws

InvalidArgumentException

setSender() public

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

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

Parameters

string|array $email

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

string|null $name optional

Имя

Returns

$this

Throws

InvalidArgumentException

Links

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

setSubject() public

setSubject(string $subject): $this

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

Parameters

string $subject

Строка темы.

Returns

$this

setTo() public

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

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

Parameters

string|array $email

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

string|null $name optional

Имя

Returns

$this

setTransferEncoding() public

setTransferEncoding(string|null $encoding): $this

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

Parameters

string|null $encoding

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

Returns

$this

Throws

InvalidArgumentException

unserialize() public

unserialize(string $data): void

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

Parameters

string $data

Сериализованная строка.

Returns

void

validateEmail() protected

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

Проверка адреса email

Parameters

string $email

Адрес email для проверки

string $context

Какое свойство было установлено

Returns

void

Throws

InvalidArgumentException
Если адрес email не проходит проверку

wrap() protected

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

Разбивает сообщение на строки в соответствии с RFC 2822 - 2.1.1

Parameters

string|null $message optional

Сообщение для разбиения

int $wrapLength optional

Длина строки

Returns

array

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

$appCharset protected

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

Тип

string|null

$attachments protected

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

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

Тип

array

$bcc protected

Скрытая копия (BCC)

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

Тип

array

$boundary protected

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

Тип

string|null

$cc protected

Копия (CC)

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

Тип

array

$charset protected

Кодировка, в которой отправляется тело письма

Тип

string

$charset8bit protected

8-битные кодировки

Тип

array

$contentTypeCharset protected

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

Тип

array

$domain protected

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

Тип

string

$emailFormat protected

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

Тип

string

$emailFormatAvailable protected

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

Тип

array

$emailPattern protected

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

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

Тип

string|null

$from protected

Адрес, с которого отправляется электронное письмо

Тип

array

$headerCharset protected

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

Тип

string|null

$headers protected

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

Тип

array

$htmlMessage protected

HTML-сообщение

Тип

string

$message protected

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

Тип

array

$messageId protected

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

Тип

bool|string

$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

© 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.2/class-Cake.Mailer.Message.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API