MediaWiki  master
MediaWiki\Hook\UserMailerTransformMessageHook Interface Reference

Stable to implement. 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. More...
 

Detailed Description

Stable to implement.

Definition at line 11 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[]$toArray of addresses of the targets
MailAddress$fromAddress of the sender
string&$subjectEmail subject (not MIME encoded)
array&$headersEmail headers (except To: and Subject:) as an array of header name => value pairs
string&$bodyemail body (in MIME format)
string&$errorError 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: