Subscription::isUnsubscibed() — параметры и описание

Сигнатура

public static isUnsubscibed(int $mailingId, string $code[, int $typeId = \Bitrix\Sender\Recipient\Type::EMAIL ]) : bool

Описание

Возвращает true, если адрес email был отписан.

Параметры

$mailingId int

ID кампании.

$code string

Код получателя.

$typeId int = \Bitrix\Sender\Recipient\Type::EMAIL

ID типа получателя.

Возвращаемое значение

bool

Как применяется в Subscription

Subscription::isUnsubscibed() — метод класса \Bitrix\Sender\Subscription модуля «Email-маркетинг».

Статический метод — вызывается через имя класса Subscription, без создания объекта.

use Bitrix\Main\Loader;
use Bitrix\Sender\Subscription;

Loader::includeModule('sender');

$mailingId = 1;
$code = '';
$result = Subscription::isUnsubscibed($mailingId, $code);
// $result: bool

Другие методы Subscription

add() Подписывает email на рассылки и возвращает идентификатор подписки.
getLinkSub() Возвращает ссылку на страницу подтверждения подписки для подписчика.
getLinkUnsub() Возвращает ссылку на страницу отписки для подписчика
getList() Возвращает список подписок на рассылки для подписчика.
getMailingList() Получает список рассылок, доступных для подписки.
onMailEventSubscriptionDisable() Обработчик события.
onMailEventSubscriptionEnable() Обработчик события.
onMailEventSubscriptionList() Обработчик события.
sendEventConfirm() Отправляет email со ссылкой для подтверждения подписки.
subscribe() Подписывает email на рассылки.
unsubscribe() Отписывает email от рассылки.