Bitrix API

Imap extends Mailbox

Table of Contents

Constants

MAIL_SERVICES_ONLY_FOR_THE_RU_ZONE  = ['yandex', 'mail.ru']
MAXIMUM_SYNCHRONIZATION_LENGTHS_OF_INTERVALS  = [100, 50, 25, 12, 6, 3, 1]
MESSAGE_DELETION_LIMIT_AT_A_TIME  = 1000
MESSAGE_PARTS_ALL  = -1
MESSAGE_PARTS_ATTACHMENT  = 2
MESSAGE_PARTS_TEXT  = 1
MESSAGE_RESYNCHRONIZATION_TIME  = 360
NUMBER_OF_BROKEN_MESSAGES_TO_RESYNCHRONIZE  = 2
SYNC_TIME_QUOTA  = 280
SYNC_TIMEOUT  = 300

Methods

activateSync()  : mixed
cacheDirs()  : mixed
cacheMeta()  : mixed
checkMessagesForExistence()  : mixed
cleanup()  : mixed
createInstance()  : Mailbox|false
Creates active mailbox helper instance by ID
deleteMails()  : mixed
dismissDeletedUidMessages()  : mixed
dismissOldMessages()  : mixed
downloadAttachments()  : mixed
downloadMessage()  : mixed
downloadMessageParts()  : mixed
findBy()  : Mailbox|null
getDirsHelper()  : mixed
getDirsMd5WithCounter()  : mixed
getDirsWithUnseenMailCounters()  : mixed
getErrors()  : mixed
getFilters()  : mixed
getForUserByEmail()  : mixed
getLastSyncResult()  : mixed
getMailbox()  : mixed
getMailboxId()  : int
getMailboxOwnerId()  : int
getMinimumSyncDate()  : mixed
getServices()  : array<string|int, mixed>
getSyncStatus()  : mixed
getSyncStatusTotal()  : mixed
getTimeout()  : mixed
getWarnings()  : mixed
incrementTree()  : mixed
isAuthenticated()  : bool
isRuZone()  : bool
isSupportLazyAttachments()  : mixed
isSupportSanitizeOnView()  : bool
Could we sanitize message on view? if there is no filters that can use sanitized body
listDirs()  : mixed
mail()  : mixed
markSeen()  : mixed
markUnseen()  : mixed
moveMailsToFolder()  : mixed
notifyNewMessages()  : mixed
prepareMailbox()  : mixed
rawInstance()  : Mailbox|false
Creates mailbox helper instance
resortTree()  : mixed
restoringConsistency()  : void
resyncDir()  : mixed
resyncIsOldStatus()  : mixed
resyncMessage()  : mixed
reSyncStartPage()  : void
sendCountersEvent()  : mixed
setCheckpoint()  : mixed
setSyncParams()  : mixed
sync()  : mixed
syncCounters()  : void
syncDir()  : mixed
syncDirForSpecificDay()  : mixed
syncFirstDay()  : mixed
syncMailbox()  : mixed
syncMessages()  : bool
syncOutgoing()  : mixed
updateGlobalCounter()  : mixed
updateGlobalCounterForCurrentUser()  : mixed
uploadMessage()  : mixed

Constants

MAIL_SERVICES_ONLY_FOR_THE_RU_ZONE

public mixed MAIL_SERVICES_ONLY_FOR_THE_RU_ZONE = ['yandex', 'mail.ru']

MAXIMUM_SYNCHRONIZATION_LENGTHS_OF_INTERVALS

public mixed MAXIMUM_SYNCHRONIZATION_LENGTHS_OF_INTERVALS = [100, 50, 25, 12, 6, 3, 1]

MESSAGE_DELETION_LIMIT_AT_A_TIME

public mixed MESSAGE_DELETION_LIMIT_AT_A_TIME = 1000

MESSAGE_PARTS_ALL

public mixed MESSAGE_PARTS_ALL = -1

MESSAGE_PARTS_ATTACHMENT

public mixed MESSAGE_PARTS_ATTACHMENT = 2

MESSAGE_PARTS_TEXT

public mixed MESSAGE_PARTS_TEXT = 1

MESSAGE_RESYNCHRONIZATION_TIME

public mixed MESSAGE_RESYNCHRONIZATION_TIME = 360

NUMBER_OF_BROKEN_MESSAGES_TO_RESYNCHRONIZE

public mixed NUMBER_OF_BROKEN_MESSAGES_TO_RESYNCHRONIZE = 2

SYNC_TIME_QUOTA

public mixed SYNC_TIME_QUOTA = 280

SYNC_TIMEOUT

public mixed SYNC_TIMEOUT = 300

Methods

activateSync()

public activateSync() : mixed

cacheDirs()

public cacheDirs() : mixed

cacheMeta()

public cacheMeta() : mixed

checkMessagesForExistence()

public checkMessagesForExistence([mixed $dirPath = 'INBOX' ][, mixed $UIDs = [] ]) : mixed
Parameters
$dirPath : mixed = 'INBOX'
$UIDs : mixed = []

createInstance()

Creates active mailbox helper instance by ID

public static createInstance(int $id[, bool $throw = true ]) : Mailbox|false
Parameters
$id : int

Mailbox ID.

$throw : bool = true

Throw exception on error.

Tags
throws
Exception
Return values
Mailbox|false

deleteMails()

public deleteMails(mixed $messages) : mixed
Parameters
$messages : mixed

dismissDeletedUidMessages()

public dismissDeletedUidMessages() : mixed

dismissOldMessages()

public dismissOldMessages() : mixed

downloadAttachments()

public downloadAttachments(array<string|int, mixed> &$excerpt) : mixed
Parameters
$excerpt : array<string|int, mixed>

downloadMessage()

public downloadMessage(array<string|int, mixed> &$excerpt) : mixed
Parameters
$excerpt : array<string|int, mixed>

downloadMessageParts()

public downloadMessageParts(array<string|int, mixed> &$excerpt, BodyStructure $bodystructure[, mixed $flags = Imap::MESSAGE_PARTS_ALL ]) : mixed
Parameters
$excerpt : array<string|int, mixed>
$bodystructure : BodyStructure
$flags : mixed = Imap::MESSAGE_PARTS_ALL

findBy()

public final static findBy(mixed $id, mixed $email) : Mailbox|null
Parameters
$id : mixed
$email : mixed
Return values
Mailbox|null

getDirsHelper()

public getDirsHelper() : mixed

getDirsMd5WithCounter()

public getDirsMd5WithCounter(mixed $mailboxId) : mixed
Parameters
$mailboxId : mixed

getDirsWithUnseenMailCounters()

public getDirsWithUnseenMailCounters() : mixed

getErrors()

public getErrors() : mixed

getFilters()

public getFilters([mixed $force = false ]) : mixed
Parameters
$force : mixed = false

getForUserByEmail()

public final static getForUserByEmail(mixed $email) : mixed
Parameters
$email : mixed

getLastSyncResult()

public getLastSyncResult() : mixed

getMailbox()

public getMailbox() : mixed

getMailboxId()

public getMailboxId() : int
Return values
int

getMailboxOwnerId()

public getMailboxOwnerId() : int
Return values
int

getMinimumSyncDate()

public getMinimumSyncDate() : mixed

getServices()

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

getSyncStatus()

public getSyncStatus() : mixed

getSyncStatusTotal()

public getSyncStatusTotal() : mixed

getTimeout()

public final static getTimeout() : mixed

getWarnings()

public getWarnings() : mixed

incrementTree()

public incrementTree(mixed $message) : mixed
Parameters
$message : mixed

isAuthenticated()

public isAuthenticated() : bool
Return values
bool

isRuZone()

public static isRuZone() : bool
Return values
bool

isSupportLazyAttachments()

public isSupportLazyAttachments() : mixed

isSupportSanitizeOnView()

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

public isSupportSanitizeOnView() : bool
Return values
bool

listDirs()

public listDirs(mixed $pattern[, mixed $useDb = false ]) : mixed
Parameters
$pattern : mixed
$useDb : mixed = false

mail()

public mail(array<string|int, mixed> $params) : mixed
Parameters
$params : array<string|int, mixed>

markSeen()

public markSeen(mixed $messages) : mixed
Parameters
$messages : mixed

markUnseen()

public markUnseen(mixed $messages) : mixed
Parameters
$messages : mixed

moveMailsToFolder()

public moveMailsToFolder(mixed $messages, mixed $folderTo) : mixed
Parameters
$messages : mixed
$folderTo : mixed

notifyNewMessages()

public notifyNewMessages() : mixed

prepareMailbox()

public static prepareMailbox(mixed $filter) : mixed
Parameters
$filter : mixed

rawInstance()

Creates mailbox helper instance

public static rawInstance(mixed $filter[, bool $throw = true ]) : Mailbox|false
Parameters
$filter : mixed

Filter.

$throw : bool = true

Throw exception on error.

Tags
throws
Exception
Return values
Mailbox|false

resortTree()

public resortTree([mixed $message = null ]) : mixed
Parameters
$message : mixed = null

restoringConsistency()

public restoringConsistency() : void

resyncDir()

public resyncDir(mixed $dirPath[, mixed $numberForResync = false ]) : mixed
Parameters
$dirPath : mixed
$numberForResync : mixed = false

resyncIsOldStatus()

public resyncIsOldStatus() : mixed

resyncMessage()

public resyncMessage(array<string|int, mixed> &$excerpt) : mixed
Parameters
$excerpt : array<string|int, mixed>

reSyncStartPage()

public reSyncStartPage() : void

sendCountersEvent()

public sendCountersEvent() : mixed

setCheckpoint()

public setCheckpoint() : mixed

setSyncParams()

public setSyncParams([array<string|int, mixed> $params = array() ]) : mixed
Parameters
$params : array<string|int, mixed> = array()

sync()

public sync([mixed $syncCounters = true ]) : mixed
Parameters
$syncCounters : mixed = true

syncCounters()

public syncCounters() : void

syncDir()

public syncDir(mixed $dirPath) : mixed
Parameters
$dirPath : mixed

syncDirForSpecificDay()

public syncDirForSpecificDay(mixed $dirPath, mixed $internalDate) : mixed
Parameters
$dirPath : mixed
$internalDate : mixed

syncFirstDay()

public syncFirstDay() : mixed

syncMailbox()

public syncMailbox() : mixed

syncMessages()

public syncMessages(mixed $mailboxID, mixed $dirPath, mixed $UIDs) : bool
Parameters
$mailboxID : mixed
$dirPath : mixed
$UIDs : mixed
Tags
throws
SqlQueryException
throws
SystemException
Return values
bool —
  • success status

syncOutgoing()

public syncOutgoing() : mixed

updateGlobalCounter()

public updateGlobalCounter(mixed $userId) : mixed
Parameters
$userId : mixed

updateGlobalCounterForCurrentUser()

public updateGlobalCounterForCurrentUser() : mixed

uploadMessage()

public uploadMessage(Mail $message[, array<string|int, mixed> &$excerpt = null ]) : mixed
Parameters
$message : Mail
$excerpt : array<string|int, mixed> = null 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results