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 "UserMailerTransformMessage" to register handlers implementing this interface.
10	*
11	* @stable to implement
12	* @ingroup Hooks
13	*/
14	interface UserMailerTransformMessageHook {
15	/**
16	* This hook is called in UserMailer::send() to change email after
17	* it has gone through the MIME transform.
18	*
19	* @since 1.35
20	*
21	* @param MailAddress[] $to Array of addresses of the targets
22	* @param MailAddress $from Address of the sender
23	* @param string &$subject Email subject (not MIME encoded)
24	* @param array &$headers Email headers (except To: and Subject:) as an array of header
25	*   name => value pairs
26	* @param string &$body email body (in MIME format)
27	* @param string &$error Error message
28	* @return bool|void True or no return value to continue, or false and set $error to
29	*   block sending the email
30	*/
31	public function onUserMailerTransformMessage( $to, $from, &$subject, &$headers,
32	&$body, &$error
33	);
34	}