Spec-Zone.ru › CakePHP 4.3

Класс
Email

Класс CakePHP Email.

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

Настройка

Настройка Email осуществляется с помощью Email::config() и Email::configTransport(). Email::config() можно использовать для добавления или чтения профиля конфигурации для экземпляров Email. После создания профили конфигурации могут быть использованы для повторного использования в различных электронных письмах, отправляемых вашим приложением.

Пространство имён: Cake\Mailer
Устарело: 4.0.0 Этот класс будет удален в CakePHP 5.0, используйте {@link \Cake\Mailer\Mailer} вместо него.

Константы

  • string
    EMAIL_PATTERN 
    '/^((?:[\\p{L}0-9.!#$%&\'*+\\/=?^_`{|}~-]+)*@[\\p{L}0-9-._]+)$/ui'

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

  • string
    MESSAGE_BOTH 
    'both'

    Тип сообщения - BOTH

  • string
    MESSAGE_HTML 
    'html'

    Тип сообщения - HTML

  • string
    MESSAGE_TEXT 
    'text'

    Тип сообщения - TEXT

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

  • $_profile protected
    array

    Копия профиля конфигурации для этого экземпляра. Эту копию можно изменить с помощью Email::profile().

  • $_transport protected
    Cake\Mailer\AbstractTransport|null

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

  • $message protected
    Cake\Mailer\Message

    Экземпляр сообщения.

  • $messageClass protected
    string

    Имя класса сообщения.

  • $renderer protected
    Cake\Mailer\Renderer|null

    Рендерер Email

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

  • __call() public

    Магический метод для переадресации метода класса экземпляру Email.

  • __callStatic() public static

    Проксирует все статические вызовы методов (для методов, предоставляемых StaticConfigTrait) в Mailer.

  • __clone() public

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

  • __construct() public

    Конструктор

  • __serialize() public

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

  • __unserialize() public

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

  • _logDelivery() protected

    Регистрирует доставку электронного письма.

  • createFromArray() public

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

  • deliver() public static

    Статический метод для быстрого создания экземпляра \Cake\Mailer\Email

  • flatten() protected

    Преобразует заданное значение в строку

  • getMessage() public

    Получить экземпляр сообщения.

  • getProfile() public

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

  • getRenderer() public

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

  • getTransport() public

    Получить транспорт.

  • getViewRenderer() public

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

  • getViewVars() public

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

  • jsonSerialize() public

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

  • message() public

    Получить сгенерированное сообщение (используется классами транспорта).

  • render() public

    Рендерить email.

  • reset() public

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

  • send() public

    Отправить электронное письмо с указанным содержимым, шаблоном и макетом

  • serialize() public

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

  • setProfile() public

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

  • setRenderer() public

    Установить рендерер email.

  • setTransport() public

    Установить транспорт.

  • setViewRenderer() public

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

  • setViewVars() public

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

  • unserialize() public

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

  • viewBuilder() public

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

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

__call() public 

__call(string $method, array $args): $this|mixed

Магический метод для перенаправления метода класса к экземпляру Email.

Параметры

string $method

Имя метода.

array $args

Аргументы метода

Возвращает

$this|mixed

__callStatic() public static 

__callStatic(string $name, array $arguments): mixed

Обрабатывает все статические вызовы методов (для методов, предоставленных StaticConfigTrait) в Mailer.

Параметры

string $name

Имя метода.

array $arguments

Аргумент метода.

Возвращает

mixed

__clone() public 

__clone(): void

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

Возвращает

void

__construct() public 

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

Конструктор

Параметры

array<string, mixed>|string|null $config optional

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

__serialize() public 

__serialize(): array

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

Возвращает

array

__unserialize() public 

__unserialize(array $data): void

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

Параметры

array $data

Массив данных.

Возвращает

void

_logDelivery() protected 

_logDelivery(array $contents): void

Записывает информацию о доставке письма.

Параметры

array $contents

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

Возвращает

void

createFromArray() public 

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

Настраивает экземпляр объекта email из сериализованных настроек.

Параметры

array<string, mixed> $config

Массив настроек email.

Возвращает

$this

deliver() public static 

deliver(array|string|null $to = null, string|null $subject = null, array|string|null $message = null, array<string, mixed>|string $config = 'default', bool $send = true): Cake\Mailer\Email

Статический метод для быстрого создания экземпляра \Cake\Mailer\Email

Параметры

array|string|null $to optional

Адрес получателя ({@see \Cake\Mailer\Email::setTo()}). Если null, будет использоваться 'to' из настроек транспорта

string|null $subject optional

Строка темы или null для использования 'subject' из настроек транспорта

array|string|null $message optional

Строка с сообщением или массив с переменными, используемыми в шаблоне

array<string, mixed>|string $config optional

Строка для использования профиля доставки Email из app.php или массив настроек

bool $send optional

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

Возвращает

Cake\Mailer\Email

Исключения

InvalidArgumentException

flatten() protected 

flatten(array<string>|string $value): string

Преобразует заданное значение в строку

Параметры

array<string>|string $value

Значение для преобразования

Возвращает

string

getMessage() public 

getMessage(): Cake\Mailer\Message

Получить экземпляр сообщения.

Возвращает

Cake\Mailer\Message

getProfile() public 

getProfile(): array

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

Возвращает

array

getRenderer() public 

getRenderer(): Cake\Mailer\Renderer

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

Возвращает

Cake\Mailer\Renderer

getTransport() public 

getTransport(): Cake\Mailer\AbstractTransport|null

Получить транспорт.

Возвращает

Cake\Mailer\AbstractTransport|null

getViewRenderer() public 

getViewRenderer(): string

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

Возвращает

string

getViewVars() public 

getViewVars(): array

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

Возвращает

array

jsonSerialize() public 

jsonSerialize(): array

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

Возвращает

array

Исключения

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

message() public 

message(string|null $type = null): array|string

Получить сгенерированное сообщение (используется классами транспорта).

Параметры

string|null $type optional

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

Возвращает

array|string

render() public 

render(array<string>|string|null $content = null): void

Рендерит письмо.

Параметры

array<string>|string|null $content optional

Массив или строка содержимого

Возвращает

void

reset() public 

reset(): $this

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

Возвращает

$this

send() public 

send(array<string>|string|null $content = null): array

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

Параметры

array<string>|string|null $content optional

Строка с сообщением или массив с сообщениями

Возвращает

array

Исключения

BadMethodCallException

serialize() public 

serialize(): string

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

Возвращает

string

setProfile() public 

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

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

Параметры

array<string, mixed>|string $config

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

Возвращает

$this

setRenderer() public 

setRenderer(Cake\Mailer\Renderer $renderer): $this

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

Параметры

Cake\Mailer\Renderer $renderer

Экземпляр рендерера.

Возвращает

$this

setTransport() public 

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

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

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

Параметры

Cake\Mailer\AbstractTransport|string $name

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

Возвращает

$this

Выбрасывает

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

setViewRenderer() public 

setViewRenderer(string $viewClass): $this

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

Параметры

string $viewClass

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

Возвращает

$this

setViewVars() public 

setViewVars(array $viewVars): $this

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

Параметры

array $viewVars

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

Возвращает

$this

unserialize() public 

unserialize(string $data): void

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

Параметры

string $data

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

Возвращает

void

viewBuilder() public 

viewBuilder(): Cake\View\ViewBuilder

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

Возвращает

Cake\View\ViewBuilder

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

$_profile protected

Копия профиля конфигурации для данного экземпляра. Эту копию можно изменить с помощью Email::profile().

Тип

array

$_transport protected

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

Тип

Cake\Mailer\AbstractTransport|null

$message protected

Экземпляр сообщения.

Тип

Cake\Mailer\Message

$messageClass protected

Имя класса сообщения.

Тип

string

$renderer protected

Рендерер Email.

Тип

Cake\Mailer\Renderer|null

© 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.3/class-Cake.Mailer.Email.html

Spec-Zone.ru

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