Bitrix API

AttachmentHelper

Table of Contents

Methods

__construct() : mixed
extractFileIdsFromMessageBody() : array<string|int, mixed>
generateFileName() : string
generateMessageAttachmentPath() : string
saveAttachmentsToDisk() : Result
update() : bool

__construct()


    public
                    __construct(int $mailboxId[, int $messageId = null ][, int $messageUid = null ]) : mixed

Parameters

$mailboxId : int
$messageId : int = null
$messageUid : int = null

extractFileIdsFromMessageBody()


    public
                    extractFileIdsFromMessageBody(MessageStructure $messageStructure) : array<string|int, mixed>

Parameters

$messageStructure : MessageStructure

Return values

array<string|int, mixed>

generateFileName()


    public
            static        generateFileName(int $mailboxId, int $messageId, int $attachmentIndex, string|null $attachmentType) : string

Parameters

$mailboxId : int
$messageId : int
$attachmentIndex : int
$attachmentType : string|null

Return values

string

generateMessageAttachmentPath()


    public
            static        generateMessageAttachmentPath() : string

Return values

string

saveAttachmentsToDisk()


    public
                    saveAttachmentsToDisk(array<string|int, AttachmentStructure> $attachments[, bool $abortOnAnError = false ]) : Result

Parameters

$attachments : array<string|int, AttachmentStructure>
$abortOnAnError : bool = false

Return values

Result

update()


    public
                    update() : bool

Return values

bool