Class Mailer

Mailer base class.

Mailer classes let you encapsulate related Email logic into a reusable and testable class.

Defining Messages

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
            ->subject('Reset Password')
            ->to($user->email)
            ->set(['token' => $user->token]);
    }
}

Is a trivial example but shows how a mailer could be declared.

Sending Messages

After you have defined some messages you will want to send them:

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

Event Listener

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.

Cake\Mailer\Mailer implements Cake\Event\EventListenerInterface uses Cake\Datasource\ModelAwareTrait

Method Detail

__call( string $method , array $args )

__construct( Cake\Mailer\Email $email null )

getName( )

implementedEvents( )

layout( string $layout )

reset( )

send( string $action , array $args [] , array $headers [] )

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

viewBuilder( )

Methods used from Cake\Datasource\ModelAwareTrait

_setModelClass( string $name )

loadModel( string|null $modelClass null , string|null $modelType null )

modelFactory( string $type , callable $factory )

modelType( string|null $modelType null )

Magic methods summary

addAttachmentssource public

addAttachments( mixed $attachments )

Parameters

mixed $attachments optional

Returns

addBccsource public

addBcc( mixed $email , mixed $name null )

Parameters

mixed $email optional

mixed $name optional null

Returns

addCcsource public

addCc( mixed $email , mixed $name null )

Parameters

mixed $email optional

mixed $name optional null

Returns

addHeaderssource public

addHeaders( array $headers )

Parameters

array $headers optional

Returns

addTosource public

addTo( mixed $email , mixed $name null )

Parameters

mixed $email optional

mixed $name optional null

Returns

attachmentssource public

attachments( mixed $attachments null )

Parameters

mixed $attachments optional null

Returns

bccsource public

bcc( mixed $email null , mixed $name null )

Parameters

mixed $email optional null

mixed $name optional null

Returns

ccsource public

cc( mixed $email null , mixed $name null )

Parameters

mixed $email optional null

mixed $name optional null

Returns

charsetsource public

charset( mixed $charset null )

Parameters

mixed $charset optional null

Returns

domainsource public

domain( mixed $domain null )

Parameters

mixed $domain optional null

Returns

emailFormatsource public

emailFormat( mixed $format null )

Parameters

mixed $format optional null

Returns

fromsource public

from( mixed $email null , mixed $name null )

Parameters

mixed $email optional null

mixed $name optional null

Returns

getHeaderssource public

getHeaders( array $include [] )

Parameters

array $include optional []

Returns

headerCharsetsource public

headerCharset( mixed $charset null )

Parameters

mixed $charset optional null

Returns

helperssource public

helpers( mixed $helpers null )

Parameters

mixed $helpers optional null

Returns

messagesource public

message( mixed $type null )

Parameters

mixed $type optional null

Returns

messageIdsource public

messageId( mixed $message null )

Parameters

mixed $message optional null

Returns

profilesource public

profile( mixed $config null )

Parameters

mixed $config optional null

Returns

readReceiptsource public

readReceipt( mixed $email null , mixed $name null )

Parameters

mixed $email optional null

mixed $name optional null

Returns

replyTosource public

replyTo( mixed $email null , mixed $name null )

Parameters

mixed $email optional null

mixed $name optional null

Returns

returnPathsource public

returnPath( mixed $email null , mixed $name null )

Parameters

mixed $email optional null

mixed $name optional null

Returns

sendersource public

sender( mixed $email null , mixed $name null )

Parameters

mixed $email optional null

mixed $name optional null

Returns

setHeaderssource public

setHeaders( array $headers )

Parameters

array $headers optional

Returns

subjectsource public

subject( mixed $subject null )

Parameters

mixed $subject optional null

Returns

templatesource public

template( mixed $template false , mixed $layout false )

Parameters

mixed $template optional false

mixed $layout optional false

Returns

themesource public

theme( mixed $theme null )

Parameters

mixed $theme optional null

Returns

tosource public

to( mixed $email null , mixed $name null )

Parameters

mixed $email optional null

mixed $name optional null

Returns

transportsource public

transport( mixed $name null )

Parameters

mixed $name optional null

Returns

viewRendersource public

viewRender( mixed $viewClass null )

Parameters

mixed $viewClass optional null

Returns

viewVarssource public

viewVars( mixed $viewVars null )

Parameters

mixed $viewVars optional null

Returns

Properties summary

Properties used from Cake\Datasource\ModelAwareTrait

[]

'Table'