1	<?php
2
3	namespace MediaWiki\Hook;
4
5	use MailAddress;
6
7	/**
8	* This is a hook handler interface, see docs/Hooks.md.
9	* Use the hook name "UserMailerTransformContent" to register handlers implementing this interface.
10	*
11	* @stable to implement
12	* @ingroup Hooks
13	*/
14	interface UserMailerTransformContentHook {
15	/**
16	* This hook is called in UserMailer::send() to change email contents.
17	*
18	* @since 1.35
19	*
20	* @param MailAddress[] $to Array of addresses of the targets
21	* @param MailAddress $from Address of the sender
22	* @param string|array &$body Email body, either a string (for plaintext emails) or an array with
23	*   'text' and 'html' keys
24	* @param string &$error Error message
25	* @return bool|void True or no return value to continue, or false and set $error to
26	*   block sending the email
27	*/
28	public function onUserMailerTransformContent( $to, $from, &$body, &$error );
29	}