ApiEmailUser.php

Go to the documentation of this file.

<?php
class ApiEmailUser extends ApiBase {
 
    public function execute() {
        $params = $this->extractRequestParams();
 
        // Validate target
        $targetUser = SpecialEmailUser::getTarget( $params['target'] );
        if ( !( $targetUser instanceof User ) ) {
            $this->dieUsageMsg( [ $targetUser ] );
        }
 
        // Check permissions and errors
        $error = SpecialEmailUser::getPermissionsError(
            $this->getUser(),
            $params['token'],
            $this->getConfig()
        );
        if ( $error ) {
            $this->dieUsageMsg( [ $error ] );
        }
 
        $data = [
            'Target' => $targetUser->getName(),
            'Text' => $params['text'],
            'Subject' => $params['subject'],
            'CCMe' => $params['ccme'],
        ];
        $retval = SpecialEmailUser::submit( $data, $this->getContext() );
 
        if ( $retval instanceof Status ) {
            // SpecialEmailUser sometimes returns a status
            // sometimes it doesn't.
            if ( $retval->isGood() ) {
                $retval = true;
            } else {
                $retval = $retval->getErrorsArray();
            }
        }
 
        if ( $retval === true ) {
            $result = [ 'result' => 'Success' ];
        } else {
            $result = [
                'result' => 'Failure',
                'message' => $retval
            ];
        }
 
        $this->getResult()->addValue( null, $this->getModuleName(), $result );
    }
 
    public function mustBePosted() {
        return true;
    }
 
    public function isWriteMode() {
        return true;
    }
 
    public function getAllowedParams() {
        return [
            'target' => [
                ApiBase::PARAM_TYPE => 'string',
                ApiBase::PARAM_REQUIRED => true
            ],
            'subject' => null,
            'text' => [
                ApiBase::PARAM_TYPE => 'text',
                ApiBase::PARAM_REQUIRED => true
            ],
            'ccme' => false,
        ];
    }
 
    public function needsToken() {
        return 'csrf';
    }
 
    protected function getExamplesMessages() {
        return [
            'action=emailuser&target=WikiSysop&text=Content&token=123ABC'
                => 'apihelp-emailuser-example-email',
        ];
    }
 
    public function getHelpUrls() {
        return 'https://www.mediawiki.org/wiki/API:Email';
    }
}