MediaWiki  master
MediaWiki\Hook\UserMailerChangeReturnPathHook Interface Reference

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

Inheritance diagram for MediaWiki\Hook\UserMailerChangeReturnPathHook:

Public Member Functions

 onUserMailerChangeReturnPath ( $to, &$returnPath)
 This hook is called to generate a VERP return address when UserMailer sends an email, with a bounce handling extension. More...
 

Detailed Description

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

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

Stable to implement

Definition at line 14 of file UserMailerChangeReturnPathHook.php.

Member Function Documentation

◆ onUserMailerChangeReturnPath()

MediaWiki\Hook\UserMailerChangeReturnPathHook::onUserMailerChangeReturnPath (   $to,
$returnPath 
)

This hook is called to generate a VERP return address when UserMailer sends an email, with a bounce handling extension.

Since
1.35
Parameters
MailAddress[]$toArray of MailAddress objects for the recipients
string&$returnPathReturn address
Returns
bool|void True or no return value to continue or false to abort

Implemented in MediaWiki\HookContainer\HookRunner.


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