Documentation

Core_Mail_Imap extends Core_Servant_Properties
in package

IMAP, POP3 and NNTP http://php.net/manual/en/book.imap.php

Доступные методы:

  • offset(0) смещение, по умолчанию 0
  • limit(50) ограничение на количество получаемых писем, по умолчанию 50
  • server($str) сервер для соединения (IMAP, POP3)
  • port($int) порт для соединения, может быть также указан у server через двоеточие, либо получен в зависимости от типа (110, 143) и ssl (995, 993)
  • type('imap'|'pop3') тип соединения
  • login($str) логин для соединения
  • password($str) пароль для соединения
  • search($str) строка поиска для imap_search(), если не указана, то в зависимости от опции delete значение будет 'ALL' или 'UNSEEN'
  • folder($str) папка для поиска, по умолчанию INBOX
  • move($str) папка для перемещения, например Trash
  • validateCert(TRUE|FALSE) проверять сертификаты серверов TLS/SSL, по умолчанию FALSE
  • ssl(TRUE|FALSE) использовать SSL для шифрования сессии
  • tls(TRUE|FALSE) принудительно использовать start-TLS для шифрования сессии и отвергать соединения с серверами его не поддерживающими
  • notls(TRUE|FALSE) не применять start-TLS для шифрования сессии, даже если сервер его поддерживает
  • delete(TRUE|FALSE) удалять сообщения после получения, по умолчанияю FALSE
Tags
subpackage

Core\Mail

version
7.x
author

Hostmake LLC

copyright

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

Table of Contents

Properties

$_aErrors  : array<string|int, mixed>
List of errors
$_allowedProperties  : array<string|int, mixed>
Allowed object properties
$_aMessages  : array<string|int, mixed>
Массив, содержащий письма
$_headers  : str
Заголовки письма
$_propertiesValues  : array<string|int, mixed>
Properties values
$_protocol  : string
Протокол соединения
$_stream  : Connection
IMAP stream
$_unlimitedProperties  : bool
Object has unlimited number of properties

Methods

__construct()  : mixed
Create an instance of the object
addAllowedProperties()  : self
Add additional allowed properties
addAllowedProperty()  : self
Add additional allowed property
execute()  : mixed
Executes the business logic.
getErrors()  : array<string|int, mixed>
Get errors
getLastError()  : mixed
Get last error
getMessages()  : array<string|int, mixed>
Get messages
set()  : self
Run when writing data to inaccessible properties
setUnlimitedProperties()  : self
Set unlimitedProperties
_bodyDecode()  : string
Перекодировщик тела письма
_deleteMessages()  : self
Удаление полученных писем из почтового ящика
_headerDecode()  : str
Перекодировщик из кодировки письма в кодировку системы
_iconv()  : string
Перекодирование текста из кодировки письма в кодировку системы
_isBase64()  : bool
Проверка строки на то, является ли она закодированной base64
_parseMessage()  : mixed
Разбор сообщения по частям
_saveHeaders()  : string
Сохранение заголовков письма
_saveStructure()  : str
Сохранение структуры сообщения
_structure2array()  : array<string|int, mixed>
Разбор структуры сообщения и сохранение результата в массив

Properties

$_aErrors

List of errors

protected array<string|int, mixed> $_aErrors = array()

$_allowedProperties

Allowed object properties

protected array<string|int, mixed> $_allowedProperties = array('offset', 'limit', 'server', 'port', 'type', 'login', 'password', 'search', 'folder', 'move', 'validateCert', 'ssl', 'tls', 'notls', 'delete')

$_aMessages

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

protected array<string|int, mixed> $_aMessages = array()

$_headers

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

protected str $_headers = ''

$_propertiesValues

Properties values

protected array<string|int, mixed> $_propertiesValues = array()

$_protocol

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

protected string $_protocol = \NULL

$_stream

IMAP stream

protected Connection $_stream = \NULL

$_unlimitedProperties

Object has unlimited number of properties

protected bool $_unlimitedProperties = \FALSE

Methods

__construct()

Create an instance of the object

public __construct() : mixed

addAllowedProperties()

Add additional allowed properties

public addAllowedProperties(array<string|int, mixed> $array) : self
Parameters
$array : array<string|int, mixed>

array of properties' names

Return values
self

addAllowedProperty()

Add additional allowed property

public addAllowedProperty(string $property) : self
Parameters
$property : string

property name

Return values
self

execute()

Executes the business logic.

public execute() : mixed

getErrors()

Get errors

public getErrors() : array<string|int, mixed>
Return values
array<string|int, mixed>

getLastError()

Get last error

public getLastError() : mixed

getMessages()

Get messages

public getMessages() : array<string|int, mixed>
Return values
array<string|int, mixed>

set()

Run when writing data to inaccessible properties

public set(string $property, string $value) : self
Parameters
$property : string

property name

$value : string

property value

Return values
self

setUnlimitedProperties()

Set unlimitedProperties

public setUnlimitedProperties([bool $value = TRUE ]) : self
Parameters
$value : bool = TRUE

default TRUR

Return values
self

_bodyDecode()

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

protected _bodyDecode(string $text[, int $encoding = 0 ]) : string
Parameters
$text : string

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

$encoding : int = 0

Кодировка: 0 - 7bit, 1 - 8bit, 2 - Binary, 3 - Base64, 4 - Quoted-Printable, 5 - other

Return values
string —

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

_deleteMessages()

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

protected _deleteMessages(Connection $stream) : self
Parameters
$stream : Connection

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

Return values
self

_headerDecode()

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

protected _headerDecode(string $str[, string $code = '' ]) : str
Parameters
$str : string

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

$code : string = ''

Кодировка

Return values
str

_iconv()

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

protected _iconv(string $text, string $sourceCode) : string
Parameters
$text : string

Текст

$sourceCode : string

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

Return values
string

_isBase64()

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

protected _isBase64( $string) : bool
Parameters
$string :

строка

Return values
bool

_parseMessage()

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

protected _parseMessage(int $i) : mixed
Parameters
$i : int

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

_saveHeaders()

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

protected _saveHeaders(array<string|int, mixed> $headers, string $code) : string
Parameters
$headers : array<string|int, mixed>

Массив заголовков

$code : string

Кодировка

Return values
string —

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

_saveStructure()

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

protected _saveStructure(array<string|int, mixed> $aStructureParts) : str
Parameters
$aStructureParts : array<string|int, mixed>

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

Return values
str

_structure2array()

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

protected _structure2array(mixed $structure) : array<string|int, mixed>
Parameters
$structure : mixed

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

Return values
array<string|int, mixed> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results