Версия: 6.x
burger close
Открытые члены | Поля данных | Защищенные члены | Защищенные данные
Класс Mailer
Граф наследования:Mailer:

Подробное описание

Рекомендованный класс для формирования и отправки Email сообщений в ReadyScript. Генерирует событие перед отправкой каждого письма, тем самым позволяет сторонним модулям вмешиваться в подготовку данных для отправки.

Открытые члены

 __construct ($exceptions=null)
 
 renderBody ($template, $vars)
 
 addEmails ($comma_separated_emails)
 
 setEventParams ($event_id, array $params=[])
 
 preSend ()
 

Поля данных

 $RenderBodyTemplates
 
 $RenderBodyVars
 
 $SingleTo = true
 
 $EventParams = []
 

Защищенные члены

 addAnAddress ($kind, $address, $name= '')
 
 addOrEnqueueAnAddress ($kind, $address, $name)
 

Защищенные данные

 $EventId
 

Конструктор(ы)

__construct (   $exceptions = null)

Расширенный конструктор класса. Устанавливает все параметры, согласно настройкам в административной панели

Аргументы
bool  |  null$exceptions- Бросать исключения в случае ошибок если true - да если false - нет, ошибки сохраняются во внутренней переменной
Возвращает
Mailer

Методы

addAnAddress (   $kind,
  $address,
  $name = '' 
)
protected

Add an address to one of the recipient arrays. Addresses that have been added already return false, but do not throw exceptions

Аргументы
string$kindOne of 'to', 'cc', 'bcc', 'ReplyTo'
string$addressThe email address to send to
string$name
Исключения
phpmailerException
Возвращает
boolean true on success, false if address already used or invalid in some way protected
addEmails (   $comma_separated_emails)

Добавляет адресатов для отправки письма

Аргументы
string$comma_separated_emails- email адреса, разделенные запятой
Возвращает
void
addOrEnqueueAnAddress (   $kind,
  $address,
  $name 
)
protected

Add an address to one of the recipient arrays or to the ReplyTo array. Because PHPMailer can't validate addresses with an IDN without knowing the PHPMailer::$CharSet (that can still be modified after calling this function), addition of such addresses is delayed until send(). Addresses that have been added already return false, but do not throw exceptions.

Аргументы
string$kindOne of 'to', 'cc', 'bcc', or 'ReplyTo'
string$addressThe email address to send, resp. to reply to
string$name
Исключения
phpmailerException
Возвращает
boolean true on success, false if address already used or invalid in some way protected
preSend ( )

Подготавливает сообщение для отправки

Исключения
phpmailerException
Возвращает
bool
renderBody (   $template,
  $vars 
)

Устанавливает тело письма, путем рендеринга шаблона

Аргументы
string$template- путь к шаблону
mixed$vars- переменные для шаблона. Будут доступы в нем в переменной $data
Возвращает
void
setEventParams (   $event_id,
array  $params = [] 
)

Устанавливает параметры вызываемого перед отправкой события.

Аргументы
string$event_id- Идентификатор, который будет включен в имя генерируемого события, Например, если идентификатор bar, то событие будет носить имя mailer.bar.beforesend
array$paramsпараметры, которые будут переданы в событие

Поля

$EventId
protected
$EventParams = []
$RenderBodyTemplates
$RenderBodyVars
$SingleTo = true