Bitrix API

Message

Table of Contents

Constants

ENTITY_TYPE_CALENDAR_EVENT  = \Bitrix\Mail\Internals\MessageAccessTable::ENTITY_TYPE_CALENDAR_EVENT
ENTITY_TYPE_IM_CHAT  = \Bitrix\Mail\Internals\MessageAccessTable::ENTITY_TYPE_IM_CHAT

Methods

ensureAttachments()  : mixed
getCountersForUserMailboxes()  : array<string|int, mixed>|int
getMaxAttachedFilesSize()  : mixed
getMaxAttachedFilesSizeAfterEncoding()  : mixed
getSaltByEntityType()  : string
getWhitelistTagAttributes()  : array<string|int, mixed>
Returns a whitelist of attributes for the html sanitizer (\CBXSanitizer::SanitizeHtml)
hasAccess()  : mixed
isBodyNeedUpdateAfterLoadAttachments()  : bool
Is message body contains link to attachment
isIcalMessage()  : mixed
isMailboxOwner()  : bool
isolateBase64Files()  : string
isolateMessageStyles()  : mixed
isolateSelector()  : string
isolateStylesInTheBody()  : mixed
isolateStylesInTheTag()  : mixed
parseAddressList()  : mixed
prepare()  : mixed
Adapts a message(result of Mail\MailMessageTable::getList) for output in the public interface.
prepareSearchContent()  : mixed
prepareSearchString()  : mixed
replaceBodyInlineImgContentId()  : string
Replace html body inline image content id with attachment id
reSyncBody()  : mixed
sanitizeHtml()  : mixed
updateMailEntityOptionsRow()  : void

Constants

ENTITY_TYPE_CALENDAR_EVENT

public mixed ENTITY_TYPE_CALENDAR_EVENT = \Bitrix\Mail\Internals\MessageAccessTable::ENTITY_TYPE_CALENDAR_EVENT

ENTITY_TYPE_IM_CHAT

public mixed ENTITY_TYPE_IM_CHAT = \Bitrix\Mail\Internals\MessageAccessTable::ENTITY_TYPE_IM_CHAT

Methods

ensureAttachments()

public static ensureAttachments(mixed &$message) : mixed
Parameters
$message : mixed

getCountersForUserMailboxes()

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

getMaxAttachedFilesSize()

public static getMaxAttachedFilesSize() : mixed

getMaxAttachedFilesSizeAfterEncoding()

public static getMaxAttachedFilesSizeAfterEncoding() : mixed

getSaltByEntityType()

public static getSaltByEntityType(string $entityType, int $entityId[, int|null $userId = null ]) : string
Parameters
$entityType : string
$entityId : int
$userId : int|null = null
Return values
string

getWhitelistTagAttributes()

Returns a whitelist of attributes for the html sanitizer (\CBXSanitizer::SanitizeHtml)

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

hasAccess()

public static hasAccess(mixed &$message[, mixed $userId = null ]) : mixed
Parameters
$message : mixed
$userId : mixed = null

isBodyNeedUpdateAfterLoadAttachments()

Is message body contains link to attachment

public static isBodyNeedUpdateAfterLoadAttachments(string $body) : bool
Parameters
$body : string

HTML body of message

Return values
bool

isMailboxOwner()

public static isMailboxOwner(int $mailboxId, int $userId) : bool
Parameters
$mailboxId : int
$userId : int
Return values
bool

isolateBase64Files()

public static isolateBase64Files(string $text) : string
Parameters
$text : string
Return values
string

isolateMessageStyles()

public static isolateMessageStyles(mixed $messageHtml) : mixed
Parameters
$messageHtml : mixed

isolateSelector()

public static isolateSelector(mixed $matches) : string
Parameters
$matches : mixed
Return values
string

isolateStylesInTheBody()

public static isolateStylesInTheBody(mixed $html) : mixed
Parameters
$html : mixed

isolateStylesInTheTag()

public static isolateStylesInTheTag(mixed $matches) : mixed
Parameters
$matches : mixed

parseAddressList()

public static parseAddressList(mixed $column) : mixed
Parameters
$column : mixed

prepare()

Adapts a message(result of Mail\MailMessageTable::getList) for output in the public interface.

public static prepare(array<string|int, mixed> &$message) : mixed
Parameters
$message : array<string|int, mixed>

(result of Mail\MailMessageTable::getList. Changes the data in a variable!).

Tags
@return

array(modified $message).

prepareSearchContent()

public static prepareSearchContent(mixed &$fields) : mixed
Parameters
$fields : mixed

prepareSearchString()

public static prepareSearchString(mixed $string) : mixed
Parameters
$string : mixed

replaceBodyInlineImgContentId()

Replace html body inline image content id with attachment id

public static replaceBodyInlineImgContentId(string $body, string $contentId, int $attachmentId) : string
Parameters
$body : string

HTML string

$contentId : string

Content Id in img tag (with or without http://)

$attachmentId : int

Attachment ID in DB

Return values
string

reSyncBody()

public static reSyncBody(mixed $mailboxId, mixed $messageIds) : mixed
Parameters
$mailboxId : mixed
$messageIds : mixed

sanitizeHtml()

public static sanitizeHtml(mixed $html[, mixed $isolateStyles = false ]) : mixed
Parameters
$html : mixed
$isolateStyles : mixed = false

updateMailEntityOptionsRow()

public static updateMailEntityOptionsRow(mixed $mailboxId, mixed $messageId) : void
Parameters
$mailboxId : mixed
$messageId : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results