Bitrix API

PostingManager

Class PostingManager

Table of Contents

Constants

SEND_RESULT_CONTINUE  = 'CONTINUE'
SEND_RESULT_ERROR  = false
SEND_RESULT_SENT  = true
SEND_RESULT_WAIT  = 'WAIT'
SEND_RESULT_WAITING_RECIPIENT  = 'WAITING_RECIPIENT'

Properties

$threadId  : mixed

Methods

click()  : void
Do click actions.
getChainReSend()  : array<string|int, mixed>|null
Get chain list for resending.
lockPosting()  : bool
Lock posting for preventing double sending.
onMailEventMailClick()  : array<string|int, mixed>
Handler of click event.
onMailEventMailRead()  : array<string|int, mixed>
Handler of read event.
read()  : void
Do read actions.
send()  : bool|string
Send posting.
sendToAddress()  : bool
Send letter by message from posting to address.
unlockPosting()  : bool
UnLock posting that was locking for preventing double sending.

Constants

SEND_RESULT_CONTINUE

public mixed SEND_RESULT_CONTINUE = 'CONTINUE'

SEND_RESULT_WAITING_RECIPIENT

public mixed SEND_RESULT_WAITING_RECIPIENT = 'WAITING_RECIPIENT'

Properties

Methods

click()

Do click actions.

public static click(int $recipientId, string $url) : void
Parameters
$recipientId : int

Recipient ID.

$url : string

Url.

Tags
throws
ArgumentException

getChainReSend()

Get chain list for resending.

public static getChainReSend(int $mailingId) : array<string|int, mixed>|null
Parameters
$mailingId : int

Mailing ID.

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

lockPosting()

Lock posting for preventing double sending.

public static lockPosting(int $id, mixed $threadId) : bool
Parameters
$id : int

ID.

$threadId : mixed
Tags
throws
SqlQueryException
throws
SystemException
use

\Bitrix\Sender\Posting\Sender::lock

Return values
bool

onMailEventMailClick()

Handler of click event.

public static onMailEventMailClick(array<string|int, mixed> $data) : array<string|int, mixed>
Parameters
$data : array<string|int, mixed>

Data.

Return values
array<string|int, mixed>

onMailEventMailRead()

Handler of read event.

public static onMailEventMailRead(array<string|int, mixed> $data) : array<string|int, mixed>
Parameters
$data : array<string|int, mixed>

Data.

Return values
array<string|int, mixed>

read()

Do read actions.

public static read(int $recipientId) : void
Parameters
$recipientId : int

Recipient ID.

send()

Send posting.

public static send(int $id[, int $timeout = 0 ][, int $maxMailCount = 0 ]) : bool|string
Parameters
$id : int

Posting ID.

$timeout : int = 0

Timeout.

$maxMailCount : int = 0

Max mail count.

Tags
throws
ArgumentException
throws
Exception
Return values
bool|string

sendToAddress()

Send letter by message from posting to address.

public static sendToAddress(int $mailingChainId, string $address) : bool
Parameters
$mailingChainId : int

Chain ID.

$address : string

Address.

Tags
throws
Exception
Return values
bool

unlockPosting()

UnLock posting that was locking for preventing double sending.

public static unlockPosting(int $id, mixed $threadId) : bool
Parameters
$id : int

ID.

$threadId : mixed
Tags
throws
SqlQueryException
throws
SystemException
use

\Bitrix\Sender\Posting\Sender::unlock

Return values
bool

        
On this page

Search results