MediaWiki\Hook\EmailUserCompleteHook Interface Reference

This is a hook handler interface, see docs/Hooks.md. More...

Inheritance diagram for MediaWiki\Hook\EmailUserCompleteHook:

Public Member Functions
	onEmailUserComplete ( $to, $from, $subject, $text)
	This hook is called after sending email from one user to another.

Detailed Description

This is a hook handler interface, see docs/Hooks.md.

Use the hook name "EmailUserComplete" to register handlers implementing this interface.

Stability: stable

to implement

Definition at line 14 of file EmailUserCompleteHook.php.

Member Function Documentation

onEmailUserComplete()

MediaWiki\Hook\EmailUserCompleteHook::onEmailUserComplete	(		$to,
			$from,
			$subject,
			$text
	)

This hook is called after sending email from one user to another.

Since

1.35

Parameters

MailAddress	$to	MailAddress object of receiving user
MailAddress	$from	MailAddress object of sending user
string	$subject	subject of the mail
string	$text	text of the mail

Returns

bool|void True or no return value to continue or false to abort

Implemented in MediaWiki\HookContainer\HookRunner.

---

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

• includes/specials/Hook/EmailUserCompleteHook.php