master/php/EmailUserSendEmailHook_8php_source.html

<?php


namespace MediaWiki\Mail\Hook;


use MailAddress;

use MediaWiki\Mail\UserEmailContact;

use MediaWiki\Permissions\Authority;

use StatusValue;


interface EmailUserSendEmailHook {

    public function onEmailUserSendEmail(

        Authority $from,

        MailAddress $fromAddress,

        UserEmailContact $to,

        MailAddress $toAddress,

        string $subject,

        string $text,

        StatusValue $status

    );

}


MailAddress
Represent and format a single name and email address pair for SMTP.
Definition MailAddress.php:36

StatusValue
Generic operation result class Has warning/error list, boolean status and arbitrary value.
Definition StatusValue.php:49

MediaWiki\Mail\Hook\EmailUserSendEmailHook
This is a hook handler interface, see docs/Hooks.md.
Definition EmailUserSendEmailHook.php:18

MediaWiki\Mail\Hook\EmailUserSendEmailHook\onEmailUserSendEmail
onEmailUserSendEmail(Authority $from, MailAddress $fromAddress, UserEmailContact $to, MailAddress $toAddress, string $subject, string $text, StatusValue $status)
This hook is called before sending an email, when all other checks have succeeded.

MediaWiki\Mail\UserEmailContact
Definition UserEmailContact.php:11

MediaWiki\Permissions\Authority
This interface represents the authority associated with the current execution context,...
Definition Authority.php:37

MediaWiki\Mail\Hook
Definition EmailUserAuthorizeSendHook.php:3