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
            ->setSubject('Reset Password')
            ->setTo($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

Properties summary

• $_clonedEmail protected
  Cake\Mailer\Email

  Cloned Email instance for restoring instance after email is sent by mailer action.

• $_email protected
  Cake\Mailer\Email
  Email instance.
• $name public static
  string
  Mailer's name.

Inherited Properties

• _modelFactories, _modelType, modelClass

Method Summary

• __call() public
  Magic method to forward method class to Email instance.
• __construct() public
  Constructor.
• getName() public
  Returns the mailer's name.
• implementedEvents() public
  Implemented events.
• layout() public deprecated
  Sets layout to use.
• reset() protected
  Reset email instance.
• send() public
  Sends email.
• set() public
  Sets email view vars.
• viewBuilder() public
  Get Email instance's view builder.

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 )

getModelType( )

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

modelFactory( string $type , callable $factory )

modelType( string|null $modelType = null )

setModelType( string $modelType )

Magic methods summary

addAttachments()source public

addAttachments( $attachments )

Parameters

$attachments

Returns

addBcc()source public

addBcc( $email , $name = )

Parameters

$email

$name optional

Returns

addCc()source public

addCc( $email , $name = )

Parameters

$email

$name optional

Returns

addHeaders()source public

addHeaders( array $headers )

Parameters

array $headers

Returns

addTo()source public

addTo( $email , $name = )

Parameters

$email

$name optional

Returns

attachments()source public

attachments( $attachments = )

Parameters

$attachments optional

Returns

bcc()source public

bcc( $email = , $name = )

Parameters

$email optional

$name optional

Returns

cc()source public

cc( $email = , $name = )

Parameters

$email optional

$name optional

Returns

charset()source public

charset( $charset = )

Parameters

$charset optional

Returns

domain()source public

domain( $domain = )

Parameters

$domain optional

Returns

emailFormat()source public

emailFormat( $format = )

Parameters

$format optional

Returns

emailPattern()source public

emailPattern( $regex = )

Parameters

$regex optional

Returns

from()source public

from( $email = , $name = )

Parameters

$email optional

$name optional

Returns

getAttachments()source public

getAttachments( )

Returns

getBcc()source public

getBcc( )

Returns

getCc()source public

getCc( )

Returns

getCharset()source public

getCharset( )

Returns

getDomain()source public

getDomain( )

Returns

getEmailFormat()source public

getEmailFormat( )

Returns

getEmailPattern()source public

getEmailPattern( )

Returns

getFrom()source public

getFrom( )

Returns

getHeaderCharset()source public

getHeaderCharset( )

Returns

getHeaders()source public

getHeaders( array $include = )

Parameters

array $include optional

Returns

getHelpers()source public

getHelpers( )

Returns

getLayout()source public

getLayout( )

Returns

getMessageId()source public

getMessageId( )

Returns

getProfile()source public

getProfile( )

Returns

getReadReceipt()source public

getReadReceipt( )

Returns

getReplyTo()source public

getReplyTo( )

Returns

getReturnPath()source public

getReturnPath( )

Returns

getSender()source public

getSender( )

Returns

getSubject()source public

getSubject( )

Returns

getTemplate()source public

getTemplate( )

Returns

getTheme()source public

getTheme( )

Returns

getTo()source public

getTo( )

Returns

getTransport()source public

getTransport( )

Returns

getViewRenderer()source public

getViewRenderer( )

Returns

getViewVars()source public

getViewVars( )

Returns

headerCharset()source public

headerCharset( $charset = )

Parameters

$charset optional

Returns

helpers()source public

helpers( $helpers = )

Parameters

$helpers optional

Returns

message()source public

message( $type = )

Parameters

$type optional

Returns

messageId()source public

messageId( $message = )

Parameters

$message optional

Returns

profile()source public

profile( $config = )

Parameters

$config optional

Returns

readReceipt()source public

readReceipt( $email = , $name = )

Parameters

$email optional

$name optional

Returns

replyTo()source public

replyTo( $email = , $name = )

Parameters

$email optional

$name optional

Returns

returnPath()source public

returnPath( $email = , $name = )

Parameters

$email optional

$name optional

Returns

sender()source public

sender( $email = , $name = )

Parameters

$email optional

$name optional

Returns

setAttachments()source public

setAttachments( $attachments )

Parameters

$attachments

Returns

setBcc()source public

setBcc( $email , $name = )

Parameters

$email

$name optional

Returns

setCc()source public

setCc( $email , $name = )

Parameters

$email

$name optional

Returns

setCharset()source public

setCharset( $charset )

Parameters

$charset

Returns

setDomain()source public

setDomain( $domain )

Parameters

$domain

Returns

setEmailFormat()source public

setEmailFormat( $format )

Parameters

$format

Returns

setEmailPattern()source public

setEmailPattern( $regex )

Parameters

$regex

Returns

setFrom()source public

setFrom( $email , $name = )

Parameters

$email

$name optional

Returns

setHeaderCharset()source public

setHeaderCharset( $charset )

Parameters

$charset

Returns

setHeaders()source public

setHeaders( array $headers )

Parameters

array $headers

Returns

setHelpers()source public

setHelpers( array $helpers )

Parameters

array $helpers

Returns

setLayout()source public

setLayout( $layout )

Parameters

$layout

Returns

setMessageId()source public

setMessageId( $message )

Parameters

$message

Returns

setProfile()source public

setProfile( $config )

Parameters

$config

Returns

setReadReceipt()source public

setReadReceipt( $email , $name = )

Parameters

$email

$name optional

Returns

setReplyTo()source public

setReplyTo( $email , $name = )

Parameters

$email

$name optional

Returns

setReturnPath()source public

setReturnPath( $email , $name = )

Parameters

$email

$name optional

Returns

setSender()source public

setSender( $email , $name = )

Parameters

$email

$name optional

Returns

setSubject()source public

setSubject( $subject )

Parameters

$subject

Returns

setTemplate()source public

setTemplate( $template )

Parameters

$template

Returns

setTheme()source public

setTheme( $theme )

Parameters

$theme

Returns

setTo()source public

setTo( $email , $name = )

Parameters

$email

$name optional

Returns

setTransport()source public

setTransport( $name )

Parameters

$name

Returns

setViewRenderer()source public

setViewRenderer( $viewClass )

Parameters

$viewClass

Returns

setViewVars()source public

setViewVars( $viewVars )

Parameters

$viewVars

Returns

subject()source public

subject( $subject = )

Parameters

$subject optional

Returns

template()source public

template( $template = , $layout = )

Parameters

$template optional

$layout optional

Returns

theme()source public

theme( $theme = )

Parameters

$theme optional

Returns

to()source public

to( $email = , $name = )

Parameters

$email optional

$name optional

Returns

transport()source public

transport( $name = )

Parameters

$name optional

Returns

viewRender()source public

viewRender( $viewClass = )

Parameters

$viewClass optional

Returns

viewVars()source public

viewVars( $viewVars = )

Parameters

$viewVars optional

Returns

Properties detail