KMP PHP API Reference

QueuedMailerAwareTrait uses \Cake\Mailer\MailerAwareTrait

Provides functionality for loading mailer classes onto properties of the host object.

Example users of this trait are Cake\Controller\Controller and Cake\Console\Command.

Table of Contents

Properties

$mailer  : Mailer

Methods

queueMail()  : Mailer
Returns a mailer instance.
queueMailJob()  : void
Queues a mail job to be processed later.
sendMailNow()  : Mailer
Returns a mailer instance.

Properties

Methods

queueMail()

Returns a mailer instance.

protected queueMail(string $name, mixed $action, mixed $to, mixed $vars) : Mailer
Parameters
$name : string

Mailer's name.

$action : mixed
$to : mixed
$vars : mixed
Tags
throws
MissingMailerException

if undefined mailer class.

Return values
Mailer

queueMailJob()

Queues a mail job to be processed later.

protected queueMailJob(array<string|int, mixed> $data) : void
Parameters
$data : array<string|int, mixed>

Data to be passed to the mailer.

sendMailNow()

Returns a mailer instance.

protected sendMailNow(array<string|int, mixed> $data) : Mailer
Parameters
$data : array<string|int, mixed>
Tags
throws
MissingMailerException

if undefined mailer class.

Return values
Mailer

        
On this page

Search results