Bitrix API

MailManager implements ICanSendMessage

FinalYes

Table of Contents

Interfaces

ICanSendMessage

Constants

CALLBACK_ENTITY_TYPE  = 'mail_mngr'

Methods

canSendMessage()  : bool
canSendMessageViaChannel()  : Result
canUse()  : bool
getChannelsList()  : array<string|int, mixed>
getConnectUrl()  : mixed
getSenderCode()  : string
getUsageErrors()  : array<string|int, mixed>
isAvailable()  : bool
isConnected()  : bool
makeMessageFields()  : array<string|int, mixed>
sendMessage()  : mixed

Constants

CALLBACK_ENTITY_TYPE

public mixed CALLBACK_ENTITY_TYPE = 'mail_mngr'

Methods

canSendMessage()

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

canSendMessageViaChannel()

public static canSendMessageViaChannel(Channel $channel) : Result
Parameters
$channel : Channel
Return values
Result

canUse()

public static canUse() : bool
Return values
bool

getChannelsList()

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

getConnectUrl()

public static getConnectUrl() : mixed

getSenderCode()

public static getSenderCode() : string
Return values
string

getUsageErrors()

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

isAvailable()

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

isConnected()

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

makeMessageFields()

public static makeMessageFields(array{ATTACHMENTS_STORAGE_TYPE_ID: ?int, ATTACHMENTS_IDS: null|int[], MESSAGE_SUBJECT: ?string, MESSAGE_BODY: ?string, MESSAGE_BODY_CONTENT_TYPE: ?int, MESSAGE_FROM: string} $options, array<string|int, mixed> $commonOptions) : array<string|int, mixed>
Parameters
$options : array{ATTACHMENTS_STORAGE_TYPE_ID: ?int, ATTACHMENTS_IDS: null|int[], MESSAGE_SUBJECT: ?string, MESSAGE_BODY: ?string, MESSAGE_BODY_CONTENT_TYPE: ?int, MESSAGE_FROM: string}
$commonOptions : array<string|int, mixed>
Tags
inheritDoc
Return values
array<string|int, mixed>

sendMessage()

public static sendMessage(array<string|int, mixed> $messageFields) : mixed
Parameters
$messageFields : array<string|int, mixed> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results