includes/mail/Hook/SendWatchlistEmailNotificationHook.php

   1 <?php
   2
   3 namespace MediaWiki\Hook;
   4
   5 use EmailNotification;
   6 use MediaWiki\Title\Title;
   7 use MediaWiki\User\User;
   8
   9 /**
  10  * This is a hook handler interface, see docs/Hooks.md.
  11  * Use the hook name "SendWatchlistEmailNotification" to register handlers implementing this interface.
  12  *
  13  * @stable to implement
  14  * @ingroup Hooks
  15  */
  16 interface SendWatchlistEmailNotificationHook {
  17         /**
  18          * Use this hook to cancel watchlist email notifications (enotifwatchlist) for an edit.
  19          *
  20          * @since 1.35
  21          *
  22          * @param User $targetUser User whom to send watchlist email notification
  23          * @param Title $title Page title
  24          * @param EmailNotification $enotif
  25          * @return bool|void True or no return value to send watchlist email
  26          *   notification, or false to abort
  27          */
  28         public function onSendWatchlistEmailNotification( $targetUser, $title, $enotif );
  29 }