Spec-Zone.ru › CakePHP 4.2

Class
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

    Конструктор

  • _logDelivery() protected

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

  • createFromArray() public

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

  • deliver() public static

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

  • flatten() protected

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

  • getMessage() public

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

  • getProfile() public

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

  • getRenderer() public

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

  • 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

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

  • setTransport() public

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

  • setViewRenderer() public

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

  • setViewVars() public

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

  • unserialize() public

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

  • viewBuilder() public

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

END_OF_DOCUMENT_MARKER

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

__call() public 

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

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

Parameters

string $method

Имя метода.

array $args

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

Returns

$this|mixed

__callStatic() public static 

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

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

Parameters

string $name

Имя метода.

array $arguments

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

Returns

mixed

__clone() public 

__clone(): void

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

Returns

void

__construct() public 

__construct(array|string|null $config = null)

Конструктор

Parameters

array|string|null $config optional

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

_logDelivery() protected 

_logDelivery(array $contents): void

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

Parameters

array $contents

Контент с ключами 'headers' и 'message'.

Returns

void

createFromArray() public 

createFromArray(array $config): $this

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

Parameters

array $config

Массив конфигурации электронной почты.

Returns

$this

deliver() public static 

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

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

Parameters

string|array|null $to optional

Адрес для отправки (см. Cake\Mailer\Email::to()). Если null, попытается использовать 'to' из конфигурации транспорта

string|null $subject optional

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

string|array|null $message optional

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

string|array $config optional

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

bool $send optional

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

Returns

Cake\Mailer\Email

Throws

InvalidArgumentException

flatten() protected 

flatten(string|array $value): string

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

Parameters

string|array $value

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

Returns

string

getMessage() public 

getMessage(): Cake\Mailer\Message

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

Returns

Cake\Mailer\Message

getProfile() public 

getProfile(): array

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

Returns

array

getRenderer() public 

getRenderer(): Cake\Mailer\Renderer

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

Returns

Cake\Mailer\Renderer

getTransport() public 

getTransport(): Cake\Mailer\AbstractTransport|null

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

Returns

Cake\Mailer\AbstractTransport|null

getViewRenderer() public 

getViewRenderer(): string

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

Returns

string

getViewVars() public 

getViewVars(): array

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

Returns

array

jsonSerialize() public 

jsonSerialize(): array

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

Returns

array

Throws

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

message() public 

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

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

Parameters

string|null $type optional

Использовать константы MESSAGE_* или null, чтобы вернуть полное сообщение как массив

Returns

string|array

render() public 

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

Рендеринг email.

Parameters

string|array|null $content optional

Массив контента или строка

Returns

void

reset() public 

reset(): $this

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

Returns

$this

send() public 

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

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

Parameters

string|array|null $content optional

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

Returns

array

Throws

BadMethodCallException

serialize() public 

serialize(): string

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

Returns

string

setProfile() public 

setProfile(string|array $config): $this

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

Parameters

string|array $config

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

Returns

$this

setRenderer() public 

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

Установить средство визуализации email.

Parameters

Cake\Mailer\Renderer $renderer

Экземпляр render.

Returns

$this

setTransport() public 

setTransport(stringCake\Mailer\AbstractTransport $name): $this

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

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

Parameters

stringCake\Mailer\AbstractTransport $name

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

Returns

$this

Throws

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

Spec-Zone.ru

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