ApiEmailUser.php

Go to the documentation of this file.

<?php
class ApiEmailUser extends ApiBase {

        public function __construct( $main, $action ) {
                parent::__construct( $main, $action );
        }

        public function execute() {
                $params = $this->extractRequestParams();

                // Validate target
                $targetUser = SpecialEmailUser::getTarget( $params['target'] );
                if ( !( $targetUser instanceof User ) ) {
                        $this->dieUsageMsg( array( $targetUser ) );
                }

                // Check permissions and errors
                $error = SpecialEmailUser::getPermissionsError( $this->getUser(), $params['token'] );
                if ( $error ) {
                        $this->dieUsageMsg( array( $error ) );
                }

                $data = array(
                        '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 = array( 'result' => 'Success' );
                } else {
                        $result = array(
                                '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 array(
                        'target' => array(
                                ApiBase::PARAM_TYPE => 'string',
                                ApiBase::PARAM_REQUIRED => true
                        ),
                        'subject' => null,
                        'text' => array(
                                ApiBase::PARAM_TYPE => 'string',
                                ApiBase::PARAM_REQUIRED => true
                        ),
                        'token' => array(
                                ApiBase::PARAM_TYPE => 'string',
                                ApiBase::PARAM_REQUIRED => true
                        ),
                        'ccme' => false,
                );
        }

        public function getParamDescription() {
                return array(
                        'target' => 'User to send email to',
                        'subject' => 'Subject header',
                        'text' => 'Mail body',
                        'token' => 'A token previously acquired via prop=info',
                        'ccme' => 'Send a copy of this mail to me',
                );
        }

        public function getResultProperties() {
                return array(
                        '' => array(
                                'result' => array(
                                        ApiBase::PROP_TYPE => array(
                                                'Success',
                                                'Failure'
                                        ),
                                ),
                                'message' => array(
                                        ApiBase::PROP_TYPE => 'string',
                                        ApiBase::PROP_NULLABLE => true
                                )
                        )
                );
        }

        public function getDescription() {
                return 'Email a user.';
        }

        public function getPossibleErrors() {
                return array_merge( parent::getPossibleErrors(), array(
                        array( 'usermaildisabled' ),
                ) );
        }

        public function needsToken() {
                return true;
        }

        public function getTokenSalt() {
                return '';
        }

        public function getExamples() {
                return array(
                        'api.php?action=emailuser&target=WikiSysop&text=Content' => 'Send an email to the User "WikiSysop" with the text "Content"',
                );
        }

        public function getHelpUrls() {
                return 'https://www.mediawiki.org/wiki/API:E-mail';
        }

        public function getVersion() {
                return __CLASS__ . ': $Id$';
        }
}