includes/mail/Hook/UserMailerSplitToHook.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 "UserMailerSplitTo" to register handlers implementing this interface.
  10  *
  11  * @stable to implement
  12  * @ingroup Hooks
  13  */
  14 interface UserMailerSplitToHook {
  15         /**
  16          * This hook is called in UserMailer::send() to give extensions a chance
  17          * to split up an email with multiple To: fields into separate emails.
  18          *
  19          * @since 1.35
  20          *
  21          * @param MailAddress[] &$to Unset the ones which should be mailed separately
  22          * @return bool|void True or no return value to continue or false to abort
  23          */
  24         public function onUserMailerSplitTo( &$to );
  25 }