MediaWiki\Hook\UserMailerTransformMessageHook Interface Reference

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

Inheritance diagram for MediaWiki\Hook\UserMailerTransformMessageHook:

Public Member Functions
	onUserMailerTransformMessage ( $to, $from, &$subject, &$headers, &$body, &$error)
	This hook is called in UserMailer::send() to change email after it has gone through the MIME transform.

Detailed Description

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

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

Stability: stable

to implement

Definition at line 14 of file UserMailerTransformMessageHook.php.

Member Function Documentation

onUserMailerTransformMessage()

MediaWiki\Hook\UserMailerTransformMessageHook::onUserMailerTransformMessage	(		$to,
			$from,
		&	$subject,
		&	$headers,
		&	$body,
		&	$error
	)

This hook is called in UserMailer::send() to change email after it has gone through the MIME transform.

Since

1.35

Parameters

MailAddress[]	$to	Array of addresses of the targets
MailAddress	$from	Address of the sender
string	&$subject	Email subject (not MIME encoded)
array	&$headers	Email headers (except To: and Subject:) as an array of header name => value pairs
string	&$body	email body (in MIME format)
string	&$error	Error message

Returns

bool|void True or no return value to continue, or false and set $error to block sending the email

Implemented in MediaWiki\HookContainer\HookRunner.

---

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

• includes/mail/Hook/UserMailerTransformMessageHook.php