Класс Mailer

Базовый класс Mailer.

Классы Mailer позволяют вам инкапсулировать связанную логику электронной почты в переиспользуемый и тестируемый класс.

Определение сообщений

Mailer позволяют легко определять методы, которые обрабатывают логику форматирования электронной почты. Например:

class UserMailer extends Mailer
{
    public function resetPassword($user)
    {
        $this
            ->subject('Reset Password')
            ->to($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
  string

  Клонированный экземпляр 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
  Устанавливает используемый макет.
• reset() protected
  Сбросить экземпляр электронной почты.
• send() public
  Отправка электронной почты.
• set() public
  Устанавливает переменные представления электронной почты.
• 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 )

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

modelFactory( string $type , callable $factory )

modelType( string|null $modelType null )

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

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

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

from()source public

from( $email , $name )

Параметры

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

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

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

getHeaders()source public

getHeaders( array $include )

Параметры

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

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

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

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

setHeaders()source public

setHeaders( array $headers )

Параметры

массив $headers

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

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

Возвращает

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