Bitrix API

Recipient

Class Recipient

Table of Contents

Methods

buildUniqueEmailCode()  : string
Builds unique code for BX.UI.Selector selector.
loadCrmMailContacts()  : array<string|int, mixed>
Load mail contacts from CRM - users with EXTERNAL_AUTH_ID = email and contact crm entity.
loadLastRcpt()  : array<string|int, mixed>
Load last used Rcpt.
loadMailContacts()  : array<string|int, mixed>
Load mail contacts - users with EXTERNAL_AUTH_ID = email.

Methods

buildUniqueEmailCode()

Builds unique code for BX.UI.Selector selector.

public static buildUniqueEmailCode(string $email) : string
Parameters
$email : string

Email.

Return values
string

loadCrmMailContacts()

Load mail contacts from CRM - users with EXTERNAL_AUTH_ID = email and contact crm entity.

public static loadCrmMailContacts([array<string|int, mixed> $filter = [] ][, int $limit = 20 ]) : array<string|int, mixed>
Parameters
$filter : array<string|int, mixed> = []

Filter.

$limit : int = 20

Limit list length.

Tags
throws
LoaderException
Return values
array<string|int, mixed>

Data preformed for BX.UI.Selector selector with email only mode enabled.

loadLastRcpt()

Load last used Rcpt.

public static loadLastRcpt([string $emailTo = null ][, int $limit = 10 ]) : array<string|int, mixed>
Parameters
$emailTo : string = null

Add this email to the result list.

$limit : int = 10

Limit list length.

Tags
throws
SystemException
Return values
array<string|int, mixed>

Data preformed for BX.UI.Selector selector with email only mode enabled.

loadMailContacts()

Load mail contacts - users with EXTERNAL_AUTH_ID = email.

public static loadMailContacts([array<string|int, mixed> $filter = [] ][, int $limit = 20 ]) : array<string|int, mixed>
Parameters
$filter : array<string|int, mixed> = []

Filter.

$limit : int = 20

Limit list length.

Tags
throws
SystemException
Return values
array<string|int, mixed>

Data preformed for BX.UI.Selector selector with email only mode enabled.


        
On this page

Search results