ModuleMail

Package engine.modules
Inheritance class ModuleMail » Module » LsObject
Since 1.0
Source Code /engine/modules/mail/Mail.class.php
Модуль для отправки почты(e-mail) через phpMailer 
$this->Mail_SetAdress('claus@mail.ru','Claus');
$this->Mail_SetSubject('Hi!');
$this->Mail_SetBody('How are you?');
$this->Mail_setHTML();
$this->Mail_Send();

Protected Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
bIsInit bool Указывает на то, была ли проведенна инициализация модуля Module
bSmtpAuth bool Треубется или нет авторизация на smtp ModuleMail
iPort int Порт smtp ModuleMail
iWordWrap int Делать или нет перенос строк в письме ModuleMail
oEngine Engine Объект ядра Module
oMailer phpmailer Основной объект рассылбщика ModuleMail
sBody string Текст письма ModuleMail
sCharSet string Кодировка писем ModuleMail
sError string Строка последней ошибки ModuleMail
sFrom string Мыло от кого отправляется вся почта ModuleMail
sFromName string Имя от кого отправляется вся почта ModuleMail
sHost string Хост smtp ModuleMail
sMailerType string Метод отправки почты ModuleMail
sPassword string Пароль smtp ModuleMail
sSmtpSecure string Префикс соединения к smtp - "", "ssl" или "tls" ModuleMail
sSubject string Тема письма ModuleMail
sUsername string Логин smtp ModuleMail

Public Methods

Hide inherited methods

MethodDescriptionDefined By
AddAdress() Добавляем новый адрес получателя ModuleMail
ClearAddresses() Очищает все адреса получателей ModuleMail
GetError() Возвращает строку последней ошибки ModuleMail
Init() Инициализация модуля ModuleMail
Send() Отправляет сообщение(мыло) ModuleMail
SetAdress() Устанавливает единственный адрес получателя ModuleMail
SetBody() Устанавливает текст сообщения ModuleMail
SetInit() Помечает модуль как инициализированный Module
SetSubject() Устанавливает тему сообщения ModuleMail
Shutdown() Метод срабатывает при завершении работы ядра Module
__call() Ставим хук на вызов неизвестного метода и считаем что хотели вызвать метод какого либо модуля Module
__construct() При создании модуля передаем объект ядра Module
isInit() Возвращает значение флага инициализации модуля Module
setHTML() Устанавливает режим отправки письма как HTML ModuleMail
setPlain() Устанавливает режим отправки письма как Text(Plain) ModuleMail

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
__clone() Блокируем копирование/клонирование объекта Module

Property Details

bSmtpAuth property
protected bool $bSmtpAuth;

Треубется или нет авторизация на smtp

iPort property
protected int $iPort;

Порт smtp

iWordWrap property
protected int $iWordWrap;

Делать или нет перенос строк в письме

oMailer property
protected phpmailer $oMailer;

Основной объект рассылбщика

sBody property
protected string $sBody;

Текст письма

sCharSet property
protected string $sCharSet;

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

sError property
protected string $sError;

Строка последней ошибки

sFrom property
protected string $sFrom;

Мыло от кого отправляется вся почта

sFromName property
protected string $sFromName;

Имя от кого отправляется вся почта

sHost property
protected string $sHost;

Хост smtp

sMailerType property
protected string $sMailerType;

Метод отправки почты

sPassword property
protected string $sPassword;

Пароль smtp

sSmtpSecure property
protected string $sSmtpSecure;

Префикс соединения к smtp - "", "ssl" или "tls"

sSubject property
protected string $sSubject;

Тема письма

sUsername property
protected string $sUsername;

Логин smtp

Method Details

AddAdress() method
public void AddAdress(string $sMail, string $sName=NULL)
$sMail string Емайл
$sName string Имя
Source Code: /engine/modules/mail/Mail.class.php#200 (show)
public function AddAdress($sMail,$sName=null) {
    ob_start();
    $this->oMailer->AddAddress($sMail,$sName);
    $this->sError = ob_get_clean();
}

Добавляем новый адрес получателя

ClearAddresses() method
public void ClearAddresses()
Source Code: /engine/modules/mail/Mail.class.php#222 (show)
public function ClearAddresses() {
    $this->oMailer->ClearAddresses();
}

Очищает все адреса получателей

GetError() method
public string GetError()
{return} string
Source Code: /engine/modules/mail/Mail.class.php#257 (show)
public function GetError(){
    return $this->sError;
}

Возвращает строку последней ошибки

Init() method
public void Init()
Source Code: /engine/modules/mail/Mail.class.php#134 (show)
public function Init() {
    /**
     * Настройки SMTP сервера для отправки писем
     */
    $this->sHost     = Config::Get('sys.mail.smtp.host');
    $this->iPort     = Config::Get('sys.mail.smtp.port');
    $this->sUsername = Config::Get('sys.mail.smtp.user');
    $this->sPassword = Config::Get('sys.mail.smtp.password');
    $this->bSmtpAuth = Config::Get('sys.mail.smtp.auth');
    $this->sSmtpSecure = Config::Get('sys.mail.smtp.secure');
    /**
     * Метод отправки почты
     */
    $this->sMailerType=Config::Get('sys.mail.type');
    /**
     * Кодировка писем
     */
    $this->sCharSet=Config::Get('sys.mail.charset');
    /**
     * Мыло от кого отправляется вся почта
     */
    $this->sFrom=Config::Get('sys.mail.from_email');
    /**
     * Имя от кого отправляется вся почта
     */
    $this->sFromName=Config::Get('sys.mail.from_name');

    /**
     * Создаём объект phpMailer и устанвливаем ему необходимые настройки
     */
    $this->oMailer = new phpmailer();
    $this->oMailer->Host=$this->sHost;
    $this->oMailer->Port=$this->iPort;
    $this->oMailer->Username=$this->sUsername;
    $this->oMailer->Password=$this->sPassword;
    $this->oMailer->SMTPAuth=$this->bSmtpAuth;
    $this->oMailer->SMTPSecure=$this->sSmtpSecure;
    $this->oMailer->Mailer=$this->sMailerType;
    $this->oMailer->WordWrap=$this->iWordWrap;
    $this->oMailer->CharSet=$this->sCharSet;

    $this->oMailer->From=$this->sFrom;
    $this->oMailer->FromName=$this->sFromName;
}

Инициализация модуля

Send() method
public bool Send()
{return} bool
Source Code: /engine/modules/mail/Mail.class.php#210 (show)
public function Send() {
    $this->oMailer->Subject=$this->sSubject;
    $this->oMailer->Body=$this->sBody;
    ob_start();
    $bResult = $this->oMailer->Send();
    $this->sError = ob_get_clean();
    return $bResult;
}

Отправляет сообщение(мыло)

SetAdress() method
public void SetAdress(string $sMail, string $sName=NULL)
$sMail string Емайл
$sName string Имя
Source Code: /engine/modules/mail/Mail.class.php#231 (show)
public function SetAdress($sMail,$sName=null) {
    $this->ClearAddresses();
    ob_start();
    $this->oMailer->AddAddress($sMail,$sName);
    $this->sError = ob_get_clean();
}

Устанавливает единственный адрес получателя

SetBody() method
public void SetBody(string $sText)
$sText string Текст сообщения
Source Code: /engine/modules/mail/Mail.class.php#191 (show)
public function SetBody($sText) {
    $this->sBody=$sText;
}

Устанавливает текст сообщения

SetSubject() method
public void SetSubject(string $sText)
$sText string Тема сообщения
Source Code: /engine/modules/mail/Mail.class.php#183 (show)
public function SetSubject($sText) {
    $this->sSubject=$sText;
}

Устанавливает тему сообщения

setHTML() method
public void setHTML()
Source Code: /engine/modules/mail/Mail.class.php#241 (show)
public function setHTML() {
    $this->oMailer->IsHTML(true);
}

Устанавливает режим отправки письма как HTML

setPlain() method
public void setPlain()
Source Code: /engine/modules/mail/Mail.class.php#248 (show)
public function setPlain() {
    $this->oMailer->IsHTML(false);
}

Устанавливает режим отправки письма как Text(Plain)