MediaWiki\Hook\AlternateUserMailerHook Interface Reference

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

Inheritance diagram for MediaWiki\Hook\AlternateUserMailerHook:

Public Member Functions
	onAlternateUserMailer ( $headers, $to, $from, $subject, $body)
	This hook is called before mail is sent so that mail could be logged (or something else) instead of using PEAR or PHP's mail().

Detailed Description

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

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

Stability: stable

to implement

Definition at line 14 of file AlternateUserMailerHook.php.

Member Function Documentation

onAlternateUserMailer()

MediaWiki\Hook\AlternateUserMailerHook::onAlternateUserMailer	(		$headers,
			$to,
			$from,
			$subject,
			$body
	)

This hook is called before mail is sent so that mail could be logged (or something else) instead of using PEAR or PHP's mail().

Since

1.35

Parameters

array	$headers	Associative array of headers for the email
MailAddress | array	$to	To address
MailAddress	$from	From address
string	$subject	Subject of the email
string	$body	Body of the message

Returns

bool|string|void True or no return value to continue sending email in the regular way, or false to skip the regular method of sending mail. Return a string to return a php-mail-error message containing the error.

Implemented in MediaWiki\HookContainer\HookRunner.

---

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

• includes/mail/Hook/AlternateUserMailerHook.php