wiki.techinc.nl/includes/mail/Hook/UserMailerChangeReturnPathHook.php
daniel 2e57447c58 Document hook names in hook interfaces.
Bug: T258665
Change-Id: Ifddbf57f8aa2e3eb0d5845601376cbafa08ed407
2020-09-27 12:03:12 +02:00

26 lines
735 B
PHP

<?php
namespace MediaWiki\Hook;
use MailAddress;
/**
* This is a hook handler interface, see docs/Hooks.md.
* Use the hook name "UserMailerChangeReturnPath" to register handlers implementing this interface.
*
* @stable to implement
* @ingroup Hooks
*/
interface UserMailerChangeReturnPathHook {
/**
* This hook is called to generate a VERP return address
* when UserMailer sends an email, with a bounce handling extension.
*
* @since 1.35
*
* @param MailAddress[] $to Array of MailAddress objects for the recipients
* @param string &$returnPath Return address
* @return bool|void True or no return value to continue or false to abort
*/
public function onUserMailerChangeReturnPath( $to, &$returnPath );
}