Class Mail

---

[Строка 14]

Размещен: /Kernel/Mail.class.php

---

Описание

Система управления сайтом HostCMS v. 5.xx

Copyright © 2005-2010 ООО "Хостмэйк" (Hostmake LLC), http://www.hostcms.ru

Ядро, Класс "Mail" для получения писем с почтовых серверов.

Файл: /modules/Kernel/Mail.class.php

author

Hostmake LLC

version

5.x

---

Свойства класса

• $email_login =  'hostcms-test'
  Имя ящика (Логин)
• $email_password =  '346500'
  Пароль ящика пользователя
• $headers_string =  ''
  Заголовки письма
• $host =  'pop.yandex.ru'
  Имя хоста
• $letters = array()
  Массив, содержащий письма
• $mail_box =  ''
  Почтовый ящик, к которому выполняется доступ
• $port =  110
  Порт
• $protocol =  'email_imap'
  Протокол соединения
• $stream =  ''
  Идентификатор открытого соединения с почтовым сервером

---

Константы класса

---

Унаследованные константы класса

---

Унаследованные свойства класса

---

Методы

• str BodyDecode()
  Перекодировщик тела письма
• void DeleteMessages()
  Удаление всех писем из почтового ящика
• void GetMailBox()
  Формирование имени почтового ящика
• array GetMsgList()
  Получение списка писем
• str HeaderDecode()
  Перекодировщик из кодировки письма в кодировку системы
• str IconvText()
  Перекодирование текста из кодировки письма в кодировку системы
• boolean IsBase64Encoded()
  Проверка строки на то, является ли она закодированной base64
• array ParseHeaderAndBody()
  Разбор тела сообщения
• void ParseMessage()
  Разбор сообщения по частям
• str SaveHeaders()
  Сохранение заголовков письма
• str SaveStructure()
  Сохранение структуры сообщения
• array StructureToArray()
  Разбор структуры сообщения и сохранение результата в массив

Унаследованные методы

---

Описания методов

Mail::BodyDecode

BodyDecode( str $str, [str $encoding_type = ''] );

Описание

Перекодировщик тела письма

Принимаемые параметры

$str

Закодированная строка

$encoding_type

Тип кодировки

Возвращает

Раскодированная строка

[ Наверх ]




Mail::DeleteMessages

DeleteMessages( int $stream );

Описание

Удаление всех писем из почтового ящика

Принимаемые параметры

$stream

Идентификатор открытого соединения с почтовым сервером

[ Наверх ]




Mail::GetMailBox

GetMailBox( [array $param = array()] );

Описание

Формирование имени почтового ящика

Принимаемые параметры

$param

Массив параметров

• $param['email_pop3'] str Адрес хоста для подключения по протоколу POP3
• $param['email_imap'] str Адрес хоста для подключения по протоколу IMAP
• $param['email_login'] str Имя почтового ящика пользователя
• $param['email_password'] str Пароль к почтовому ящику пользователя
• $param['secury'] bool Флаг, является ли подключение безопасным

[ Наверх ]




Mail::GetMsgList

GetMsgList( [array $param = array()] );

Описание

Получение списка писем

Принимаемые параметры

$param

Массив параметров

• $param['email_pop3'] str Адрес хоста для подключения по протоколу POP3
• $param['email_imap'] str Адрес хоста для подключения по протоколу IMAP
• $param['email_login'] str Имя почтового ящика пользователя
• $param['email_password'] str Пароль к почтовому ящику пользователя
• $param['delete'] bool Флаг, удалять ли письма после просмотра
• $param['secury'] bool Флаг, является ли подключение безопасным

Возвращает

Массив писем

[ Наверх ]




Mail::HeaderDecode

HeaderDecode( str $str, [str $code = ''] );

Описание

Перекодировщик из кодировки письма в кодировку системы

Принимаемые параметры

$str

Закодированная строка

$code

Тип кодировки

[ Наверх ]




Mail::IconvText

IconvText( str $text, str $code );

Описание

Перекодирование текста из кодировки письма в кодировку системы

Принимаемые параметры

$text

Текст

$code

Исходная кодировка

[ Наверх ]




Mail::IsBase64Encoded

IsBase64Encoded( $string $string );

Описание

Проверка строки на то, является ли она закодированной base64

Принимаемые параметры

$string

строка

[ Наверх ]




Mail::ParseHeaderAndBody

ParseHeaderAndBody( str $body_letter, str $bound, array $part_structure );

Описание

Разбор тела сообщения

Принимаемые параметры

$body_letter

Тело сообщения

$bound

Разделитель между частями сообщения

$part_structure

Структура сообщения

Возвращает

Массив с заголовками и телом частей сообщения

[ Наверх ]




Mail::ParseMessage

ParseMessage( int $i, str $body_letter, str $bound, [ $is_first = 0] );

Описание

Разбор сообщения по частям

Принимаемые параметры

$i

Порядковый номер письма в ящике

$body_letter

Тело сообщения

$bound

Разделитель между различными частями тела сообщения

$is_first

[ Наверх ]




Mail::SaveHeaders

SaveHeaders( $headers, $code, array $header );

Описание

Сохранение заголовков письма

Принимаемые параметры

$header

Объект, или массив заголовков

$headers

$code

Возвращает

Строка заголовков

[ Наверх ]




Mail::SaveStructure

SaveStructure( array $part_structure );

Описание

Сохранение структуры сообщения

Принимаемые параметры

$part_structure

Массив со структурой

[ Наверх ]




Mail::StructureToArray

StructureToArray( array $structure );

Описание

Разбор структуры сообщения и сохранение результата в массив

Принимаемые параметры

$structure

Массив со структурой сообщения

[ Наверх ]

---

Описания переменных

• $email_login =  'hostcms-test' [Строка 42]
• Data type: str

Описание

Имя ящика (Логин)



• $email_password =  '346500' [Строка 49]
• Data type: str

Описание

Пароль ящика пользователя



• $headers_string =  '' [Строка 77]
• Data type: str

Описание

Заголовки письма



• $host =  'pop.yandex.ru' [Строка 21]
• Data type: str

Описание

Имя хоста



• $letters = array() [Строка 70]
• Data type: array

Описание

Массив, содержащий письма



• $mail_box =  '' [Строка 63]
• Data type: str

Описание

Почтовый ящик, к которому выполняется доступ



• $port =  110 [Строка 35]
• Data type: int

Описание

Порт



• $protocol =  'email_imap' [Строка 28]
• Data type: str

Описание

Протокол соединения



• $stream =  '' [Строка 56]
• Data type: int

Описание

Идентификатор открытого соединения с почтовым сервером

---

Описание констант класса

---