MediaWiki master
Public Member Functions | Protected Attributes | List of all members
EmailNotification Class Reference
Mail

Find watchers and create email notifications after a page is changed. More...

Collaboration diagram for EmailNotification:
Collaboration graph
[legend]

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 $from
 
array MailAddress[] $mailTargets = []
 
bool $minorEdit
 
int null bool $oldid
 
string $pageStatus = ''
 
MailAddress $replyto
 
string $subject = ''
 
string $summary = ''
 
string $timestamp
 
Title $title
 

Detailed Description

Find watchers and create email notifications after a page is changed.

After an edit is published to RCFeed, RecentChange::save calls EmailNotification. Here we query the watchlist table (via WatchedItemStore) to find who is watching a given page, format the emails in question, and dispatch emails to each of them via the JobQueue.

The current implementation sends independent emails to each watching user for the following reason: Each email mentions the page edit time expressed in the person's local time (UTC is shown additionally). To achieve this, we need to find the individual timeoffset of each watching user from the preferences.

Visit the documentation pages under https://www.mediawiki.org/wiki/Help:Watching_pages

Todo
If the volume becomes too great, we could send out bulk mails (bcc:user1,user2...) grouped by users having the same timeoffset in their preferences. This would however need to carefully consider impact of failure rate, re-try behaviour, and idempotence.
Todo
Use UserOptionsLookup and other services, consider converting this to a service
Since
1.11.0

Definition at line 61 of file EmailNotification.php.

Member Function Documentation

◆ actuallyNotifyOnPageChange()

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.

Note
Do not call directly. Use notifyOnPageChange so that wl_notificationtimestamp is updated.
Since
1.11.0
Parameters
Authority$editor
Title$title
string$timestampEdit timestamp
string$summaryEdit summary
bool$minorEdit
int$oldidRevision ID
array$watchersArray of user IDs
string$pageStatus

Definition at line 224 of file EmailNotification.php.

References MediaWiki\Title\Title\getNamespace(), MediaWiki\User\Options\UserOptionsLookup\getOption(), MediaWiki\Title\Title\getText(), MediaWiki\Permissions\Authority\getUser(), MediaWiki\Permissions\Authority\isAllowed(), and NS_USER_TALK.

◆ getPageStatus()

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.

Since
1.33
Returns
string

Definition at line 114 of file EmailNotification.php.

◆ notifyOnPageChange()

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.

Since
1.11.0
1.35 returns a boolean indicating whether an email job was created.
Parameters
Authority$editor
Title$title
string$timestamp
string$summary
bool$minorEdit
bool$oldid(default: false)
string$pageStatus(default: 'changed')
Returns
bool Whether an email job was created or not.

Definition at line 134 of file EmailNotification.php.

Member Data Documentation

◆ $body

string EmailNotification::$body = ''
protected

Definition at line 78 of file EmailNotification.php.

◆ $composed_common

bool EmailNotification::$composed_common = false
protected

Definition at line 93 of file EmailNotification.php.

◆ $editor

User EmailNotification::$editor
protected

Definition at line 102 of file EmailNotification.php.

◆ $from

MailAddress EmailNotification::$from
protected

Definition at line 82 of file EmailNotification.php.

◆ $mailTargets

array MailAddress [] EmailNotification::$mailTargets = []
protected

Definition at line 98 of file EmailNotification.php.

◆ $minorEdit

bool EmailNotification::$minorEdit
protected

Definition at line 88 of file EmailNotification.php.

◆ $oldid

int null bool EmailNotification::$oldid
protected

Definition at line 91 of file EmailNotification.php.

◆ $pageStatus

string EmailNotification::$pageStatus = ''
protected

Definition at line 95 of file EmailNotification.php.

◆ $replyto

MailAddress EmailNotification::$replyto
protected

Definition at line 80 of file EmailNotification.php.

◆ $subject

string EmailNotification::$subject = ''
protected

Definition at line 76 of file EmailNotification.php.

◆ $summary

string EmailNotification::$summary = ''
protected

Definition at line 86 of file EmailNotification.php.

◆ $timestamp

string EmailNotification::$timestamp
protected

Definition at line 84 of file EmailNotification.php.

◆ $title

Title EmailNotification::$title
protected

Definition at line 100 of file EmailNotification.php.

The documentation for this class was generated from the following file: