Docs For Class sbMail

Описание

Класс для отправки писем с сайта

Письма могут состоять из нескольких включаемых частей (присоединенных файлов, картинок, альтернативного текста и пр.)

author: Казбек Елекоев <elekoev@binn.ru>
version: 4.0
copyright: Copyright (c) 2007, OOO "СИБИЭС Групп"

Располагается в /lib/sbMail.inc.php (строка 28)

Методы (список)

sbMail __construct ()

void addAttachment (string $file, [string $name = ''], [string $c_type = 'application/octet-stream'], [string $encoding = 'base64'])

void addHtmlImage (string $file, [string $name = ''], [string $c_type = 'application/octet-stream'])

mixed getFile (string $filename)

bool send (array $recipients, [bool $checkBuild = true])

void setBcc (string $bcc)

void setCc (string $cc)

void setFrom (string $from)

void setHeadCharset ([string $charset = ''])

void setHeader (string $name, string $value)

void setHtml (string $html, [string $text = ''], [bool $embed_images = null])

void setHtmlCharset ([string $charset = ''])

void setHtmlEncoding ([string $encoding = 'quoted-printable'])

void setReturnPath (string $return_path)

void setSubject (string $subject)

void setText ([string $text = ''])

void setTextCharset ([string $charset = ''])

void setTextEncoding ([string $encoding = '8bit'])

void setTextWrap ([int $count = 998])

Методы

Конструктор __construct (строка 122)

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

Выставляет заголовки письма по умолчанию.

access: public

sbMail __construct ()

addAttachment (строка 540)

Добавляет файл в список присоединенных файлов

access: public

void addAttachment (string $file, [string $name = ''], [string $c_type = 'application/octet-stream'], [string $encoding = 'base64'])

string $file: Текст файла.
string $name: Имя файла.
string $c_type: Тип файла.
string $encoding: Кодировка, в которую будет переведен текст файла (base64 и пр.)

addHtmlImage (строка 522)

Добавляет изображение в список включенных изображений

access: public

void addHtmlImage (string $file, [string $name = ''], [string $c_type = 'application/octet-stream'])

string $file: Текст файла изображения.
string $name: Уникальное имя файла изображения (на него и будет заменена ссылка).
string $c_type: Тип изображения.

getFile (строка 219)

Считывает содержимое файла и возвращает его (используется для включенных изображений и присоединенных файлов).

return: Текст файла, если удалось прочитать файл, или FALSE в ином случае.
access: public

mixed getFile (string $filename)

string $filename: Путь к файлу.

send (строка 879)

Отправляет письмо

return: TRUE, если письмо отправлено и FALSE в ином случае.
access: public

bool send (array $recipients, [bool $checkBuild = true])

array $recipients: Массив получателей.
bool $checkBuild: Если true - письмо собираеться один раз, если false - письмо собираеться перед каждой отправкой

setBcc (строка 383)

Устанавливает заголовок Bcc

Несколько E-mail-адресов передаются через запятую.

access: public

void setBcc (string $bcc)

string $bcc: Один или несколько E-mail-адресов.

setCc (строка 368)

Устанавливает заголовок Cc

Несколько E-mail-адресов передаются через запятую.

access: public

void setCc (string $cc)

string $cc: Один или несколько E-mail-адресов.

setFrom (строка 337)

Устанавливает E-mail-адрес отправителя (From)

access: public

void setFrom (string $from)

string $from: E-mail-адрес.

setHeadCharset (строка 290)

Устанавливает кодировку заголовка письма (WINDOWS-1251, ISO-8859-1 и т.д.)

access: public

void setHeadCharset ([string $charset = ''])

string $charset: Кодировка.

setHeader (строка 314)

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

access: public

void setHeader (string $name, string $value)

string $name: Название заголовка.
string $value: Значение заголовка.

setHtml (строка 419)

Добавляет HTML-текст в письмо

Если параметр $embed_images установлен в TRUE, то все изображения, разрешенные в параметре mImageTypes, будут заменены на ID их контентов.

access: public

void setHtml (string $html, [string $text = ''], [bool $embed_images = null])

string $html: HTML-текст.
string $text: Альтернативный обычный текст.
bool $embed_images: Отправлять изображения как включенные файлы или нет.

setHtmlCharset (строка 277)

Устанавливает кодировку HTML-текста письма (WINDOWS-1251, ISO-8859-1 и т.д.)

access: public

void setHtmlCharset ([string $charset = ''])

string $charset: Кодировка.

setHtmlEncoding (строка 254)

Устанавливает кодировку HTML-текста письма (quoted-printable, 7bit, 8bit)

access: public

void setHtmlEncoding ([string $encoding = 'quoted-printable'])

string $encoding: Кодировка.

setReturnPath (строка 353)

Устанавливает обратный E-mail-адрес (Return Path)

access: public

void setReturnPath (string $return_path)

string $return_path: Обратный E-mail-адрес.

setSubject (строка 324)

Устанавливает заголовок письма (Subject)

access: public

void setSubject (string $subject)

string $subject: Заголовок письма.

setText (строка 398)

Добавляет обычный текст в письмо

Используйте эту функцию, только когда отправляете письма формата plain/text.

access: public

void setText ([string $text = ''])

string $text: Обычный текст.

setTextCharset (строка 264)

Устанавливает кодировку текста письма (WINDOWS-1251, ISO-8859-1 и т.д.)

access: public

void setTextCharset ([string $charset = ''])

string $charset: Кодировка.

setTextEncoding (строка 244)

Устанавливает кодировку текста письма (7bit, 8bit)

access: public

void setTextEncoding ([string $encoding = '8bit'])

string $encoding: Кодировка.

setTextWrap (строка 303)

Устанавливает кол-во символов в строке для текстовых писем

access: public

void setTextWrap ([int $count = 998])

int $count: Кол-во символов.

Техническая поддержка:

Сайт: http://www.sbuilder.ru/tec_support.php
E-mail: support@sbuilder.ru