Bitrix API

MailboxConnector

FinalYes

Table of Contents

Constants

CRM_MAX_AGE  = 7
MESSAGE_MAX_AGE  = 7

Methods

appendSender()  : array<string|int, mixed>
Append SMTP sender, with two attempts for outlook
canConnectNewMailbox()  : bool
connectMailbox()  : array<string|int, mixed>
getErrors()  : array<string|int, mixed>
getSuccess()  : bool
isOauthSmtpEnabled()  : bool
Is OAuth for SMTP enabled for service
isValidMailHost()  : bool
setSuccess()  : void

Constants

Methods

appendSender()

Append SMTP sender, with two attempts for outlook

public static appendSender(array<string|int, mixed> $senderFields, string $userPrincipalName[, int $mailboxId = 0 ]) : array<string|int, mixed>
Parameters
$senderFields : array<string|int, mixed>

Sender fields data

$userPrincipalName : string

User Principal Name, appears in outlook oauth data only

$mailboxId : int = 0
Return values
array<string|int, mixed>

canConnectNewMailbox()

public static canConnectNewMailbox() : bool
Return values
bool

connectMailbox()

public connectMailbox([string $login = '' ][, string $password = '' ][, int $serviceId = 0 ][, string $server = '' ][, int $port = 993 ][, bool $ssl = true ][, string $storageOauthUid = '' ][, bool $syncAfterConnection = true ][, bool $useSmtp = true ][, string $serverSmtp = '' ][, int $portSmtp = 587 ][, bool $sslSmtp = true ][, string $loginSmtp = '' ][, string $passwordSMTP = '' ][, bool $useLimitSmtp = false ][, int $limitSmtp = null ][, string $mailboxName = '' ][, string $senderName = '' ]) : array<string|int, mixed>
Parameters
$login : string = ''
$password : string = ''
$serviceId : int = 0
$server : string = ''
$port : int = 993
$ssl : bool = true
$storageOauthUid : string = ''
$syncAfterConnection : bool = true
$useSmtp : bool = true
$serverSmtp : string = ''
$portSmtp : int = 587
$sslSmtp : bool = true
$loginSmtp : string = ''
$passwordSMTP : string = ''
$useLimitSmtp : bool = false
$limitSmtp : int = null
$mailboxName : string = ''
$senderName : string = ''
Return values
array<string|int, mixed>

getErrors()

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

isOauthSmtpEnabled()

Is OAuth for SMTP enabled for service

public static isOauthSmtpEnabled(string $serviceName) : bool
Parameters
$serviceName : string

Service name

Return values
bool

isValidMailHost()

public static isValidMailHost(string $host) : bool
Parameters
$host : string
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results