MediaWiki\RecentChanges\RecentChangeMailComposer Class Reference

Component responsible for composing and sending emails triggered after a RecentChange. More...

Collaboration diagram for MediaWiki\RecentChanges\RecentChangeMailComposer:

Public Member Functions
	__construct (Authority $editor, Title $title, RecentChange $recentChange, string $pageStatus)
	compose (UserEmailContact $watchingUser, $source)
	Compose a mail to a given user and send it now.

Public Attributes
const	ALL_CHANGES = 'all_changes'
	Notification because user is notified for all changes.
const	USER_TALK = 'user_talk'
	Notification is due to user's user talk being edited.
const	WATCHLIST = 'watchlist'
	Notification is due to a watchlisted page being edited.

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

Component responsible for composing and sending emails triggered after a RecentChange.

This includes watchlist notifications, user_talk notifications.

Access: internal

Definition at line 31 of file RecentChangeMailComposer.php.

Constructor & Destructor Documentation

__construct()

MediaWiki\RecentChanges\RecentChangeMailComposer::__construct	(	Authority	$editor,
		Title	$title,
		RecentChange	$recentChange,
		string	$pageStatus )

Definition at line 81 of file RecentChangeMailComposer.php.

References MediaWiki\RecentChanges\RecentChangeMailComposer\$editor, MediaWiki\RecentChanges\RecentChangeMailComposer\$pageStatus, MediaWiki\RecentChanges\RecentChangeMailComposer\$title, MediaWiki\RecentChanges\RecentChange\getAttribute(), and MediaWiki\MediaWikiServices\getInstance().

Member Function Documentation

compose()

MediaWiki\RecentChanges\RecentChangeMailComposer::compose	(	UserEmailContact	$watchingUser,
			$source )

Compose a mail to a given user and send it now.

Parameters

UserEmailContact	$watchingUser
string	$source

Definition at line 232 of file RecentChangeMailComposer.php.

References MediaWiki\RecentChanges\RecentChangeMailComposer\$body, $source, MediaWiki\MainConfigNames\EnotifUseRealName, MediaWiki\Mail\UserEmailContact\getRealName(), and MediaWiki\Mail\UserEmailContact\getUser().

Member Data Documentation

$body

string MediaWiki\RecentChanges\RecentChangeMailComposer::$body = ''

protected

Definition at line 48 of file RecentChangeMailComposer.php.

Referenced by MediaWiki\RecentChanges\RecentChangeMailComposer\compose().

$composed_common

bool MediaWiki\RecentChanges\RecentChangeMailComposer::$composed_common = false

protected

Definition at line 56 of file RecentChangeMailComposer.php.

$editor

User MediaWiki\RecentChanges\RecentChangeMailComposer::$editor

protected

Definition at line 72 of file RecentChangeMailComposer.php.

Referenced by MediaWiki\RecentChanges\RecentChangeMailComposer\__construct().

$from

MailAddress MediaWiki\RecentChanges\RecentChangeMailComposer::$from

protected

Definition at line 54 of file RecentChangeMailComposer.php.

$mailTargets

array MailAddress [] MediaWiki\RecentChanges\RecentChangeMailComposer::$mailTargets = []

protected

Definition at line 59 of file RecentChangeMailComposer.php.

$minorEdit

bool MediaWiki\RecentChanges\RecentChangeMailComposer::$minorEdit

protected

Definition at line 61 of file RecentChangeMailComposer.php.

$oldid

int null bool MediaWiki\RecentChanges\RecentChangeMailComposer::$oldid

protected

Definition at line 64 of file RecentChangeMailComposer.php.

$pageStatus

string MediaWiki\RecentChanges\RecentChangeMailComposer::$pageStatus = ''

protected

Definition at line 68 of file RecentChangeMailComposer.php.

Referenced by MediaWiki\RecentChanges\RecentChangeMailComposer\__construct().

$replyto

MailAddress MediaWiki\RecentChanges\RecentChangeMailComposer::$replyto

protected

Definition at line 52 of file RecentChangeMailComposer.php.

$subject

string MediaWiki\RecentChanges\RecentChangeMailComposer::$subject = ''

protected

Definition at line 46 of file RecentChangeMailComposer.php.

$summary

string MediaWiki\RecentChanges\RecentChangeMailComposer::$summary = ''

protected

Definition at line 50 of file RecentChangeMailComposer.php.

$timestamp

string MediaWiki\RecentChanges\RecentChangeMailComposer::$timestamp

protected

Definition at line 66 of file RecentChangeMailComposer.php.

$title

Title MediaWiki\RecentChanges\RecentChangeMailComposer::$title

protected

Definition at line 70 of file RecentChangeMailComposer.php.

Referenced by MediaWiki\RecentChanges\RecentChangeMailComposer\__construct().

ALL_CHANGES

const MediaWiki\RecentChanges\RecentChangeMailComposer::ALL_CHANGES = 'all_changes'

Notification because user is notified for all changes.

Definition at line 44 of file RecentChangeMailComposer.php.

USER_TALK

const MediaWiki\RecentChanges\RecentChangeMailComposer::USER_TALK = 'user_talk'

Notification is due to user's user talk being edited.

Definition at line 36 of file RecentChangeMailComposer.php.

WATCHLIST

const MediaWiki\RecentChanges\RecentChangeMailComposer::WATCHLIST = 'watchlist'

Notification is due to a watchlisted page being edited.

Definition at line 40 of file RecentChangeMailComposer.php.

---

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

• includes/RecentChanges/RecentChangeMailComposer.php