Класс 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 строка 12

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

__construct()

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

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

__destruct()

__destruct

(

)

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

Методы

addMessage()

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

Adds message

Аргументы

string	$mailbox	Mailbox name.
string	$data	Message.
string	&$error	Error message.

Возвращает

string|false

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

append()

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

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

authenticate()

authenticate

(

&

$error

)

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

capability()

capability ( & $error )

protected

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

connect()

connect

(

&

$error

)

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

copyMailToFolder()

copyMailToFolder	(		$ids,
			$mailboxName,
			$folder )

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

decodeError()

decodeError ( $code )

static

Returns error message

Аргументы

int

$code

Error code.

Возвращает

string

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

decodeUtf7Imap()

decodeUtf7Imap ( $data )

protected

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

delete()

delete	(		$id,
			$mailboxName )

Аргументы

$id
$mailboxName

Возвращает

Main\Result

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

disconnect()

disconnect ( )

protected

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

encodeUtf7Imap()

encodeUtf7Imap ( $data )

protected

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

ensureEmpty()

ensureEmpty	(		$mailbox,
		&	$error )

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

errorMessage()

errorMessage ( $errors, $details = null )

protected

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

escapeQuoted()

escapeQuoted ( $data )

staticprotected

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

examine()

examine	(		$mailbox,
		&	$error )

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

exchange()

exchange ( $data, & $error )

protected

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

executeCommand()

executeCommand ( $command, & $error )

protected

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

fetch()

fetch	(		$uid,
			$mailbox,
			$range,
			$select,
		&	$error,
			$outputFormat = 'smart' )

Аргументы

	$uid
	$mailbox
	$range
	$select
	$error
string	$outputFormat	'smart' or 'list'

Возвращает

array|false|mixed

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

getErrors()

getErrors

(

)

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

getMessage()

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

Returns message

Аргументы

string	$mailbox	Mailbox name.
int	$id	Message ID.
string	$section	Message section.
string	&$error	Error message.

Возвращает

string|false

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

getNew()

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

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

getState()

getState

(

)

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

getTag()

getTag ( $next = false )

protected

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

getUidRange()

getUidRange	(		$mailbox,
		&	$error )

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

getUIDsForSpecificDay()

getUIDsForSpecificDay	(		$dirPath,
			$internalDate )

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

getUnseen()

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

Returns unseen messages count

Аргументы

string	$dirPath	dir path.
string	&$error	Error message.
string	null,$startInternalDate	start internal date for count.

Возвращает

int|false

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

getUntagged()

getUntagged ( $regex, $unset = false )

protected

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

isExistsDir()

isExistsDir	(		$mailbox,
		&	$error )

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

listex()

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

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

listMailboxes()

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

Returns mailboxes list

Аргументы

string	$pattern	Mailbox name pattern.
string	&$error	Error message.

Возвращает

array|false

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

listMessages()

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

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

move()

move	(		$ids,
			$folderFrom,
			$folderTo )

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

moveMails()

moveMails	(		$ids,
			$folderFrom,
			$folderTo )

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

prepareString()

prepareString ( $data )

staticprotected

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

readBytes()

readBytes ( $bytes )

protected

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

readLine()

readLine ( )

protected

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

readResponse()

readResponse ( )

protected

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

reset()

reset ( )

protected

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

searchByHeader()

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

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

seen()

seen	(		$ids,
			$folder )

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

select()

select	(		$mailbox,
		&	$error )

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

sendData()

sendData ( $data )

protected

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

singin()

singin

(

&

$error

)

Connects to server and authenticate client

Аргументы

string

&$error

Error message.

Возвращает

boolean

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

starttls()

starttls ( & $error )

protected

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

unescapeQuoted()

unescapeQuoted ( $data )

staticprotected

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

unseen()

unseen	(		$ids,
			$folder )

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

updateMessageFlags()

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

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

writeToLog()

writeToLog ( $data )

protected

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

Поля

$astringRegex

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

staticprotected

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

$atomRegex

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

staticprotected

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

$errors

$errors

protected

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

$logLevel

$logLevel = 0

protected

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

$logPath

$logPath

protected

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

$options

$options = array()

protected

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

$qcharExtRegex

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

staticprotected

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

$qcharRegex

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

staticprotected

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

$sessCapability

$sessCapability

protected

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

$sessCounter

$sessCounter

protected

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

$sessMailbox

$sessMailbox

protected

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

$sessState

$sessState

protected

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

$sessUntagged

$sessUntagged

protected

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

$stream

$stream

protected

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

ERR_APPEND

const ERR_APPEND = 211

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

ERR_AUTH

const ERR_AUTH = 204

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

ERR_AUTH_MECH

const ERR_AUTH_MECH = 205

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

ERR_AUTH_OAUTH

const ERR_AUTH_OAUTH = 206

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

ERR_BAD_SERVER

const ERR_BAD_SERVER = 105

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

ERR_CAPABILITY

const ERR_CAPABILITY = 203

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

ERR_COMMAND_REJECTED

const ERR_COMMAND_REJECTED = 202

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

ERR_COMMUNICATE

const ERR_COMMUNICATE = 103

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

ERR_CONNECT

const ERR_CONNECT = 101

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

ERR_EMPTY_RESPONSE

const ERR_EMPTY_RESPONSE = 104

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

ERR_FETCH

const ERR_FETCH = 210

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

ERR_LIST

const ERR_LIST = 207

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

ERR_REJECTED

const ERR_REJECTED = 102

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

ERR_SEARCH

const ERR_SEARCH = 209

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

ERR_SELECT

const ERR_SELECT = 208

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

ERR_STARTTLS

const ERR_STARTTLS = 201

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

ERR_STORE

const ERR_STORE = 212

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

LOG_LEVEL_READ

const LOG_LEVEL_READ = 2

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

LOG_LEVEL_WRITE

const LOG_LEVEL_WRITE = 1

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

---

Объявления и описания членов класса находятся в файле:

• C:/bitrix/modules/mail/lib/imap.php