Bitrix-D7 23.9
 
Загрузка...
Поиск...
Не найдено
Класс Imap

Открытые члены

 __construct ($host, $port, $tls, $strict, $login, $password, $encoding=null)
 
 __destruct ()
 
 getState ()
 
 connect (&$error)
 
 authenticate (&$error)
 
 select ($mailbox, &$error)
 
 examine ($mailbox, &$error)
 
 singin (&$error)
 
 fetch ($uid, $mailbox, $range, $select, &$error, $outputFormat='smart')
 
 getUIDsForSpecificDay ($dirPath, $internalDate)
 
 getUnseen ($dirPath, &$error, $startInternalDate=null)
 
 getNew ($mailbox, $uidMin, $uidMax, &$error)
 
 getUidRange ($mailbox, &$error)
 
 listex ($reference, $pattern, &$error)
 
 listMailboxes ($pattern, &$error, $flat=false)
 
 listMessages ($mailbox, &$uidtoken, &$error)
 
 addMessage ($mailbox, $data, &$error)
 
 searchByHeader ($uid, $mailbox, array $header, &$error)
 
 append ($mailbox, array $flags, \DateTime $internaldate, $data, &$error)
 
 moveMails ($ids, $folderFrom, $folderTo)
 
 move ($ids, $folderFrom, $folderTo)
 
 copyMailToFolder ($ids, $mailboxName, $folder)
 
 unseen ($ids, $folder)
 
 seen ($ids, $folder)
 
 delete ($id, $mailboxName)
 
 updateMessageFlags ($mailbox, $id, $flags, &$error)
 
 getMessage ($mailbox, $id, $section, &$error)
 
 isExistsDir ($mailbox, &$error)
 
 ensureEmpty ($mailbox, &$error)
 
 getErrors ()
 

Открытые статические члены

static decodeError ($code)
 

Открытые атрибуты

const LOG_LEVEL_WRITE = 1
 
const LOG_LEVEL_READ = 2
 
const ERR_CONNECT = 101
 
const ERR_REJECTED = 102
 
const ERR_COMMUNICATE = 103
 
const ERR_EMPTY_RESPONSE = 104
 
const ERR_BAD_SERVER = 105
 
const ERR_STARTTLS = 201
 
const ERR_COMMAND_REJECTED = 202
 
const ERR_CAPABILITY = 203
 
const ERR_AUTH = 204
 
const ERR_AUTH_MECH = 205
 
const ERR_AUTH_OAUTH = 206
 
const ERR_LIST = 207
 
const ERR_SELECT = 208
 
const ERR_SEARCH = 209
 
const ERR_FETCH = 210
 
const ERR_APPEND = 211
 
const ERR_STORE = 212
 

Защищенные члены

 disconnect ()
 
 reset ()
 
 starttls (&$error)
 
 capability (&$error)
 
 getUntagged ($regex, $unset=false)
 
 getTag ($next=false)
 
 executeCommand ($command, &$error)
 
 exchange ($data, &$error)
 
 sendData ($data)
 
 readBytes ($bytes)
 
 readLine ()
 
 readResponse ()
 
 encodeUtf7Imap ($data)
 
 decodeUtf7Imap ($data)
 
 errorMessage ($errors, $details=null)
 
 writeToLog ($data)
 

Защищенные статические члены

static prepareString ($data)
 
static escapeQuoted ($data)
 
static unescapeQuoted ($data)
 

Защищенные данные

 $stream
 
 $errors
 
 $sessState
 
 $sessCapability
 
 $sessCounter
 
 $sessUntagged
 
 $sessMailbox
 
 $logLevel = 0
 
 $logPath
 
 $options = array()
 

Статические защищенные данные

static $atomRegex = '[^\x00-\x20\x22\x25\x28-\x2a\x5c\x5d\x7b\x7f-\xff]+'
 
static $qcharRegex = '[^\x00\x0a\x0d\x22\x5c\x80-\xff]|\x5c[\x5c\x22]'
 
static $qcharExtRegex = '[^\x00\x0a\x0d\x22\x5c]|\x5c[\x5c\x22]'
 
static $astringRegex = '[^\x00-\x20\x22\x25\x28-\x2a\x5c\x7b\x7f-\xff]+'
 

Подробное описание

См. определение в файле imap.php строка 13

Конструктор(ы)

◆ __construct()

__construct ( $host,
$port,
$tls,
$strict,
$login,
$password,
$encoding = null )

См. определение в файле imap.php строка 48

◆ __destruct()

__destruct ( )

См. определение в файле imap.php строка 83

Методы

◆ addMessage()

addMessage ( $mailbox,
$data,
& $error )

Adds message

Аргументы
string$mailboxMailbox name.
string$dataMessage.
string&$errorError message.
Возвращает
string|false

См. определение в файле imap.php строка 1191

◆ append()

append ( $mailbox,
array $flags,
\DateTime $internaldate,
$data,
& $error )

См. определение в файле imap.php строка 1253

◆ authenticate()

authenticate ( & $error)

См. определение в файле imap.php строка 242

◆ capability()

capability ( & $error)
protected

См. определение в файле imap.php строка 215

◆ connect()

connect ( & $error)

См. определение в файле imap.php строка 119

◆ copyMailToFolder()

copyMailToFolder ( $ids,
$mailboxName,
$folder )

См. определение в файле imap.php строка 1343

◆ decodeError()

static decodeError ( $code)
static

Returns error message

Аргументы
int$codeError code.
Возвращает
string

См. определение в файле imap.php строка 2011

◆ decodeUtf7Imap()

decodeUtf7Imap ( $data)
protected

См. определение в файле imap.php строка 1933

◆ delete()

delete ( $id,
$mailboxName )
Аргументы
$id
$mailboxName
Возвращает
Main\Result

См. определение в файле imap.php строка 1417

◆ disconnect()

disconnect ( )
protected

См. определение в файле imap.php строка 88

◆ encodeUtf7Imap()

encodeUtf7Imap ( $data)
protected

См. определение в файле imap.php строка 1902

◆ ensureEmpty()

ensureEmpty ( $mailbox,
& $error )

См. определение в файле imap.php строка 1573

◆ errorMessage()

errorMessage ( $errors,
$details = null )
protected

См. определение в файле imap.php строка 1974

◆ escapeQuoted()

static escapeQuoted ( $data)
staticprotected

См. определение в файле imap.php строка 1892

◆ examine()

examine ( $mailbox,
& $error )

См. определение в файле imap.php строка 396

◆ exchange()

exchange ( $data,
& $error )
protected

См. определение в файле imap.php строка 1706

◆ executeCommand()

executeCommand ( $command,
& $error )
protected

См. определение в файле imap.php строка 1685

◆ fetch()

fetch ( $uid,
$mailbox,
$range,
$select,
& $error,
$outputFormat = 'smart' )
Аргументы
$uid
$mailbox
$range
$select
$error
string$outputFormat'smart' or 'list'
Возвращает
array|false|mixed

См. определение в файле imap.php строка 459

◆ getErrors()

getErrors ( )

См. определение в файле imap.php строка 2000

◆ getMessage()

getMessage ( $mailbox,
$id,
$section,
& $error )

Returns message

Аргументы
string$mailboxMailbox name.
int$idMessage ID.
string$sectionMessage section.
string&$errorError message.
Возвращает
string|false

См. определение в файле imap.php строка 1538

◆ getNew()

getNew ( $mailbox,
$uidMin,
$uidMax,
& $error )

См. определение в файле imap.php строка 765

◆ getState()

getState ( )

См. определение в файле imap.php строка 114

◆ getTag()

getTag ( $next = false)
protected

См. определение в файле imap.php строка 1677

◆ getUidRange()

getUidRange ( $mailbox,
& $error )

См. определение в файле imap.php строка 834

◆ getUIDsForSpecificDay()

getUIDsForSpecificDay ( $dirPath,
$internalDate )

См. определение в файле imap.php строка 678

◆ getUnseen()

getUnseen ( $dirPath,
& $error,
$startInternalDate = null )

Returns unseen messages count

Аргументы
string$dirPathdir path.
string&$errorError message.
stringnull,$startInternalDatestart internal date for count.
Возвращает
int|false

См. определение в файле imap.php строка 724

◆ getUntagged()

getUntagged ( $regex,
$unset = false )
protected

См. определение в файле imap.php строка 1654

◆ isExistsDir()

isExistsDir ( $mailbox,
& $error )

См. определение в файле imap.php строка 1559

◆ listex()

listex ( $reference,
$pattern,
& $error )

См. определение в файле imap.php строка 861

◆ listMailboxes()

listMailboxes ( $pattern,
& $error,
$flat = false )

Returns mailboxes list

Аргументы
string$patternMailbox name pattern.
string&$errorError message.
Возвращает
array|false

См. определение в файле imap.php строка 940

◆ listMessages()

listMessages ( $mailbox,
& $uidtoken,
& $error )

См. определение в файле imap.php строка 1104

◆ move()

move ( $ids,
$folderFrom,
$folderTo )

См. определение в файле imap.php строка 1320

◆ moveMails()

moveMails ( $ids,
$folderFrom,
$folderTo )

См. определение в файле imap.php строка 1295

◆ prepareString()

static prepareString ( $data)
staticprotected

См. определение в файле imap.php строка 1884

◆ readBytes()

readBytes ( $bytes)
protected

См. определение в файле imap.php строка 1779

◆ readLine()

readLine ( )
protected

См. определение в файле imap.php строка 1809

◆ readResponse()

readResponse ( )
protected

См. определение в файле imap.php строка 1859

◆ reset()

reset ( )
protected

См. определение в файле imap.php строка 97

◆ searchByHeader()

searchByHeader ( $uid,
$mailbox,
array $header,
& $error )

См. определение в файле imap.php строка 1198

◆ seen()

seen ( $ids,
$folder )

См. определение в файле imap.php строка 1389

◆ select()

select ( $mailbox,
& $error )

См. определение в файле imap.php строка 345

◆ sendData()

sendData ( $data)
protected

См. определение в файле imap.php строка 1737

◆ singin()

singin ( & $error)

Connects to server and authenticate client

Аргументы
string&$errorError message.
Возвращает
boolean

См. определение в файле imap.php строка 443

◆ starttls()

starttls ( & $error)
protected

См. определение в файле imap.php строка 177

◆ unescapeQuoted()

static unescapeQuoted ( $data)
staticprotected

См. определение в файле imap.php строка 1897

◆ unseen()

unseen ( $ids,
$folder )

См. определение в файле imap.php строка 1366

◆ updateMessageFlags()

updateMessageFlags ( $mailbox,
$id,
$flags,
& $error )

См. определение в файле imap.php строка 1479

◆ writeToLog()

writeToLog ( $data)
protected

См. определение в файле imap.php строка 2054

Данные класса

◆ $astringRegex

$astringRegex = '[^\x00-\x20\x22\x25\x28-\x2a\x5c\x7b\x7f-\xff]+'
staticprotected

См. определение в файле imap.php строка 46

◆ $atomRegex

$atomRegex = '[^\x00-\x20\x22\x25\x28-\x2a\x5c\x5d\x7b\x7f-\xff]+'
staticprotected

См. определение в файле imap.php строка 43

◆ $errors

$errors
protected

См. определение в файле imap.php строка 37

◆ $logLevel

$logLevel = 0
protected

См. определение в файле imap.php строка 39

◆ $logPath

$logPath
protected

См. определение в файле imap.php строка 39

◆ $options

$options = array()
protected

См. определение в файле imap.php строка 41

◆ $qcharExtRegex

$qcharExtRegex = '[^\x00\x0a\x0d\x22\x5c]|\x5c[\x5c\x22]'
staticprotected

См. определение в файле imap.php строка 45

◆ $qcharRegex

$qcharRegex = '[^\x00\x0a\x0d\x22\x5c\x80-\xff]|\x5c[\x5c\x22]'
staticprotected

См. определение в файле imap.php строка 44

◆ $sessCapability

$sessCapability
protected

См. определение в файле imap.php строка 38

◆ $sessCounter

$sessCounter
protected

См. определение в файле imap.php строка 38

◆ $sessMailbox

$sessMailbox
protected

См. определение в файле imap.php строка 38

◆ $sessState

$sessState
protected

См. определение в файле imap.php строка 38

◆ $sessUntagged

$sessUntagged
protected

См. определение в файле imap.php строка 38

◆ $stream

$stream
protected

См. определение в файле imap.php строка 37

◆ ERR_APPEND

const ERR_APPEND = 211

См. определение в файле imap.php строка 34

◆ ERR_AUTH

const ERR_AUTH = 204

См. определение в файле imap.php строка 27

◆ ERR_AUTH_MECH

const ERR_AUTH_MECH = 205

См. определение в файле imap.php строка 28

◆ ERR_AUTH_OAUTH

const ERR_AUTH_OAUTH = 206

См. определение в файле imap.php строка 29

◆ ERR_BAD_SERVER

const ERR_BAD_SERVER = 105

См. определение в файле imap.php строка 22

◆ ERR_CAPABILITY

const ERR_CAPABILITY = 203

См. определение в файле imap.php строка 26

◆ ERR_COMMAND_REJECTED

const ERR_COMMAND_REJECTED = 202

См. определение в файле imap.php строка 25

◆ ERR_COMMUNICATE

const ERR_COMMUNICATE = 103

См. определение в файле imap.php строка 20

◆ ERR_CONNECT

const ERR_CONNECT = 101

См. определение в файле imap.php строка 18

◆ ERR_EMPTY_RESPONSE

const ERR_EMPTY_RESPONSE = 104

См. определение в файле imap.php строка 21

◆ ERR_FETCH

const ERR_FETCH = 210

См. определение в файле imap.php строка 33

◆ ERR_LIST

const ERR_LIST = 207

См. определение в файле imap.php строка 30

◆ ERR_REJECTED

const ERR_REJECTED = 102

См. определение в файле imap.php строка 19

◆ ERR_SEARCH

const ERR_SEARCH = 209

См. определение в файле imap.php строка 32

◆ ERR_SELECT

const ERR_SELECT = 208

См. определение в файле imap.php строка 31

◆ ERR_STARTTLS

const ERR_STARTTLS = 201

См. определение в файле imap.php строка 24

◆ ERR_STORE

const ERR_STORE = 212

См. определение в файле imap.php строка 35

◆ LOG_LEVEL_READ

const LOG_LEVEL_READ = 2

См. определение в файле imap.php строка 16

◆ LOG_LEVEL_WRITE

const LOG_LEVEL_WRITE = 1

См. определение в файле imap.php строка 15