Класс 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 )

Параметры

$attachments

Возвращает

addBcc()source public

addBcc( $email , $name = )

Параметры

$email

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

Возвращает

addCc()source public

addCc( $email , $name = )

Параметры

$email

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

Возвращает

addHeaders()source public

addHeaders( array $headers )

Параметры

массив $headers

Возвращает

addTo()source public

addTo( $email , $name = )

Параметры

$email

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

Возвращает

attachments()source public

attachments( $attachments = )

Параметры

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

Возвращает

bcc()source public

bcc( $email = , $name = )

Параметры

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

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

Возвращает

cc()source public

cc( $email = , $name = )

Параметры

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

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

Возвращает

charset()source public

charset( $charset = )

Параметры

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

Возвращает

domain()source public

domain( $domain = )

Параметры

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

Возвращает

emailFormat()source public

emailFormat( $format = )

Параметры

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

Возвращает

emailPattern()source public

emailPattern( $regex = )

Параметры

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

Возвращает

from()source public

from( $email = , $name = )

Параметры

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

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

Возвращает

getAttachments()source public

getAttachments( )

Возвращает

getBcc()source public

getBcc( )

Возвращает

getCc()source public

getCc( )

Возвращает

getCharset()source public

getCharset( )

Возвращает

getDomain()source public

getDomain( )

Возвращает

getEmailFormat()source public

getEmailFormat( )

Возвращает

getEmailPattern()source public

getEmailPattern( )

Возвращает

getFrom()source public

getFrom( )

Возвращает

getHeaderCharset()source public

getHeaderCharset( )

Возвращает

getHeaders()source public

getHeaders( array $include = )

Параметры

массив $include необязательно

Возвращает

getHelpers()source public

getHelpers( )

Возвращает

getLayout()source public

getLayout( )

Возвращает

getMessageId()source public

getMessageId( )

Возвращает

getProfile()source public

getProfile( )

Возвращает

getReadReceipt()source public

getReadReceipt( )

Возвращает

getReplyTo()source public

getReplyTo( )

Возвращает

getReturnPath()source public

getReturnPath( )

Возвращает

getSender()source public

getSender( )

Возвращает

getSubject()source public

getSubject( )

Возвращает

getTemplate()source public

getTemplate( )

Возвращает

getTheme()source public

getTheme( )

Возвращает

getTo()source public

getTo( )

Возвращает

getTransport()source public

getTransport( )

Возвращает

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

Возвращает

setEmailPattern()source public

setEmailPattern( $regex )

Параметры

$regex

Возвращает

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 необязательно

Возвращаемое значение

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