Класс Mailer

Базовый класс Mailer.

Классы Mailer позволяют инкапсулировать связанную логику электронной почты в повторно используемый и тестируемый класс.

Определение сообщений

Mailer облегчают определение методов, обрабатывающих логику форматирования электронных писем. Например:

class UserMailer extends Mailer
{
    public function resetPassword($user)
    {
        $this
            ->setSubject('Reset Password')
            ->setTo($user->email)
            ->set(['token' => $user->token]);
    }
}

Это тривиальный пример, но он демонстрирует, как можно объявить mailer.

Отправка сообщений

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

$mailer = new UserMailer();
$mailer->send('resetPassword', $user);

Обработчик событий

Mailer также могут подписываться на события приложения, позволяя вам отделить доставку электронной почты от вашего кода приложения. Переопределяя метод implementedEvents() , вы можете определить обработчики событий, которые могут преобразовывать события в электронные письма. Например, если у вашего приложения есть событие регистрации пользователя:

public function implementedEvents(): array
{
    return [
        'Model.afterSave' => 'onRegistration',
    ];
}

public function onRegistration(EventInterface $event, EntityInterface $entity, ArrayObject $options)
{
    if ($entity->isNew()) {
         $this->send('welcome', [$entity]);
    }
}

Метод onRegistration преобразует событие приложения в метод mailer. Наш mailer может быть зарегистрирован в загрузчике приложения или в хуке initialize() класса Table.

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

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

$_config protected static

array<string, mixed>

Наборы конфигурации.
$_dsnClassMap protected static

array<string, string>

Карта классов драйвера Mailer.
$_modelFactories protected

array<callableCake\Datasource\Locator\LocatorInterface>

Список переопределенных функций фабрики моделей.
$_modelType protected

string

Тип модели для использования.
$_tableLocator protected

Cake\ORM\Locator\LocatorInterface|null

Экземпляр локатора таблиц.
$clonedInstances protected

array<string, mixed>

Хранение экземпляров сообщения, рендерера и транспорта для восстановления после выполнения действия mailer.
$defaultTable protected

string|null

Псевдоним таблицы по умолчанию для этого объекта.
$logConfig protected

array|null
$message protected

Cake\Mailer\Message

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

string

Имя класса сообщения.
$modelClass protected deprecated

string|null

Имя основного класса модели этого объекта. Должно быть во множественном числе. CakePHP не будет склонять имя.
$name public static

string

Имя Mailer.
$renderer protected

Cake\Mailer\Renderer|null

Рендер электронных писем
$transport protected

Cake\Mailer\AbstractTransport|null

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

END_OF_DOCUMENT_MARKER

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

__call() public

Магический метод для перенаправления метода класса в экземпляр Message.
__construct() public

Конструктор
_setModelClass() protected

Устанавливает свойство modelClass на основе соглашений.
addAttachments() public @method

Добавить вложения. {@see \Cake\Mailer\Message::addAttachments()}
addBcc() public @method

Добавить адрес "bcc". {@see \Cake\Mailer\Message::addBcc()}
addCc() public @method

Добавить адрес "cc". {@see \Cake\Mailer\Message::addCc()}
addHeaders() public @method

Добавить заголовок для сообщения. {@see \Cake\Mailer\Message::addHeaders()}
addReplyTo() public @method

Добавить адрес "Reply-To". {@see \Cake\Mailer\Message::addReplyTo()}
addTo() public @method

Добавить адрес "To". {@see \Cake\Mailer\Message::addTo()}
configured() public static

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

Отобразить содержимое и отправить электронное письмо с помощью настроенного транспорта.
drop() public static

Удаляет построенный адаптер.
fetchTable() public

Удобный метод для получения экземпляра таблицы.
flatten() protected

Преобразует заданное значение в строку
getAttachments() public @method

Получить вложения к электронному письму. {@see \Cake\Mailer\Message::getAttachments()}
getBcc() public @method

Получить адрес "bcc". {@see \Cake\Mailer\Message::getBcc()}
getBody() public @method

Получить сгенерированное тело сообщения в виде массива. {@see \Cake\Mailer\Message::getBody()}
getCc() public @method

Получить адрес "cc". {@see \Cake\Mailer\Message::getCc()}
getCharset() public @method

Получить кодировку символов. {@see \Cake\Mailer\Message::getCharset()}
getConfig() public static

Считывает существующую конфигурацию.
getConfigOrFail() public static

Считывает существующую конфигурацию для определенного ключа.
getDomain() public @method

Получить домен. {@see \Cake\Mailer\Message::getDomain()}
getDsnClassMap() public static

Возвращает карту классов DSN для этого класса.
getEmailFormat() public @method

Получить формат электронного письма. {@see \Cake\Mailer\Message::getEmailFormat()}
getFrom() public @method

Получить адрес "from". {@see \Cake\Mailer\Message::getFrom()}
getHeaderCharset() public @method

Получить кодировку символов заголовка. {@see \Cake\Mailer\Message::getHeaderCharset()}
getHeaders() public @method

Получить список заголовков. {@see \Cake\Mailer\Message::getHeaders()}
getMessage() public

Получить экземпляр сообщения.
getMessageId() public @method

Получить идентификатор сообщения. {@see \Cake\Mailer\Message::getMessageId()}
getModelType() public

Получить тип модели, который будет использоваться этим классом
getReadReceipt() public @method

Получить подтверждение о прочтении (заголовок Disposition-Notification-To). {@see \Cake\Mailer\Message::getReadReceipt()}
getRenderer() public

Получить рендерер электронных писем.
getReplyTo() public @method

Получить адрес "Reply-To". {@see \Cake\Mailer\Message::getReplyTo()}
getReturnPath() public @method

Получить обратный путь. {@see \Cake\Mailer\Message::getReturnPath()}
getSender() public @method

Получить адрес "sender". {@see \Cake\Mailer\Message::getSender()}
getSubject() public @method

Получить тему. {@see \Cake\Mailer\Message::getSubject()}
getTableLocator() public

Получить локатор таблиц.
getTo() public @method

Получить адрес "to". {@see \Cake\Mailer\Message::getTo()}
getTransport() public

Получить транспорт.
implementedEvents() public

Реализованные события.
loadModel() public deprecated

Загружает и строит объекты хранилища, необходимые этому объекту
logDelivery() protected

Записать доставку электронного письма.
modelFactory() public

Переопределить существующий вызываемый элемент для генерации хранилищ заданного типа.
parseDsn() public static

Разбирает DSN в корректную конфигурацию подключения

END_OF_DOCUMENT_MARKER

render() public

Отобразить содержимое и установить тело сообщения.
reset() public

Сбросить все внутренние переменные, чтобы можно было отправить новое письмо.
restore() protected

Восстановить сообщение, рендерер, экземпляры транспорта в состояние до выполнения действия.
send() public

Отправить письмо.
set() public deprecated

Устанавливает переменные представления для письма.
setAttachments() public @method

Добавить вложение к электронному письму. {@see \Cake\Mailer\Message::setAttachments()}
setBcc() public @method

Устанавливает адрес "bcc". {@see \Cake\Mailer\Message::setBcc()}
setCc() public @method

Устанавливает адрес "cc". {@see \Cake\Mailer\Message::setCc()}
setCharset() public @method

Установка кодировки символов. {@see \Cake\Mailer\Message::setCharset()}
setConfig() public static

Этот метод можно использовать для определения адаптеров конфигурации для приложения.
setDomain() public @method

Устанавливает домен. {@see \Cake\Mailer\Message::setDomain()}
setDsnClassMap() public static

Обновляет карту классов DSN для этого класса.
setEmailFormat() public @method

Устанавливает формат письма. {@see \Cake\Mailer\Message::getHeaders()}
setFrom() public @method

Устанавливает адрес "от". {@see \Cake\Mailer\Message::setFrom()}
setHeaderCharset() public @method

Установка кодировки символов заголовка. {@see \Cake\Mailer\Message::setHeaderCharset()}
setHeaders() public @method

Устанавливает заголовки сообщения. {@see \Cake\Mailer\Message::setHeaders()}
setLogConfig() protected

Установить конфигурацию логирования.
setMessage() public

Установить экземпляр сообщения.
setMessageId() public @method

Устанавливает идентификатор сообщения. {@see \Cake\Mailer\Message::setMessageId()}
setModelType() public

Установить тип модели, используемый этим классом
setProfile() public

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

Устанавливает подтверждение о прочтении (заголовок Disposition-Notification-To). {@see \Cake\Mailer\Message::setReadReceipt()}
setRenderer() public

Установить рендерер электронных писем.
setReplyTo() public @method

Устанавливает адрес "Ответить кому". {@see \Cake\Mailer\Message::setReplyTo()}
setReturnPath() public @method

Устанавливает возвращаемый путь. {@see \Cake\Mailer\Message::setReturnPath()}
setSender() public @method

Устанавливает адрес "отправитель". {@see \Cake\Mailer\Message::setSender()}
setSubject() public @method

Устанавливает тему. {@see \Cake\Mailer\Message::setSubject()}
setTableLocator() public

Устанавливает локатор таблиц.
setTo() public @method

Устанавливает адрес "кому". {@see \Cake\Mailer\Message::setTo()}
setTransport() public

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

Устанавливает переменные представления для письма.
viewBuilder() public

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

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

__call() public

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

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

Параметры

string $method: Имя метода.
array $args: Аргументы метода

Возвращает

$this|mixed

__construct() public

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

Конструктор

Параметры

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

_setModelClass() protected

_setModelClass(string $name): void

Устанавливает свойство modelClass на основе соглашений.

Если свойство уже установлено, оно не будет перезаписано

Параметры

string $name: Имя класса.

Возвращает

void

addAttachments() public @method

addAttachments(mixed $attachments): $this

Добавляет вложения. {@see \Cake\Mailer\Message::addAttachments()}

Параметры

$attachments

Возвращает

$this

addBcc() public @method

addBcc(mixed $email, mixed $name = null): $this

Добавляет адрес "bcc". {@see \Cake\Mailer\Message::addBcc()}

Параметры

$email
$name optional

Возвращает

$this

addCc() public @method

addCc(mixed $email, mixed $name = null): $this

Добавляет адрес "cc". {@see \Cake\Mailer\Message::addCc()}

Параметры

$email
$name optional

Возвращает

$this

addHeaders() public @method

addHeaders(array $headers): $this

Добавляет заголовок к сообщению. {@see \Cake\Mailer\Message::addHeaders()}

Параметры

array $headers

Возвращает

$this

addReplyTo() public @method

addReplyTo(mixed $email, mixed $name = null): $this

Добавляет адрес "Reply-To". {@see \Cake\Mailer\Message::addReplyTo()}

Параметры

$email
$name optional

Возвращает

$this

addTo() public @method

addTo(mixed $email, mixed $name = null): $this

Добавляет адрес "To". {@see \Cake\Mailer\Message::addTo()}

Параметры

$email
$name optional

Возвращает

$this

configured() public static

configured(): array<string>

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

Возвращает

array<string>

deliver() public

deliver(string $content = ''): array

Отображает содержимое и отправляет электронное письмо с помощью настроенного транспорта.

Параметры

string $content optional: Содержимое.

Возвращает

array

drop() public static

drop(string $config): bool

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

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

Если реализующие объекты поддерживают $_registry объект, именованная конфигурация также будет загружена из реестра.

Параметры

string $config: Существующая конфигурация, которую вы хотите удалить.

Возвращает

bool

fetchTable() public

fetchTable(string|null $alias = null, array<string, mixed> $options = []): Cake\ORM\Table

Удобный метод для получения экземпляра таблицы.

Параметры

string|null $alias optional: Имя псевдонима, которое вы хотите получить. Должно быть в формате CamelCase. Если null , то используется значение свойства $defaultTable.
array<string, mixed> $options optional: Опции, с которыми вы хотите создать таблицу. Если таблица уже загружена, опции реестра будут проигнорированы.

Возвращает

Cake\ORM\Table

Выбрасывает

Cake\Core\Exception\CakeException
Если аргумент `$alias` и свойство `$defaultTable` оба равны `null`.

См. также

\Cake\ORM\TableLocator::get()

flatten() protected

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

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

Параметры

array<string>|string $value: Значение для преобразования

Возвращает

string

getAttachments() public @method

getAttachments(): array

Получает вложения к электронному письму. {@see \Cake\Mailer\Message::getAttachments()}

Возвращает

array

getBcc() public @method

getBcc(): array

Получает адрес "bcc". {@see \Cake\Mailer\Message::getBcc()}

Возвращает

array

getBody() public @method

getBody(?string $type = null): array|string

Получает сгенерированный тело сообщения в виде массива. {@see \Cake\Mailer\Message::getBody()}

Параметры

?string $type optional

Возвращает

array|string

getCc() public @method

getCc(): array

Получает адрес "cc". {@see \Cake\Mailer\Message::getCc()}

Возвращает

array

getCharset() public @method

getCharset(): string

Получение кодировки. {@see \Cake\Mailer\Message::getCharset()}

Возвращает

string

getConfig() public static

getConfig(string $key): mixed|null

Читает существующую конфигурацию.

Параметры

string $key: Имя конфигурации.

Возвращает

mixed|null

getConfigOrFail() public static

getConfigOrFail(string $key): mixed

Читает существующую конфигурацию для определенного ключа.

Значение конфигурации для данного ключа должно существовать, оно никогда не может быть null.

Параметры

string $key: Имя конфигурации.

Возвращает

mixed

Выбрасывает

InvalidArgumentException
Если значение не существует.

getDomain() public @method

getDomain(): string

Получает домен. {@see \Cake\Mailer\Message::getDomain()}

Возвращает

string

getDsnClassMap() public static

getDsnClassMap(): array<string, string>

Возвращает карту классов DSN для этого класса.

Возвращает

array<string, string>

getEmailFormat() public @method

getEmailFormat(): string

Получает формат электронной почты. {@see \Cake\Mailer\Message::getEmailFormat()}

Возвращает

string

getFrom() public @method

getFrom(): array

Получает адрес "от". {@see \Cake\Mailer\Message::getFrom()}

Возвращает

array

getHeaderCharset() public @method

getHeaderCharset(): string

Получение кодировки символов заголовка. {@see \Cake\Mailer\Message::getHeaderCharset()}

Возвращает

string

getHeaders() public @method

getHeaders(array $include = []): $this

Получение списка заголовков. {@see \Cake\Mailer\Message::getHeaders()}

Параметры

array $include optional

Возвращает

$this

getMessage() public

getMessage(): Cake\Mailer\Message

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

Возвращает

Cake\Mailer\Message

getMessageId() public @method

getMessageId(): string|bool

Получение идентификатора сообщения. {@see \Cake\Mailer\Message::getMessageId()}

Возвращает

string|bool

getModelType() public

getModelType(): string

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

Возвращает

string

getReadReceipt() public @method

getReadReceipt(): array

Получение подтверждения о прочтении (Disposition-Notification-To заголовок). {@see \Cake\Mailer\Message::getReadReceipt()}

Возвращает

array

getRenderer() public

getRenderer(): Cake\Mailer\Renderer

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

Возвращает

Cake\Mailer\Renderer

getReplyTo() public @method

getReplyTo(): array

Получение адреса "Ответ". {@see \Cake\Mailer\Message::getReplyTo()}

Возвращает

array

getReturnPath() public @method

getReturnPath(): array

Получение обратного пути. {@see \Cake\Mailer\Message::getReturnPath()}

Возвращает

array

getSender() public @method

getSender(): array

Получение адреса "отправитель". {@see \Cake\Mailer\Message::getSender()}

Возвращает

array

getSubject() public @method

getSubject(): string

Получение темы. {@see \Cake\Mailer\Message::getSubject()}

Возвращает

string

getTableLocator() public

getTableLocator(): Cake\ORM\Locator\LocatorInterface

Получение локатора таблиц.

Возвращает

Cake\ORM\Locator\LocatorInterface

getTo() public @method

getTo(): array

Получение адреса "кому". {@see \Cake\Mailer\Message::getTo()}

Возвращает

array

getTransport() public

getTransport(): Cake\Mailer\AbstractTransport

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

Возвращает

Cake\Mailer\AbstractTransport

implementedEvents() public

implementedEvents(): array<string, mixed>

Реализованные события.

Пример:

public function implementedEvents()
 {
     return [
         'Order.complete' => 'sendEmail',
         'Article.afterBuy' => 'decrementInventory',
         'User.onRegister' => ['callable' => 'logRegistration', 'priority' => 20, 'passParams' => true]
     ];
 }

Возвращает

array<string, mixed>

loadModel() public

loadModel(string|null $modelClass = null, string|null $modelType = null): Cake\Datasource\RepositoryInterface

Загружает и создает объекты хранилища, необходимые для этого объекта

Обычно используется для загрузки объектов ORM Table, если это необходимо. Также может использоваться для загрузки других типов объектов хранилища, используемых вашим приложением.

Если поставщик хранилища не возвращает объект, будет брошено исключение MissingModelException.

Параметры

string|null $modelClass optional: Имя класса модели для загрузки. По умолчанию $this->modelClass. Имя может быть псевдонимом, как 'Post' или полным именем класса, как App\Model\Table\PostsTable::class.
string|null $modelType optional: Тип хранилища для загрузки. По умолчанию значение getModelType().

Возвращает

Cake\Datasource\RepositoryInterface

Исключения

Cake\Datasource\Exception\MissingModelException
Если класс модели не найден.
UnexpectedValueException
Если аргумент $modelClass не предоставлен, а значение свойства ModelAwareTrait::$modelClass пустое.

logDelivery() protected

logDelivery(array $contents): void

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

Параметры

array $contents: Содержание с ключами 'headers' и 'message'.

Возвращает

void

modelFactory() public

modelFactory(string $type, Cake\Datasource\Locator\LocatorInterface|callable $factory): void

Переопределение существующего вызова для генерации хранилищ заданного типа.

Параметры

string $type: Имя типа хранилища, для которого предназначена функция-фабрика.
Cake\Datasource\Locator\LocatorInterface|callable $factory: Функция-фабрика, используемая для создания экземпляров.

Возвращает

void

parseDsn() public static

parseDsn(string $dsn): array<string, mixed>

Парсит 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<string, mixed>

Исключения

InvalidArgumentException
Если передан не строка или неверная строка

render() public

render(string $content = ''): $this

Отображает содержимое и устанавливает тело сообщения.

Параметры

string $content optional: Содержимое.

Возвращает

$this

reset() public

reset(): $this

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

Возвращает

$this

restore() protected

restore(): $this

Восстановить сообщение, рендерер, экземпляры транспорта в состояние до выполнения действия.

Возвращает

$this

send() public

send(string|null $action = null, array $args = [], array $headers = []): array

Отправляет электронное письмо.

Параметры

string|null $action необязательный: Имя действия почтового сервера для запуска. Если действие не указано, все остальные аргументы метода будут проигнорированы.
array $args необязательный: Аргументы для передачи вызываемому действию почтового сервера.
array $headers необязательный: Заголовки для установки.

Возвращает

array

Выбрасывает

Cake\Mailer\Exception\MissingActionException

BadMethodCallException

set() public

set(array|string $key, mixed $value = null): $this

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

Параметры

array|string $key: Имя переменной или хеш переменных представления.
mixed $value необязательный: Значение переменной представления.

Возвращает

$this

setAttachments() public @method

setAttachments(mixed $attachments): $this

Добавляет вложение к сообщению электронной почты. {@see \Cake\Mailer\Message::setAttachments()}

Параметры

$attachments

Возвращает

$this

setBcc() public @method

setBcc(mixed $email, mixed $name = null): $this

Устанавливает адрес "bcc". {@see \Cake\Mailer\Message::setBcc()}

Параметры

$email
$name необязательный

Возвращает

$this

setCc() public @method

setCc(mixed $email, mixed $name = null): $this

Устанавливает адрес "cc". {@see \Cake\Mailer\Message::setCc()}

Параметры

$email
$name необязательный

Возвращает

$this

setCharset() public @method

setCharset(mixed $charset): $this

Установка кодировки символов. {@see \Cake\Mailer\Message::setCharset()}

Параметры

$charset

Возвращает

$this

setConfig() public static

setConfig(array<string, mixed>|string $key, object|array<string, mixed>|null $config = null): void

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

Чтобы изменить конфигурацию адаптера во время выполнения, сначала удалите адаптер, а затем переконфигурируйте его.

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

Использование

Предполагая, что имя класса — Cache, поддерживаются следующие сценарии:

Настройка движка кэша.

Cache::setConfig('default', $settings);

Вставка созданного адаптера в:

Cache::setConfig('default', $instance);

Настройка нескольких адаптеров одновременно:

Cache::setConfig($arrayOfConfig);

Параметры

array<string, mixed>|string $key: Имя конфигурации или массив нескольких конфигураций.
object|array<string, mixed>|null $config необязательный: Массив данных конфигурации адаптера по имени.

Возвращает

void

Выбрасывает

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

setDomain() public @method

setDomain(mixed $domain): $this

Устанавливает домен. {@see \Cake\Mailer\Message::setDomain()}

Параметры

$domain

Возвращает

$this

setDsnClassMap() public static

setDsnClassMap(array<string, string> $map): void

Обновляет карту классов DSN для этого класса.

Параметры

array<string, string> $map: Добавления/изменения в карте классов для применения.

Возвращает

void

setEmailFormat() public @method

setEmailFormat(mixed $format): $this

Устанавливает формат электронной почты. {@see \Cake\Mailer\Message::getHeaders()}

Параметры

$format

Возвращает

$this

setFrom() public @method

setFrom(mixed $email, mixed $name = null): $this

Устанавливает адрес "от". {@see \Cake\Mailer\Message::setFrom()}

Параметры

$email
$name необязательный

Возвращает

$this

setHeaderCharset() public @method

setHeaderCharset(mixed $charset): $this

Установка кодировки символов для заголовков. {@see \Cake\Mailer\Message::setHeaderCharset()}

Параметры

$charset

Возвращает

$this

setHeaders() public @method

setHeaders(array $headers): $this

Устанавливает заголовки для сообщения. {@see \Cake\Mailer\Message::setHeaders()}

Параметры

array $headers

Возвращает

$this

setLogConfig() protected

setLogConfig(array<string, mixed>|string|true $log): void

Установить конфигурацию ведения журнала.

Параметры

array<string, mixed>|string|true $log: Конфигурация ведения журнала.

Возвращает

void

setMessage() public

setMessage(Cake\Mailer\Message $message): $this

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

Параметры

Cake\Mailer\Message $message: Экземпляр сообщения.

Возвращает

$this

setMessageId() public @method

setMessageId(mixed $message): $this

Устанавливает идентификатор сообщения. {@see \Cake\Mailer\Message::setMessageId()}

Параметры

$message

Возвращает

$this

setModelType() public

setModelType(string $modelType): $this

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

Параметры

string $modelType: Тип модели

Возвращает

$this

setProfile() public

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

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

Параметры

array<string, mixed>|string $config: Строка с именем конфигурации или массив с конфигурацией.

Возвращает

$this

setReadReceipt() public @method

setReadReceipt(mixed $email, mixed $name = null): $this

Устанавливает подтверждение прочтения (заголовок Disposition-Notification-To). {@see \Cake\Mailer\Message::setReadReceipt()}

Параметры

$email
$name необязательный

Возвращает

$this

setRenderer() public

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

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

Параметры

Cake\Mailer\Renderer $renderer: Экземпляр рендера.

Возвращает

$this

setReplyTo() public @method

setReplyTo(mixed $email, mixed $name = null): $this

Устанавливает адрес "Reply-To". {@see \Cake\Mailer\Message::setReplyTo()}

Параметры

$email
$name необязательно

Возвращает

$this

setReturnPath() public @method

setReturnPath(mixed $email, mixed $name = null): $this

Устанавливает обратный путь. {@see \Cake\Mailer\Message::setReturnPath()}

Параметры

$email
$name необязательно

Возвращает

$this

setSender() public @method

setSender(mixed $email, mixed $name = null): $this

Устанавливает адрес отправителя. {@see \Cake\Mailer\Message::setSender()}

Параметры

$email
$name необязательно

Возвращает

$this

setSubject() public @method

setSubject(mixed $subject): $this

Устанавливает тему. {@see \Cake\Mailer\Message::setSubject()}

Параметры

$subject

Возвращает

$this

setTableLocator() public

setTableLocator(Cake\ORM\Locator\LocatorInterface $tableLocator): $this

Устанавливает локатор таблицы.

Параметры

Cake\ORM\Locator\LocatorInterface $tableLocator: Экземпляр LocatorInterface.

Возвращает

$this

setTo() public @method

setTo(mixed $email, mixed $name = null): $this

Устанавливает адрес "to". {@see \Cake\Mailer\Message::setTo()}

Параметры

$email
$name необязательно

Возвращает

$this

setTransport() public

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

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

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

Параметры

Cake\Mailer\AbstractTransport|string $name: Либо имя настроенного транспорта, либо экземпляр транспорта.

Возвращает

$this

Вызывает исключение

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

setViewVars() public

setViewVars(array|string $key, mixed $value = null): $this

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

Параметры

array|string $key: Имя переменной или хэш переменных представления.
mixed $value необязательно: Значение переменной представления.

Возвращает

$this

viewBuilder() public

viewBuilder(): Cake\View\ViewBuilder

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

Возвращает

Cake\View\ViewBuilder

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

`$_config` protected static

Настройки конфигурации.

Тип

array<string, mixed>

`$_dsnClassMap` protected static

Карта классов драйверов почтовой рассылки.

Тип

array<string, string>

`$_modelFactories` protected

Список переопределённых функций фабрики моделей.

Тип

array<callableCake\Datasource\Locator\LocatorInterface>

`$_modelType` protected

Тип модели для использования.

Тип

string

`$_tableLocator` protected

Экземпляр локатора таблиц

Тип

Cake\ORM\Locator\LocatorInterface|null

`$clonedInstances` protected

Хранение экземпляров сообщения, рендерера и транспорта для восстановления после выполнения действия почтовой рассылки.

Тип

array<string, mixed>

`$defaultTable` protected

Псевдоним таблицы по умолчанию для этого объекта.

Тип

string|null

`$logConfig` protected

Тип

array|null

`$message` protected

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

Тип

Cake\Mailer\Message

`$messageClass` protected

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

Тип

string

`$modelClass` protected deprecated

Основное имя класса модели для этого объекта. Должно быть во множественном числе. CakePHP не будет изменять имя.

Пример: Для объекта с именем 'Комментарии', modelClass будет 'Комментарии'. Классы плагинов должны использовать имена в формате Plugin.Comments для корректной загрузки моделей из соответствующего плагина.

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

Тип

string|null

`$name` public static

Имя почтовой рассылки.

Тип

string

`$renderer` protected

Рендерер электронной почты

Тип

Cake\Mailer\Renderer|null

`$transport` protected

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

Тип

Cake\Mailer\AbstractTransport|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.Mailer.html

Класс Mailer

Определение сообщений

Отправка сообщений

Обработчик событий

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

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

__call() public

__construct() public

_setModelClass() protected

addAttachments() public @method

addBcc() public @method

addCc() public @method

addHeaders() public @method

addReplyTo() public @method

addTo() public @method

configured() public static

deliver() public

drop() public static

fetchTable() public

flatten() protected

getAttachments() public @method

getBcc() public @method

getBody() public @method

getCc() public @method

getCharset() public @method

getConfig() public static

getConfigOrFail() public static

getDomain() public @method

getDsnClassMap() public static

getEmailFormat() public @method

getFrom() public @method

getHeaderCharset() public @method

getHeaders() public @method

getMessage() public

getMessageId() public @method

getModelType() public

getReadReceipt() public @method

getRenderer() public

getReplyTo() public @method

getReturnPath() public @method

getSender() public @method

getSubject() public @method

getTableLocator() public

getTo() public @method

getTransport() public

implementedEvents() public

loadModel() public deprecated

logDelivery() protected

modelFactory() public

parseDsn() public static

render() public

reset() public

restore() protected

send() public

set() public deprecated

setAttachments() public @method

setBcc() public @method

setCc() public @method

setCharset() public @method

setConfig() public static

setDomain() public @method

setDsnClassMap() public static

setEmailFormat() public @method

setFrom() public @method

setHeaderCharset() public @method

setHeaders() public @method

setLogConfig() protected

setMessage() public

setMessageId() public @method

setModelType() public

setProfile() public

setReadReceipt() public @method

setRenderer() public

setReplyTo() public @method

setReturnPath() public @method

setSender() public @method

setSubject() public @method

setTableLocator() public

setTo() public @method

setTransport() public