Mailer base class.
Mailer classes let you encapsulate related Email logic into a reusable and testable class.
Mailers make it easy for you to define methods that handle email formatting logic. For example:
class UserMailer extends Mailer
{
public function resetPassword($user)
{
$this
->setSubject('Reset Password')
->setTo($user->email)
->set(['token' => $user->token]);
}
}Is a trivial example but shows how a mailer could be declared.
After you have defined some messages you will want to send them:
$mailer = new UserMailer();
$mailer->send('resetPassword', $user);Mailers can also subscribe to application event allowing you to
decouple email delivery from your application code. By re-declaring the
implementedEvents() method you can define event handlers that can
convert events into email. For example, if your application had a user
registration event:
public function implementedEvents()
{
return [
'Model.afterSave' => 'onRegistration',
];
}
public function onRegistration(Event $event, Entity $entity, ArrayObject $options)
{
if ($entity->isNew()) {
$this->send('welcome', [$entity]);
}
}The onRegistration method converts the application event into a mailer method. Our mailer could either be registered in the application bootstrap, or in the Table class' initialize() hook.
$modelClass : string
This object's primary model class name. Should be a plural form.
CakePHP will not inflect the name.
Example: For an object named 'Comments', the modelClass would be 'Comments'.
Plugin classes should use Plugin.Comments style names to correctly load
models from the correct plugin.
$_email : \Cake\Mailer\Email
Email instance.
$_clonedEmail : \Cake\Mailer\Email
Cloned Email instance for restoring instance after email is sent by mailer action.
loadModel(string|null $modelClass = null, string|null $modelType = null) : \Cake\Datasource\RepositoryInterface
Loads and constructs repository objects required by this object
Typically used to load ORM Table objects as required. Can also be used to load other types of repository objects your application uses.
If a repository provider does not return an object a MissingModelException will be thrown.
| string|null | $modelClass | Name of model class to load. Defaults to $this->modelClass |
| string|null | $modelType | The type of repository to load. Defaults to the modelType() value. |
If the model class cannot be found.
When using a type that has not been registered.
If no model type has been defined
The model instance created.
__construct(\Cake\Mailer\Email|null $email = null)
Constructor.
| \Cake\Mailer\Email|null | Email instance. |
viewBuilder() : \Cake\View\ViewBuilder
Get Email instance's view builder.
send(string $action, array $args = array(), array $headers = array()) : array
Sends email.
| string | $action | The name of the mailer action to trigger. |
| array | $args | Arguments to pass to the triggered mailer action. |
| array | $headers | Headers to set. |
implementedEvents() : array
Implemented events.
public function implementedEvents()
{
return [
'Order.complete' => 'sendEmail',
'Article.afterBuy' => 'decrementInventory',
'User.onRegister' => ['callable' => 'logRegistration', 'priority' => 20, 'passParams' => true]
];
}