Класс 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

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

array

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

(callableCake\Datasource\Locator\LocatorInterface)[]

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

string

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

array

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

array|null
$message protected

Cake\Mailer\Message

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

string

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

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

Удаляет созданный адаптер.
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

Получить адрес "от". {@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

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

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

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

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

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

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

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

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

Разбирает DSN в корректную конфигурацию подключения
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()}
setTo() public @method

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

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

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

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

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

__call() public

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

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

Parameters

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

Returns

$this|mixed

__construct() public

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

Конструктор

Parameters

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

_setModelClass() protected

_setModelClass(string $name): void

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

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

Parameters

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

Returns

void

addAttachments() public @method

addAttachments(mixed $attachments): $this

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

Parameters

$attachments

Returns

$this

addBcc() public @method

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

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

Parameters

$email
$name optional

Returns

$this

addCc() public @method

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

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

Parameters

$email
$name optional

Returns

$this

addHeaders() public @method

addHeaders(array $headers): $this

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

Parameters

array $headers

Returns

$this

addReplyTo() public @method

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

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

Parameters

$email
$name optional

Returns

$this

addTo() public @method

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

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

Parameters

$email
$name optional

Returns

$this

configured() public static

configured(): string[]

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

Returns

string[]

deliver() public

deliver(string $content = ''): array

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

Parameters

string $content optional: Контент.

Returns

array

drop() public static

drop(string $config): bool

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

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

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

Parameters

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

Returns

bool

flatten() protected

flatten(string|array $value): string

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

Parameters

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

Returns

string

getAttachments() public @method

getAttachments(): array

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

Returns

array

getBcc() public @method

getBcc(): array

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

Returns

array

getBody() public @method

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

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

Parameters

?string $type optional

Returns

string|array

getCc() public @method

getCc(): array

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

Returns

array

getCharset() public @method

getCharset(): string

Геттер кодировки. {@see \Cake\Mailer\Message::getCharset()}

Returns

string

getConfig() public static

getConfig(string $key): mixed|null

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

Parameters

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

Returns

mixed|null

getConfigOrFail() public static

getConfigOrFail(string $key): mixed

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

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

Parameters

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

Returns

mixed

Throws

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

getDomain() public @method

getDomain(): string

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

Returns

string

getDsnClassMap() public static

getDsnClassMap(): string[]

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

Returns

string[]

getEmailFormat() public @method

getEmailFormat(): string

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

Returns

string

getFrom() public @method

getFrom(): array

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

Returns

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 необязательно

Возвращает

$this

getMessage() public

getMessage(): Cake\Mailer\Message

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

Возвращает

Cake\Mailer\Message

getMessageId() public @method

getMessageId(): bool|string

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

Возвращает

bool|string

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

getTo() public @method

getTo(): array

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

Возвращает

array

getTransport() public

getTransport(): Cake\Mailer\AbstractTransport

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

Возвращает

Cake\Mailer\AbstractTransport

implementedEvents() public

implementedEvents(): array

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

Пример:

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

Возвращает

array

loadModel() public

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

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

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

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

Параметры

string|null $modelClass необязательно: Имя класса модели для загрузки. По умолчанию $this->modelClass. Имя может быть псевдонимом, например, 'Post' или FQCN, например, App\Model\Table\PostsTable::class.
string|null $modelType необязательно: Тип хранилища для загрузки. По умолчанию значение 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, callableCake\Datasource\Locator\LocatorInterface $factory): void

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

Параметры

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

Возвращает

void

parseDsn() public static

parseDsn(string $dsn): array

Разбор 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

Исключения

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

render() public

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

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

Параметры

string $content необязательно: Содержимое.

Возвращает

$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(string|array $key, mixed $value = null): $this

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

Параметры

string|array $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 optional

Возвращает

$this

setCc() public @method

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

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

Параметры

$email
$name optional

Возвращает

$this

setCharset() public @method

setCharset(mixed $charset): $this

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

Параметры

$charset

Возвращает

$this

setConfig() public static

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

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

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

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

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

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

Настройка механизма кэширования.

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

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

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

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

Cache::setConfig($arrayOfConfig);

Параметры

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

Возвращает

void

Исключения

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

setDomain() public @method

setDomain(mixed $domain): $this

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

Параметры

$domain

Возвращает

$this

setDsnClassMap() public static

setDsnClassMap(string[] $map): void

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

Параметры

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

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

Параметры

$email
$name optional

Возвращает

$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(string|array|true $log): void

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

Параметры

string|array|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(string|array $config): $this

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

Параметры

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

Возвращает

$this

setReadReceipt() public @method

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

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

Параметры

$email
$name optional

Возвращает

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

Возвращает

$this

setReturnPath() public @method

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

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

Параметры

$email
$name optional

Возвращает

$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

setTo() public @method

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

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

Параметры

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

Возвращает

$this

setTransport() public

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

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

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

Параметры

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

Возвращает

$this

Исключения

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

setViewVars() public

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

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

Параметры

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

Возвращает

$this

viewBuilder() public

viewBuilder(): Cake\View\ViewBuilder

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

Возвращает

Cake\View\ViewBuilder

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

`$_config` protected static

Наборы конфигурации.

Тип

array

`$_dsnClassMap` protected static

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

Тип

array

`$_modelFactories` protected

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

Тип

(callableCake\Datasource\Locator\LocatorInterface)[]

`$_modelType` protected

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

Тип

string

`$clonedInstances` protected

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

Тип

array

`$logConfig` protected

Тип

array|null

`$message` protected

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

Тип

Cake\Mailer\Message

`$messageClass` protected

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

Тип

string

`$modelClass` protected

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

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

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

Тип

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.2/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

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

getTo() public @method

getTransport() public

implementedEvents() public

loadModel() public

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

setTo() public @method

setTransport() public

setViewVars() public

viewBuilder() public

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