Класс 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
  Сбросить экземпляр email.
• 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 необязательно

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

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