Subscription
Table of Contents
Constants
- MODULE_ID = 'sender'
Methods
- add() : int|null
- Subscribe email for mailings and returns subscription id.
- getLinkSub() : string
- Return link to confirmation subscription page for subscriber.
- getLinkUnsub() : string
- Return link to unsubsribe page for subscriber
- getList() : array<string|int, mixed>
- Return list of subscriptions on mailings for subscriber.
- getMailingList() : array<string|int, mixed>
- Get mailing list allowed for subscription.
- isUnsubscibed() : bool
- Return true if email address was unsubscribed.
- onMailEventSubscriptionDisable() : EventResult
- Event handler.
- onMailEventSubscriptionEnable() : EventResult
- Event handler.
- onMailEventSubscriptionList() : mixed
- Event handler.
- sendEventConfirm() : void
- Send email with link for confirmation of subscription.
- subscribe() : bool
- Subscribe email for mailings.
- unsubscribe() : bool
- Unsubscribe email from mailing.
Constants
MODULE_ID
public
mixed
MODULE_ID
= 'sender'
Methods
add()
Subscribe email for mailings and returns subscription id.
public
static add(string $code, array<string|int, mixed> $mailingIdList) : int|null
Parameters
- $code : string
-
Code.
- $mailingIdList : array<string|int, mixed>
-
Mailing list.
Return values
int|nullgetLinkSub()
Return link to confirmation subscription page for subscriber.
public
static getLinkSub(array<string|int, mixed> $fields) : string
Parameters
- $fields : array<string|int, mixed>
-
Fields.
Return values
stringgetLinkUnsub()
Return link to unsubsribe page for subscriber
public
static getLinkUnsub(array<string|int, mixed> $fields) : string
Parameters
- $fields : array<string|int, mixed>
Return values
stringgetList()
Return list of subscriptions on mailings for subscriber.
public
static getList(array<string|int, mixed> $data) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed>
-
Data.
Tags
Return values
array<string|int, mixed>getMailingList()
Get mailing list allowed for subscription.
public
static getMailingList(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
Parameters.
Return values
array<string|int, mixed>isUnsubscibed()
Return true if email address was unsubscribed.
public
static isUnsubscibed(int $mailingId, string $code[, int $typeId = \Bitrix\Sender\Recipient\Type::EMAIL ]) : bool
Parameters
- $mailingId : int
-
Campaign ID.
- $code : string
-
Recipient code.
- $typeId : int = \Bitrix\Sender\Recipient\Type::EMAIL
-
Recipient type ID.
Return values
boolonMailEventSubscriptionDisable()
Event handler.
public
static onMailEventSubscriptionDisable(array<string|int, mixed> $data) : EventResult
Parameters
- $data : array<string|int, mixed>
-
Data.
Return values
EventResultonMailEventSubscriptionEnable()
Event handler.
public
static onMailEventSubscriptionEnable(array<string|int, mixed> $data) : EventResult
Parameters
- $data : array<string|int, mixed>
-
Data.
Return values
EventResultonMailEventSubscriptionList()
Event handler.
public
static onMailEventSubscriptionList(array<string|int, mixed> $data) : mixed
Parameters
- $data : array<string|int, mixed>
-
Data.
sendEventConfirm()
Send email with link for confirmation of subscription.
public
static sendEventConfirm(string $email, array<string|int, mixed> $mailingIdList, string $siteId) : void
Parameters
- $email : string
-
Email.
- $mailingIdList : array<string|int, mixed>
-
Mailing List.
- $siteId : string
-
Site ID.
subscribe()
Subscribe email for mailings.
public
static subscribe(array<string|int, mixed> $data) : bool
Parameters
- $data : array<string|int, mixed>
-
Data.
Return values
boolunsubscribe()
Unsubscribe email from mailing.
public
static unsubscribe(array<string|int, mixed> $data) : bool
Parameters
- $data : array<string|int, mixed>
-
Data.