Класс Subscription

Открытые статические члены
static	getLinkUnsub (array $fields)
static	getLinkSub (array $fields)
static	onMailEventSubscriptionList ($data)
static	onMailEventSubscriptionEnable ($data)
static	onMailEventSubscriptionDisable ($data)
static	getList ($data)
static	subscribe (array $data)
static	unsubscribe ($data)
static	add ($code, array $mailingIdList)
static	getMailingList ($params)
static	sendEventConfirm ($email, array $mailingIdList, $siteId)
static	isUnsubscibed ($mailingId, $code, $typeId=Recipient\Type::EMAIL)

Открытые атрибуты
const	MODULE_ID = 'sender'

Защищенные статические члены
static	getSubscriptions ($data)
static	unsubscribeRecipient ($data)

Подробное описание

См. определение в файле subscription.php строка 21

Методы

add()

static add ( $code, array $mailingIdList )

static

Subscribe email for mailings and returns subscription id.

Аргументы

string	$code	Code.
array	$mailingIdList	Mailing list.

Возвращает

integer|null

См. определение в файле subscription.php строка 564

getLinkSub()

static getLinkSub ( array $fields )

static

Return link to confirmation subscription page for subscriber.

Аргументы

array

$fields

Fields.

Возвращает

string

См. определение в файле subscription.php строка 42

getLinkUnsub()

static getLinkUnsub ( array $fields )

static

Return link to unsubsribe page for subscriber

Аргументы

array

$fields

Возвращает

string

См. определение в файле subscription.php строка 31

getList()

static getList ( $data )

static

Return list of subscriptions on mailings for subscriber.

Аргументы

array

$data

Data.

Возвращает

array

Исключения

Bitrix\Main\ArgumentException

См. определение в файле subscription.php строка 340

getMailingList()

static getMailingList ( $params )

static

Get mailing list allowed for subscription.

Аргументы

array

$params

Parameters.

Возвращает

array

См. определение в файле subscription.php строка 609

getSubscriptions()

static getSubscriptions ( $data )

staticprotected

См. определение в файле subscription.php строка 72

isUnsubscibed()

static isUnsubscibed ( $mailingId, $code, $typeId = Recipient\Type::EMAIL )

static

Return true if email address was unsubscribed.

Аргументы

int	$mailingId	Campaign ID.
string	$code	Recipient code.
int	$typeId	Recipient type ID.

Возвращает

bool

См. определение в файле subscription.php строка 680

onMailEventSubscriptionDisable()

static onMailEventSubscriptionDisable ( $data )

static

Event handler.

Аргументы

array

$data

Data.

Возвращает

EventResult

См. определение в файле subscription.php строка 198

onMailEventSubscriptionEnable()

static onMailEventSubscriptionEnable ( $data )

static

Event handler.

Аргументы

array

$data

Data.

Возвращает

EventResult

См. определение в файле subscription.php строка 181

onMailEventSubscriptionList()

static onMailEventSubscriptionList ( $data )

static

Event handler.

Аргументы

array

$data

Data.

Возвращает

mixed

См. определение в файле subscription.php строка 65

sendEventConfirm()

static sendEventConfirm ( $email, array $mailingIdList, $siteId )

static

Send email with link for confirmation of subscription.

Аргументы

string	$email	Email.
array	$mailingIdList	Mailing List.
string	$siteId	Site ID.

Возвращает

void

См. определение в файле subscription.php строка 643

subscribe()

static subscribe ( array $data )

static

Subscribe email for mailings.

Аргументы

array

$data

Data.

Возвращает

bool

См. определение в файле subscription.php строка 425

unsubscribe()

static unsubscribe ( $data )

static

Unsubscribe email from mailing.

Аргументы

array

$data

Data.

Возвращает

bool

Исключения

Bitrix\Main\ArgumentException

См. определение в файле subscription.php строка 444

unsubscribeRecipient()

static unsubscribeRecipient ( $data )

staticprotected

См. определение в файле subscription.php строка 209

Данные класса

MODULE_ID

const MODULE_ID = 'sender'

См. определение в файле subscription.php строка 23