Класс 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()
{
    return [
        'Model.afterSave' => 'onRegistration',
    ];
}

public function onRegistration(Event $event, Entity $entity, ArrayObject $options)
{
    if ($entity->isNew()) {
         $this->send('welcome', [$entity]);
    }
}

Метод onRegistration преобразует событие приложения в метод mailer. Наш mailer может быть зарегистрирован либо в загрузчике приложения, либо в методе initialize() класса Table.

Cake\Mailer\Mailer реализует Cake\Event\EventListenerInterface использует Cake\Datasource\ModelAwareTrait

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

• $_clonedEmail protected
  Cake\Mailer\Email

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

• $_email protected
  Cake\Mailer\Email
  Экземпляр Email.
• $name public static
  string
  Имя Mailer.

Унаследованные свойства

• _modelFactories, _modelType, modelClass

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

• __call() public
  Магический метод для переадресации метода класса экземпляру Email.
• __construct() public
  Конструктор.
• getName() public
  Возвращает имя mailer.
• implementedEvents() public
  Реализованные события.
• layout() public deprecated
  Устанавливает используемый макет.
• reset() protected
  Сброс экземпляра email.
• send() public
  Отправляет электронную почту.
• set() public
  Устанавливает переменные представления email.
• viewBuilder() public
  Получить обработчик представлений экземпляра Email.

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

__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( )

Методы, используемые из 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 )

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

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

массив $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

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

getFrom()source public

getFrom( )

Returns

getHeaderCharset()source public

getHeaderCharset( )

Returns

getHeaders()source public

getHeaders( array $include = )

Parameters

массив $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( )

Возвращает

getViewVars()source public

getViewVars( )

Возвращает

headerCharset()source public

headerCharset( $charset = )

Параметры

$charset необязательно

Возвращает

helpers()source public

helpers( $helpers = )

Параметры

$helpers необязательно

Возвращает

message()source public

message( $type = )

Параметры

$type необязательно

Возвращает

messageId()source public

messageId( $message = )

Параметры

$message необязательно

Возвращает

profile()source public

profile( $config = )

Параметры

$config необязательно

Возвращает

readReceipt()source public

readReceipt( $email = , $name = )

Параметры

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

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

Возвращает

replyTo()source public

replyTo( $email = , $name = )

Параметры

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

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

Возвращает

returnPath()source public

returnPath( $email = , $name = )

Параметры

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

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

Возвращает

sender()source public

sender( $email = , $name = )

Параметры

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

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

Возвращает

setAttachments()source public

setAttachments( $attachments )

Параметры

$attachments

Возвращает

setBcc()source public

setBcc( $email , $name = )

Параметры

$email

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

Возвращает

setCc()source public

setCc( $email , $name = )

Параметры

$email

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

Возвращает

setCharset()source public

setCharset( $charset )

Параметры

$charset

Возвращает

setDomain()source public

setDomain( $domain )

Параметры

$domain

Возвращает

setEmailFormat()source public

setEmailFormat( $format )

Параметры

$format

Возвращает

setFrom()source public

setFrom( $email , $name = )

Параметры

$email

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

Возвращает

setHeaderCharset()source public

setHeaderCharset( $charset )

Параметры

$charset

Возвращает

setHeaders()source public

setHeaders( array $headers )

Параметры

массив $headers

Возвращает

setHelpers()source public

setHelpers( array $helpers )

Параметры

массив $helpers

Возвращает

setLayout()source public

setLayout( $layout )

Параметры

$layout

Возвращает

setMessageId()source public

setMessageId( $message )

Параметры

$message

Возвращает

setProfile()source public

setProfile( $config )

Параметры

$config

Возвращает

setReadReceipt()source public

setReadReceipt( $email , $name = )

Параметры

$email

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

Возвращает

setReplyTo()source public

setReplyTo( $email , $name = )

Параметры

$email

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

Возвращает

setReturnPath()source public

setReturnPath( $email , $name = )

Параметры

$email

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

Возвращает

setSender()source public

setSender( $email , $name = )

Параметры

$email

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

Возвращает

setSubject()source public

setSubject( $subject )

Параметры

$subject

Возвращает

setTemplate()source public

setTemplate( $template )

Параметры

$template

Возвращает

setTheme()source public

setTheme( $theme )

Параметры

$theme

Возвращает

setTo()source public

setTo( $email , $name = )

Параметры

$email

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

Возвращает

setTransport()source public

setTransport( $name )

Параметры

$name

Возвращает

setViewRenderer()source public

setViewRenderer( $viewClass )

Параметры

$viewClass

Возвращает

setViewVars()source public

setViewVars( $viewVars )

Параметры

$viewVars

Возвращает

subject()source public

subject( $subject = )

Параметры

$subject необязательно

Возвращает

template()source public

template( $template = , $layout = )

Параметры

$template необязательно

$layout необязательно

Возвращает

theme()source public

theme( $theme = )

Параметры

$theme необязательно

Возвращает

to()source public

to( $email = , $name = )

Параметры

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

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

Возвращает

transport()source public

transport( $name = )

Параметры

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

Возвращает

viewRender()source public

viewRender( $viewClass = )

Параметры

$viewClass необязательно

Возвращает

viewVars()source public

viewVars( $viewVars = )

Параметры

$viewVars необязательно

Возвращает

Подробности свойств