Bitrix API

User

Table of Contents

Methods

clearTokensCache()  : mixed
create()  : int|false
Creates mail user
getDefaultEmailFrom()  : mixed
getForwardTo()  : array<string|int, mixed>|false
Returns Site-User-Entity unique email
getMailUserGroup()  : array<string|int, mixed>
Returns email users group
getReplyTo()  : array<string|int, mixed>|false
Returns User-Entity unique email and entry point URL
getUserData()  : mixed
getUserRelation()  : mixed
handleServerNameUpdate()  : mixed
handleSiteUpdate()  : mixed
login()  : void
Runs user login
onEmailReceived()  : bool
Sends email related events
onLoginExternal()  : int|false
Returns mail user ID
parseEmailRecipient()  : mixed
sendEventAgent()  : mixed
Agent method, retrieves stored user message and sends an event

Methods

clearTokensCache()

public static clearTokensCache() : mixed

create()

Creates mail user

public static create(array<string|int, mixed> $fields) : int|false
Parameters
$fields : array<string|int, mixed>

User fields.

Return values
int|false

getDefaultEmailFrom()

public static getDefaultEmailFrom([mixed $serverName = false ]) : mixed
Parameters
$serverName : mixed = false

getForwardTo()

Returns Site-User-Entity unique email

public static getForwardTo(string $siteId, int $userId, string $entityType) : array<string|int, mixed>|false
Parameters
$siteId : string

Site ID.

$userId : int

User ID.

$entityType : string

Entity type ID.

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

getMailUserGroup()

Returns email users group

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

getReplyTo()

Returns User-Entity unique email and entry point URL

public static getReplyTo(string $siteId, int $userId, string $entityType, int $entityId[, string $entityLink = null ][, string $backurl = null ]) : array<string|int, mixed>|false
Parameters
$siteId : string

Site ID.

$userId : int

User ID.

$entityType : string

Entity type ID.

$entityId : int

Entity ID.

$entityLink : string = null

Entity URL.

$backurl : string = null

Back URL.

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

getUserData()

public static getUserData(mixed $userList, mixed $nameTemplate) : mixed
Parameters
$userList : mixed
$nameTemplate : mixed

getUserRelation()

public static getUserRelation(mixed $token) : mixed
Parameters
$token : mixed

handleServerNameUpdate()

public static handleServerNameUpdate() : mixed

handleSiteUpdate()

public static handleSiteUpdate(mixed $fields) : mixed
Parameters
$fields : mixed

login()

Runs user login

public static login() : void

onEmailReceived()

Sends email related events

public static onEmailReceived(string $to, array<string|int, mixed> $message, mixed $recipient, mixed $userRelation, string &$error) : bool
Parameters
$to : string

Recipient email.

$message : array<string|int, mixed>

Message.

$recipient : mixed
$userRelation : mixed
$error : string

Error.

Return values
bool

onLoginExternal()

Returns mail user ID

public static onLoginExternal(array<string|int, mixed> &$params) : int|false
Parameters
$params : array<string|int, mixed>

Auth params.

Return values
int|false

parseEmailRecipient()

public static parseEmailRecipient(mixed $to) : mixed
Parameters
$to : mixed

sendEventAgent()

Agent method, retrieves stored user message and sends an event

public static sendEventAgent([mixed $messageId = 0 ][, mixed $cnt = 0 ]) : mixed
Parameters
$messageId : mixed = 0
$cnt : mixed = 0 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results