./Sources/Subs-Notify.php
getNotifyPrefs
function getNotifyPrefs(int|array $members, string|array $prefs = '', bool $process_default = false): array
Fetches the list of preferences (or a single/subset of preferences) for notifications for one or more users.
Type | Parameter | Description |
---|---|---|
int |array |
$members |
A user id or an array of (integer) user ids to load preferences for |
string |array |
$prefs |
An empty string to load all preferences, or a string (or array) of preference name(s) to load |
bool |
$process_default |
Whether to apply the default values to the members’ values or not. |
setNotifyPrefs
function setNotifyPrefs(int $memID, array $prefs = array()): void
Sets the list of preferences for a single user.
Type | Parameter | Description |
---|---|---|
int |
$memID |
The user whose preferences you are setting |
array |
$prefs |
An array key of pref -> value |
deleteNotifyPrefs
function deleteNotifyPrefs(int $memID, array $prefs): void
Deletes notification preference
Type | Parameter | Description |
---|---|---|
int |
$memID |
The user whose preference you’re setting |
array |
$prefs |
The preferences to delete |
getMemberWithToken
function getMemberWithToken(string $type): array
Verifies a member’s unsubscribe token, then returns some member info
Type | Parameter | Description |
---|---|---|
string |
$type |
The type of notification the token is for (e.g. ‘board’, ‘topic’, etc.) |
createUnsubscribeToken
function createUnsubscribeToken(int $memID, string $email, string $type = '', int $itemID = 0): string
Builds an unsubscribe token
Type | Parameter | Description |
---|---|---|
int |
$memID |
The id of the member that this token is for |
string |
$email |
The member’s email address |
string |
$type |
The type of notification the token is for (e.g. ‘board’, ‘topic’, etc.) |
int |
$itemID |
The id of the notification item, if applicable. |