Bitrix API

UserSenderDataProvider

FinalYes

Table of Contents

Constants

ALIAS_TYPE  = 'alias'
MAILBOX_SENDER_TYPE  = 'mailboxSender'
MAILBOX_TYPE  = 'mailbox'
SENDER_TYPE  = 'sender'

Methods

getAddressInEmailAngleFormat()  : string|null
getSenderNameByMailboxId()  : array<string|int, mixed>|null
getSenderTransitionalData()  : array<string|int, mixed>|null
Returns sender email data available for user and list of available senders associated with that email
getUserAvailableMailboxSenders()  : array<string|int, mixed>
Returns senders connected with mailboxes that current user has access to
getUserAvailableSenders()  : array<string|int, mixed>
Returns a list of available senders for a specific or current user
getUserAvailableSendersByEmail()  : array<string|int, mixed>|null
Returns a list of available senders for user
getUserFormattedName()  : string|null
getUserInfo()  : array<string|int, mixed>|null
isAdmin()  : bool

Constants

Methods

getAddressInEmailAngleFormat()

public static getAddressInEmailAngleFormat(string $email[, string|null $senderName = null ][, int|null $userId = null ]) : string|null
Parameters
$email : string
$senderName : string|null = null
$userId : int|null = null
Return values
string|null

getSenderNameByMailboxId()

public static getSenderNameByMailboxId(int $mailboxId[, bool $getSenderWithoutSmtp = false ]) : array<string|int, mixed>|null
Parameters
$mailboxId : int
$getSenderWithoutSmtp : bool = false
Return values
array<string|int, mixed>|null

getSenderTransitionalData()

Returns sender email data available for user and list of available senders associated with that email

public static getSenderTransitionalData(int $senderId) : array<string|int, mixed>|null
Parameters
$senderId : int
Return values
array<string|int, mixed>|null

getUserAvailableMailboxSenders()

Returns senders connected with mailboxes that current user has access to

public static getUserAvailableMailboxSenders([string|null $email = null ][, bool|null $getMailboxesWithoutSmtp = false ][, array<string|int, mixed>|null $excludedEmails = [] ][, int|null $userId = null ]) : array<string|int, mixed>
Parameters
$email : string|null = null
$getMailboxesWithoutSmtp : bool|null = false
$excludedEmails : array<string|int, mixed>|null = []
$userId : int|null = null
Return values
array<string|int, mixed>

getUserAvailableSenders()

Returns a list of available senders for a specific or current user

public static getUserAvailableSenders([int|null $userId = null ]) : array<string|int, mixed>
Parameters
$userId : int|null = null
Return values
array<string|int, mixed>

getUserAvailableSendersByEmail()

Returns a list of available senders for user

public static getUserAvailableSendersByEmail(string $email[, int $userId = null ]) : array<string|int, mixed>|null
Parameters
$email : string
$userId : int = null
Return values
array<string|int, mixed>|null

getUserFormattedName()

public static getUserFormattedName([int|null $userId = null ]) : string|null
Parameters
$userId : int|null = null
Return values
string|null

getUserInfo()

public static getUserInfo(int $userId) : array<string|int, mixed>|null
Parameters
$userId : int
Return values
array<string|int, mixed>|null 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results