Материал из Umicms

Описание

Класс umiMail предназначен для отправки e-mail. Главные особенности этого класса - использование шаблонов и обработка макросов в теле письма.

Методы

__construct

• public function __construct($template = "default")

Конструктор класса

$template - шаблон письма, находится в /tpls/mail/

Использование:

  $mail = new umiMail();

addRecipient

• public function addRecipient($email, $name = false)

Добавление получателя

$email - e-mail адрес получателя

$name - имя получателя

Использование:

  $mail->addRecipient("vasya@example.com", "Вася");

setFrom

• public function setFrom($email, $name = false)

Установка отправителя

$email - e-mail адрес отправителя

$name - имя отправителя

Использование:

  $mail->setFrom("admin@example.com", "Administrator");

setSubject

• public function setSubject($subject)

Установка темы письма

$subject - тема письма

Использование:

  $mail->setSubject("Greetings");

setContent

• public function setContent($contentString)

Установка текста письма с обработкой макросов

$contentString - текст письма. Макросы, находящиеся в теле письма, будут отработаны.

Использование:

  $mail->setContent("thanks for using UMI.CMS!");

setTxtContent

• public function setContent($contentString)

Установка текста письма

$contentString - текст письма. Макросы, находящиеся в теле письма, не будут отработаны.

Использование:

  $mail->setTxtContent("thanks for using UMI.CMS!");

addHTMLImage

• private function addHTMLImage($sImagePath, $sCType = "image/jpeg")

Добавляет изображение в письмо

$sImagePath - URL изображения $sCType - MIME-тип изображения

  $mail->addHTMLImage("http://www.example.com/image.png", "image/png");

attachFile

• public function attachFile(umiFile $file)

Прикрепление файла к письму

send

• public function send()

Отправка сообщения

Использование:

  $mail->send();

Пример использования

// Тело письма
$mailBody = <<<MAIL
 
Thanks for using UMI.CMS!
 
MAIL;
			// Параметр конструктора - шаблон письма. По-умолчанию, "default"
			$mail = new umiMail();
			// Установка адреса отправителя
			$mail->setFrom("admin@site.ru");
			// Установка адреса получателя
			$mail->addRecipient("user123@site.ru", "Вася");
			// Установка темы письма
			$mail->setSubject("Testing...");
			// Установка приоритета письма
			$mail->setPriorityLevel('highest');
			// setContent устанавливает текст письма, обрабатывая макросы
			// setTxtContent устанавливает текст письма, не обрабатывая макросы
			$mail->setContent($mailBody);
			// подтверждение отправки сообщения
			$mail->commit();
			$res = $mail->send();