Данный модуль позволяет уполномоченным пользователям системы подписываться на рассылку уведомлений об обновлении конкретного раздела. Управление подписчиками производится в специальном интерфейсе модуля в разделе «Модули». Вы можете удалять или выключать подписки пользователей, а также настраивать шаблон письма в каждом отдельном случае.
После установки модуля в любом компненте имеет смысл ввести переменную $subscribeLink, которая представляет собой адрес страницы, где пользователь может подписаться на обновления конкретного раздела. Пример использования переменной:
< a href=$subscribeLink>подписаться на обновления раздела< /a>
Для того чтобы пользователь имел полномочия на подписку для конкретного компонента раздела, необходимо присвоить ему такое право в разделе «Пользователи и права», а также в настройках раздела/компонента раздела в графе «Доступ».
Для каждого компонента (в графе шаблонов действий – подписка) можно настроить шаблон отправляемого пользователям письма (в поле «Шаблон письма для подписчиков»). В данном поле актуальны переменные компонента вида $f_название_поля.
При желании, можно создать и настроить раздел отображения всех подписок пользователя при помощи функции s_browse_subscribe(). В этом разделе пользователь будет иметь возможность подписываться, включать или выключать подписки. Пример использования функции s_browse_subscribe() можно найти в установленном вместе с модулем макете дизайна «Пример отображения подписок и рассылок».
Администратор системы может управлять подписками всех пользователей в разделе «Модули», «Подписка и рассылка».
Ниже приведены константы, используемые модулем рассылки.
| Название параметра | Описание | Допустимые значения |
| SUBSCRIBER_LIST_SUB | Номер раздела, в котором пользователь управляет собственными подписками | Число |
| SUBJECT_CONTENT | Тема письма, отсылаемого пользователю, после добавления объекта в компонент раздела, на обновления которого этот пользователь подписан. | Строка, напр.: Подписка на обновления |
| USER_EMAIL_FIELD | Название поля в таблице «Пользователи», содержащее E-mail, по которому будет производиться рассылка. | Латинские буквы и цифры |
| SEND_FROM_NAME | Имя отправителя рассылки. | Строка, напр.: Вася Пупкин |
| SEND_FROM_EMAIL | E-mail отправителя рассылки (в т.ч. и обратный адрес). | Строка, напр.: vasya@pupkin.ru |
| CONTENT_TYPE | MIME-тип письма. | Напр.: text/plain |
| CHARSET | Кодировка письма | Напр.: windows-1251 |
Используемые функции:
s_browse_subscribes()
Данная функция отображает все подписки текущего пользователя в компоненте $browse_subscribes. Подразумевается, что шаблон задается аналогично шаблонам вывода навигации в макете дизайна. Пример использования функции можно посмотреть в установленном макете «Пример отображения подписок и рассылок».
subscribe_addItem($id)
Создает подписку на компонент раздела $cc для текущего пользователя.
subscribe_deleteItem($id)
Удаляет подписку с номером $id для текущего пользователя.
subscribe_toggleItem($id)
Включает/выключает подписку с номером $id для текущего пользователя, в зависимости от текущего состояния.
subscribe_sendmail($cc,$mailbody)
Производит рассылку уведомления о добавлении объекта в компонент раздела $cc с указанным телом письма ($mailbody). Тело письма формируется на основе шаблона письма для подписчиков.