MediaWiki 1.40.4
|
This module processes the email notifications when the current page is changed. More...
Public Member Functions | |
actuallyNotifyOnPageChange (Authority $editor, $title, $timestamp, $summary, $minorEdit, $oldid, $watchers, $pageStatus='changed') | |
Immediate version of notifyOnPageChange(). | |
getPageStatus () | |
Extensions that have hooks for UpdateUserMailerFormattedPageStatus (to provide additional pageStatus indicators) need a way to make sure that, when their hook is called in SendWatchlistemailNotification, they only handle notifications using their pageStatus indicator. | |
notifyOnPageChange (Authority $editor, $title, $timestamp, $summary, $minorEdit, $oldid=false, $pageStatus='changed') | |
Send emails corresponding to the user $editor editing the page $title. | |
Protected Attributes | |
string | $body = '' |
bool | $composed_common = false |
User | $editor |
MailAddress null | $from |
MailAddress[] | $mailTargets = [] |
bool null | $minorEdit |
int null bool | $oldid |
string | $pageStatus = '' |
MailAddress null | $replyto |
string | $subject = '' |
string | $summary = '' |
string null | $timestamp |
Title | $title |
This module processes the email notifications when the current page is changed.
It queries the watchlist
table to find which users are watching that page.
The current implementation sends independent emails to each watching user for the following reason:
Suggested improvement to reduce the number of sent emails: We could think of sending out bulk mails (bcc:user1,user2...) for all these users having the same timeoffset in their preferences.
Visit the documentation pages under https://www.mediawiki.org/wiki/Help:Watching_pages
TODO use UserOptionsLookup and other services, consider converting this to a service
Definition at line 55 of file EmailNotification.php.
EmailNotification::actuallyNotifyOnPageChange | ( | Authority | $editor, |
$title, | |||
$timestamp, | |||
$summary, | |||
$minorEdit, | |||
$oldid, | |||
$watchers, | |||
$pageStatus = 'changed' ) |
Immediate version of notifyOnPageChange().
Send emails corresponding to the user $editor editing the page $title.
Authority | $editor | |
Title | $title | |
string | $timestamp | Edit timestamp |
string | $summary | Edit summary |
bool | $minorEdit | |
int | $oldid | Revision ID |
array | $watchers | Array of user IDs |
string | $pageStatus |
MWException |
Definition at line 224 of file EmailNotification.php.
References $title, MediaWiki\Permissions\Authority\getUser(), MediaWiki\Permissions\Authority\isAllowed(), UserArray\newFromIDs(), User\newFromName(), and NS_USER_TALK.
EmailNotification::getPageStatus | ( | ) |
Extensions that have hooks for UpdateUserMailerFormattedPageStatus (to provide additional pageStatus indicators) need a way to make sure that, when their hook is called in SendWatchlistemailNotification, they only handle notifications using their pageStatus indicator.
Definition at line 119 of file EmailNotification.php.
EmailNotification::notifyOnPageChange | ( | Authority | $editor, |
$title, | |||
$timestamp, | |||
$summary, | |||
$minorEdit, | |||
$oldid = false, | |||
$pageStatus = 'changed' ) |
Send emails corresponding to the user $editor editing the page $title.
May be deferred via the job queue.
Authority | $editor | |
Title | $title | |
string | $timestamp | |
string | $summary | |
bool | $minorEdit | |
bool | $oldid | (default: false) |
string | $pageStatus | (default: 'changed') |
Definition at line 138 of file EmailNotification.php.
|
protected |
Definition at line 74 of file EmailNotification.php.
|
protected |
Definition at line 95 of file EmailNotification.php.
|
protected |
Definition at line 107 of file EmailNotification.php.
|
protected |
Definition at line 80 of file EmailNotification.php.
|
protected |
Definition at line 101 of file EmailNotification.php.
|
protected |
Definition at line 89 of file EmailNotification.php.
|
protected |
Definition at line 92 of file EmailNotification.php.
|
protected |
Definition at line 98 of file EmailNotification.php.
|
protected |
Definition at line 77 of file EmailNotification.php.
|
protected |
Definition at line 71 of file EmailNotification.php.
|
protected |
Definition at line 86 of file EmailNotification.php.
|
protected |
Definition at line 83 of file EmailNotification.php.
|
protected |
Definition at line 104 of file EmailNotification.php.