Bitrix API

Imap

Table of Contents

Constants

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

Methods

__construct()  : mixed
__destruct()  : mixed
addMessage()  : string|false
Adds message
append()  : mixed
authenticate()  : mixed
connect()  : mixed
copyMailToFolder()  : mixed
decodeError()  : string
Returns error message
delete()  : Result
ensureEmpty()  : mixed
examine()  : mixed
fetch()  : array<string|int, mixed>|false|mixed
getErrors()  : mixed
getMessage()  : string|false
Returns message
getNew()  : mixed
getState()  : mixed
getUidRange()  : mixed
getUIDsForSpecificDay()  : mixed
getUnseen()  : int|false
Returns unseen messages count
isExistsDir()  : mixed
listex()  : mixed
listMailboxes()  : array<string|int, mixed>|false
Returns mailboxes list
listMessages()  : mixed
move()  : mixed
moveMails()  : mixed
searchByHeader()  : mixed
seen()  : mixed
select()  : mixed
singin()  : bool
Connects to server and authenticate client
unseen()  : mixed
updateMessageFlags()  : mixed

Constants

ERR_APPEND

public mixed ERR_APPEND = 211

ERR_AUTH

public mixed ERR_AUTH = 204

ERR_AUTH_MECH

public mixed ERR_AUTH_MECH = 205

ERR_AUTH_OAUTH

public mixed ERR_AUTH_OAUTH = 206

ERR_BAD_SERVER

public mixed ERR_BAD_SERVER = 105

ERR_CAPABILITY

public mixed ERR_CAPABILITY = 203

ERR_COMMAND_REJECTED

public mixed ERR_COMMAND_REJECTED = 202

ERR_COMMUNICATE

public mixed ERR_COMMUNICATE = 103

ERR_CONNECT

public mixed ERR_CONNECT = 101

ERR_EMPTY_RESPONSE

public mixed ERR_EMPTY_RESPONSE = 104

ERR_FETCH

public mixed ERR_FETCH = 210

ERR_LIST

public mixed ERR_LIST = 207

ERR_REJECTED

public mixed ERR_REJECTED = 102

ERR_SEARCH

public mixed ERR_SEARCH = 209

ERR_SELECT

public mixed ERR_SELECT = 208

ERR_STARTTLS

public mixed ERR_STARTTLS = 201

ERR_STORE

public mixed ERR_STORE = 212

LOG_LEVEL_READ

public mixed LOG_LEVEL_READ = 2

LOG_LEVEL_WRITE

public mixed LOG_LEVEL_WRITE = 1

Methods

__construct()

public __construct(mixed $host, mixed $port, mixed $tls, mixed $strict, mixed $login, mixed $password[, mixed $encoding = null ]) : mixed
Parameters
$host : mixed
$port : mixed
$tls : mixed
$strict : mixed
$login : mixed
$password : mixed
$encoding : mixed = null

__destruct()

public __destruct() : mixed

addMessage()

Adds message

public addMessage(string $mailbox, string $data, string &$error) : string|false
Parameters
$mailbox : string

Mailbox name.

$data : string

Message.

$error : string

Error message.

Return values
string|false

append()

public append(mixed $mailbox, array<string|int, mixed> $flags, DateTime $internaldate, mixed $data, mixed &$error) : mixed
Parameters
$mailbox : mixed
$flags : array<string|int, mixed>
$internaldate : DateTime
$data : mixed
$error : mixed

authenticate()

public authenticate(mixed &$error) : mixed
Parameters
$error : mixed

connect()

public connect(mixed &$error) : mixed
Parameters
$error : mixed

copyMailToFolder()

public copyMailToFolder(mixed $ids, mixed $mailboxName, mixed $folder) : mixed
Parameters
$ids : mixed
$mailboxName : mixed
$folder : mixed

decodeError()

Returns error message

public static decodeError(int $code) : string
Parameters
$code : int

Error code.

Return values
string

delete()

public delete(mixed $id, mixed $mailboxName) : Result
Parameters
$id : mixed
$mailboxName : mixed
Return values
Result

ensureEmpty()

public ensureEmpty(mixed $mailbox, mixed &$error) : mixed
Parameters
$mailbox : mixed
$error : mixed

examine()

public examine(mixed $mailbox, mixed &$error) : mixed
Parameters
$mailbox : mixed
$error : mixed

fetch()

public fetch(mixed $uid, mixed $mailbox, mixed $range, mixed $select, mixed &$error[, string $outputFormat = 'smart' ]) : array<string|int, mixed>|false|mixed
Parameters
$uid : mixed
$mailbox : mixed
$range : mixed
$select : mixed
$error : mixed
$outputFormat : string = 'smart'

'smart' or 'list'

Return values
array<string|int, mixed>|false|mixed

getErrors()

public getErrors() : mixed

getMessage()

Returns message

public getMessage(string $mailbox, int $id, string $section, string &$error) : string|false
Parameters
$mailbox : string

Mailbox name.

$id : int

Message ID.

$section : string

Message section.

$error : string

Error message.

Return values
string|false

getNew()

public getNew(mixed $mailbox, mixed $uidMin, mixed $uidMax, mixed &$error) : mixed
Parameters
$mailbox : mixed
$uidMin : mixed
$uidMax : mixed
$error : mixed

getState()

public getState() : mixed

getUidRange()

public getUidRange(mixed $mailbox, mixed &$error) : mixed
Parameters
$mailbox : mixed
$error : mixed

getUIDsForSpecificDay()

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

getUnseen()

Returns unseen messages count

public getUnseen(string $dirPath, string &$error[, mixed $startInternalDate = null ]) : int|false
Parameters
$dirPath : string

dir path.

$error : string

Error message.

$startInternalDate : mixed = null
Return values
int|false

isExistsDir()

public isExistsDir(mixed $mailbox, mixed &$error) : mixed
Parameters
$mailbox : mixed
$error : mixed

listex()

public listex(mixed $reference, mixed $pattern, mixed &$error) : mixed
Parameters
$reference : mixed
$pattern : mixed
$error : mixed

listMailboxes()

Returns mailboxes list

public listMailboxes(string $pattern, string &$error[, mixed $flat = false ]) : array<string|int, mixed>|false
Parameters
$pattern : string

Mailbox name pattern.

$error : string

Error message.

$flat : mixed = false
Return values
array<string|int, mixed>|false

listMessages()

public listMessages(mixed $mailbox, mixed &$uidtoken, mixed &$error) : mixed
Parameters
$mailbox : mixed
$uidtoken : mixed
$error : mixed

move()

public move(mixed $ids, mixed $folderFrom, mixed $folderTo) : mixed
Parameters
$ids : mixed
$folderFrom : mixed
$folderTo : mixed

moveMails()

public moveMails(mixed $ids, mixed $folderFrom, mixed $folderTo) : mixed
Parameters
$ids : mixed
$folderFrom : mixed
$folderTo : mixed

searchByHeader()

public searchByHeader(mixed $uid, mixed $mailbox, array<string|int, mixed> $header, mixed &$error) : mixed
Parameters
$uid : mixed
$mailbox : mixed
$header : array<string|int, mixed>
$error : mixed

seen()

public seen(mixed $ids, mixed $folder) : mixed
Parameters
$ids : mixed
$folder : mixed

select()

public select(mixed $mailbox, mixed &$error) : mixed
Parameters
$mailbox : mixed
$error : mixed

singin()

Connects to server and authenticate client

public singin(string &$error) : bool
Parameters
$error : string

Error message.

Return values
bool

unseen()

public unseen(mixed $ids, mixed $folder) : mixed
Parameters
$ids : mixed
$folder : mixed

updateMessageFlags()

public updateMessageFlags(mixed $mailbox, mixed $id, mixed $flags, mixed &$error) : mixed
Parameters
$mailbox : mixed
$id : mixed
$flags : mixed
$error : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results