includes/mail/Hook/UserMailerChangeReturnPathHook.php

   1 <?php
   2
   3 namespace MediaWiki\Hook;
   4
   5 use MailAddress;
   6
   7 /**
   8  * This is a hook handler interface, see docs/Hooks.md.
   9  * Use the hook name "UserMailerChangeReturnPath" to register handlers implementing this interface.
  10  *
  11  * @stable to implement
  12  * @ingroup Hooks
  13  */
  14 interface UserMailerChangeReturnPathHook {
  15         /**
  16          * This hook is called to generate a VERP return address
  17          * when UserMailer sends an email, with a bounce handling extension.
  18          *
  19          * @since 1.35
  20          *
  21          * @param MailAddress[] $to Array of MailAddress objects for the recipients
  22          * @param string &$returnPath Return address
  23          * @return bool|void True or no return value to continue or false to abort
  24          */
  25         public function onUserMailerChangeReturnPath( $to, &$returnPath );
  26 }