Граф наследования:Mailbox:

Открытые члены
	getDirsMd5WithCounter ($mailboxId)
	sendCountersEvent ()
	getDirsWithUnseenMailCounters ()
	setSyncParams (array $params=array())
	getMailbox ()
	getMailboxId ()
	getMailboxOwnerId ()
	setCheckpoint ()
	updateGlobalCounter ($userId)
	updateGlobalCounterForCurrentUser ()
	reSyncStartPage ()
	restoringConsistency ()
	syncCounters ()
	sync ($syncCounters=true)
	getSyncStatus ()
	dismissOldMessages ()
	dismissDeletedUidMessages ()
	cleanup ()
	mail (array $params)
	syncOutgoing ()
	resyncMessage (array &$excerpt)
	downloadAttachments (array &$excerpt)
	isSupportLazyAttachments ()
	getFilters ($force=false)
	resortTree ($message=null)
	incrementTree ($message)
	checkMessagesForExistence ($dirPath='INBOX', $UIDs=[])
	resyncIsOldStatus ()
	syncFirstDay ()
	listDirs ($pattern, $useDb=false)
	uploadMessage (Main\Mail\Mail $message, array &$excerpt)
	downloadMessage (array &$excerpt)
	syncMessages ($mailboxID, $dirPath, $UIDs)
	isAuthenticated ()
	getErrors ()
	getWarnings ()
	getLastSyncResult ()
	getDirsHelper ()
	activateSync ()
	notifyNewMessages ()
	isSupportSanitizeOnView ()

Открытые статические члены
static	isRuZone ()
static	getServices ()
static	createInstance ($id, $throw=true)
static	rawInstance ($filter, $throw=true)
static	prepareMailbox ($filter)
static	getTimeout ()
static	getForUserByEmail ($email)
static	findBy ($id, $email)

Поля данных
const	SYNC_TIMEOUT = 300
const	SYNC_TIME_QUOTA = 280
const	MESSAGE_RESYNCHRONIZATION_TIME = 360
const	INCOMPLETE_MESSAGE_REMOVE_TIMEOUT = 600
const	MESSAGE_DELETION_LIMIT_AT_A_TIME = 500
const	MESSAGE_SET_OLD_STATUS_LIMIT_AT_A_TIME = 500
const	NUMBER_OF_BROKEN_MESSAGES_TO_RESYNCHRONIZE = 2
const	NUMBER_OF_INCOMPLETE_MESSAGES_TO_REMOVE = 10
const	MAIL_SERVICES_ONLY_FOR_THE_RU_ZONE

Защищенные члены
	__construct ($mailbox)
	normalizeMailboxOptions ()
	isTimeQuotaExceeded ()
	pushSyncStatus ($params, $force=false)
	listMessages ($params=array(), $fetch=true)
	findMessageInUploadQueue ( $idFromHeaderMessage,)
	registerMessage (&$fields, $replaces=null, $isOutgoing=false, string $idFromHeaderMessage='', $redefineInsertDate=true, string $messageStatus=\Bitrix\Mail\MailMessageUidTable::DOWNLOADED)
	updateMessagesRegistry (array $filter, array $fields, $mailData=array())
	unregisterMessages ($filter, $eventData=[], $ignoreDeletionCheck=false)
	linkMessage ($uid, $id)
	cacheMessage (&$body, $params=array())
	createMessage (Main\Mail\Mail $message, array $fields=array())
	syncOutgoingMessage ($excerpt)
	syncInternal ()
	setLastSyncResult (array $data)

Защищенные статические члены
static	instance (array $mailbox)

Защищенные данные
	$dirsMd5WithCounter
	$mailbox
	$dirsHelper
	$filters
	$session
	$startTime
	$syncTimeout
	$checkpoint
	$syncParams = []
	$errors
	$warnings
	$lastSyncResult

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

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

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

◆ __construct()

__construct ( $mailbox )

protected

Переопределяется в Imap.

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

Методы

◆ activateSync()

activateSync ( )

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

◆ cacheMessage()

cacheMessage	(	&	$body,
			$params = array() )

protected

Переопределяется в Imap.

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

◆ checkMessagesForExistence()

checkMessagesForExistence	(		$dirPath = 'INBOX',
			$UIDs = [] )

abstract

Переопределяется в Imap.

◆ cleanup()

cleanup ( )

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

◆ createInstance()

createInstance	(		$id,
			$throw = true )

static

Creates active mailbox helper instance by ID

Аргументы

int	$id	Mailbox ID.
bool	$throw	Throw exception on error.

Возвращает: \Bitrix\Mail\Helper\Mailbox|false

Исключения

Exception

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

◆ createMessage()

createMessage	(	Main\Mail\Mail	$message,
		array	$fields = array() )

protected

Переопределяется в Imap.

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

◆ dismissDeletedUidMessages()

dismissDeletedUidMessages ( )

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

◆ dismissOldMessages()

dismissOldMessages ( )

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

◆ downloadAttachments()

downloadAttachments ( array & $excerpt )

Переопределяется в Imap.

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

◆ downloadMessage()

downloadMessage ( array & $excerpt )

abstract

Переопределяется в Imap.

◆ findBy()

findBy	(		$id,
			$email )

staticfinal

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

◆ findMessageInUploadQueue()

findMessageInUploadQueue ( $idFromHeaderMessage )

protected

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

◆ getDirsHelper()

getDirsHelper ( )

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

◆ getDirsMd5WithCounter()

getDirsMd5WithCounter ( $mailboxId )

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

◆ getDirsWithUnseenMailCounters()

getDirsWithUnseenMailCounters ( )

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

◆ getErrors()

getErrors ( )

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

◆ getFilters()

getFilters ( $force = false )

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

◆ getForUserByEmail()

getForUserByEmail ( $email )

staticfinal

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

◆ getLastSyncResult()

getLastSyncResult ( )

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

◆ getMailbox()

getMailbox ( )

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

◆ getMailboxId()

getMailboxId ( )

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

◆ getMailboxOwnerId()

getMailboxOwnerId ( )

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

◆ getServices()

getServices ( )

static

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

◆ getSyncStatus()

getSyncStatus ( )

Переопределяется в Imap.

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

◆ getTimeout()

getTimeout ( )

staticfinal

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

◆ getWarnings()

getWarnings ( )

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

◆ incrementTree()

incrementTree ( $message )

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

◆ instance()

instance ( array $mailbox )

staticprotected

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

◆ isAuthenticated()

isAuthenticated ( )

abstract

◆ isRuZone()

isRuZone ( )

static

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

◆ isSupportLazyAttachments()

isSupportLazyAttachments ( )

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

◆ isSupportSanitizeOnView()

isSupportSanitizeOnView ( )

Could we sanitize message on view? if there is no filters that can use sanitized body

Возвращает: bool

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

◆ isTimeQuotaExceeded()

isTimeQuotaExceeded ( )

protected

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

◆ linkMessage()

linkMessage	(		$uid,
			$id )

protected

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

◆ listDirs()

listDirs	(		$pattern,
			$useDb = false )

abstract

Переопределяется в Imap.

◆ listMessages()

listMessages	(		$params = array(),
			$fetch = true )

protected

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

◆ mail()

mail ( array $params )

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

◆ normalizeMailboxOptions()

normalizeMailboxOptions ( )

protected

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

◆ notifyNewMessages()

notifyNewMessages ( )

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

◆ prepareMailbox()

prepareMailbox ( $filter )

static

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

◆ pushSyncStatus()

pushSyncStatus	(		$params,
			$force = false )

protected

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

◆ rawInstance()

rawInstance	(		$filter,
			$throw = true )

static

Creates mailbox helper instance

Аргументы

mixed	$filter	Filter.
bool	$throw	Throw exception on error.

Возвращает: \Bitrix\Mail\Helper\Mailbox|false

Исключения

Exception

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

◆ registerMessage()

registerMessage	(	&	$fields,
			$replaces = null,
			$isOutgoing = false,
		string	$idFromHeaderMessage = '',
			$redefineInsertDate = true,
		string	$messageStatus = \Bitrix\Mail\MailMessageUidTable::DOWNLOADED )

protected

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

◆ resortTree()

resortTree ( $message = null )

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

◆ restoringConsistency()

restoringConsistency ( )

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

◆ resyncIsOldStatus()

resyncIsOldStatus ( )

abstract

Переопределяется в Imap.

◆ resyncMessage()

resyncMessage ( array & $excerpt )

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

◆ reSyncStartPage()

reSyncStartPage ( )

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

◆ sendCountersEvent()

sendCountersEvent ( )

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

◆ setCheckpoint()

setCheckpoint ( )

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

◆ setLastSyncResult()

setLastSyncResult ( array $data )

protected

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

◆ setSyncParams()

setSyncParams ( array $params = array() )

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

◆ sync()

sync ( $syncCounters = true )

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

◆ syncCounters()

syncCounters ( )

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

◆ syncFirstDay()

syncFirstDay ( )

abstract

Переопределяется в Imap.

◆ syncInternal()

syncInternal ( )

abstractprotected

Переопределяется в Imap.

◆ syncMessages()

syncMessages	(	$mailboxID,
		$dirPath,
		$UIDs )

abstract

◆ syncOutgoing()

syncOutgoing ( )

Переопределяется в Imap.

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

◆ syncOutgoingMessage()

syncOutgoingMessage ( $excerpt )

protected

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

◆ unregisterMessages()

unregisterMessages	(	$filter,
		$eventData = [],
		$ignoreDeletionCheck = false )

protected

@TODO Enable logs by option on the portal. AddMessage2Log(array_merge($eventData,[ 'filter' => $filterForCheck, 'message-data' => $messageForLog, ]));

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

◆ updateGlobalCounter()

updateGlobalCounter ( $userId )

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

◆ updateGlobalCounterForCurrentUser()

updateGlobalCounterForCurrentUser ( )

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

◆ updateMessagesRegistry()

updateMessagesRegistry	(	array	$filter,
		array	$fields,
			$mailData = array() )

protected

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

◆ uploadMessage()

uploadMessage	(	Main\Mail\Mail	$message,
		array &	$excerpt )

abstract

Переопределяется в Imap.

Поля

◆ $checkpoint

$checkpoint

protected

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

◆ $dirsHelper

$dirsHelper

protected

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

◆ $dirsMd5WithCounter

$dirsMd5WithCounter

protected

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

◆ $errors

$errors

protected

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

◆ $filters

$filters

protected

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

◆ $lastSyncResult

$lastSyncResult

protected

Инициализатор

= [
        'newMessages' => 0,
        'newMessagesNotify' => 0,
        'deletedMessages' => 0,
        'updatedMessages' => 0,
        'newMessageId' => null,
    ]

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

◆ $mailbox

$mailbox

protected

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

◆ $session

$session

protected

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

◆ $startTime

$startTime

protected

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

◆ $syncParams

$syncParams = []

protected

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

◆ $syncTimeout

$syncTimeout

protected

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

◆ $warnings

$warnings

protected

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

◆ INCOMPLETE_MESSAGE_REMOVE_TIMEOUT

const INCOMPLETE_MESSAGE_REMOVE_TIMEOUT = 600

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

◆ MAIL_SERVICES_ONLY_FOR_THE_RU_ZONE

const MAIL_SERVICES_ONLY_FOR_THE_RU_ZONE

Инициализатор

= [
        'yandex',
        'mail.ru',
    ]

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

◆ MESSAGE_DELETION_LIMIT_AT_A_TIME

const MESSAGE_DELETION_LIMIT_AT_A_TIME = 500

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

◆ MESSAGE_RESYNCHRONIZATION_TIME

const MESSAGE_RESYNCHRONIZATION_TIME = 360

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

◆ MESSAGE_SET_OLD_STATUS_LIMIT_AT_A_TIME

const MESSAGE_SET_OLD_STATUS_LIMIT_AT_A_TIME = 500

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

◆ NUMBER_OF_BROKEN_MESSAGES_TO_RESYNCHRONIZE

const NUMBER_OF_BROKEN_MESSAGES_TO_RESYNCHRONIZE = 2

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

◆ NUMBER_OF_INCOMPLETE_MESSAGES_TO_REMOVE

const NUMBER_OF_INCOMPLETE_MESSAGES_TO_REMOVE = 10

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

◆ SYNC_TIME_QUOTA

const SYNC_TIME_QUOTA = 280

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

◆ SYNC_TIMEOUT

const SYNC_TIMEOUT = 300

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

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

C:/bitrix/modules/mail/lib/helper/mailbox.php

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

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

Поля данных

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

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

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

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

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

◆ __construct()

Методы

◆ activateSync()

◆ cacheMessage()

◆ checkMessagesForExistence()

◆ cleanup()

◆ createInstance()

◆ createMessage()

◆ dismissDeletedUidMessages()

◆ dismissOldMessages()

◆ downloadAttachments()

◆ downloadMessage()

◆ findBy()

◆ findMessageInUploadQueue()

◆ getDirsHelper()

◆ getDirsMd5WithCounter()

◆ getDirsWithUnseenMailCounters()

◆ getErrors()

◆ getFilters()

◆ getForUserByEmail()

◆ getLastSyncResult()

◆ getMailbox()

◆ getMailboxId()

◆ getMailboxOwnerId()

◆ getServices()

◆ getSyncStatus()

◆ getTimeout()

◆ getWarnings()

◆ incrementTree()

◆ instance()

◆ isAuthenticated()

◆ isRuZone()

◆ isSupportLazyAttachments()

◆ isSupportSanitizeOnView()

◆ isTimeQuotaExceeded()

◆ linkMessage()

◆ listDirs()

◆ listMessages()

◆ mail()

◆ normalizeMailboxOptions()

◆ notifyNewMessages()

◆ prepareMailbox()

◆ pushSyncStatus()

◆ rawInstance()

◆ registerMessage()

◆ resortTree()

◆ restoringConsistency()

◆ resyncIsOldStatus()

◆ resyncMessage()

◆ reSyncStartPage()

◆ sendCountersEvent()

◆ setCheckpoint()

◆ setLastSyncResult()

◆ setSyncParams()

◆ sync()

◆ syncCounters()

◆ syncFirstDay()

◆ syncInternal()

◆ syncMessages()

◆ syncOutgoing()

◆ syncOutgoingMessage()

◆ unregisterMessages()

◆ updateGlobalCounter()

◆ updateGlobalCounterForCurrentUser()

◆ updateMessagesRegistry()

◆ uploadMessage()

Поля

◆ $checkpoint

◆ $dirsHelper

◆ $dirsMd5WithCounter

◆ $errors

◆ $filters