Page MenuHomeWickedGov Phorge
Files F1428901

ApiEmailUser.php
No OneTemporary
Actions

Size
3 KB
Referenced Files
None
Subscribers
None

ApiEmailUser.php
View Options

<?php
/**
* Copyright © 2008 Bryan Tong Minh <Bryan.TongMinh@Gmail.com>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
namespace MediaWiki\Api;
use MediaWiki\Context\RequestContext;
use MediaWiki\Mail\EmailUserFactory;
use MediaWiki\Status\Status;
use MediaWiki\User\UserFactory;
use Wikimedia\ParamValidator\ParamValidator;
/**
* API Module to facilitate sending of emails to users
* @ingroup API
*/
class ApiEmailUser extends ApiBase {
private EmailUserFactory $emailUserFactory;
private UserFactory $userFactory;
public function __construct( ApiMain $mainModule, string $moduleName,
EmailUserFactory $emailUserFactory, UserFactory $userFactory ) {
parent::__construct( $mainModule, $moduleName );
$this->emailUserFactory = $emailUserFactory;
$this->userFactory = $userFactory;
}
public function execute() {
$params = $this->extractRequestParams();
$emailUser = $this->emailUserFactory->newEmailUser( RequestContext::getMain()->getAuthority() );
$targetUser = $this->userFactory->newFromName( $params['target'] );
if ( $targetUser === null ) {
$this->dieWithError(
[ 'apierror-baduser', 'target', wfEscapeWikiText( $params['target'] ) ],
"baduser_target"
);
}
$status = $emailUser->validateTarget( $targetUser );
if ( !$status->isOK() ) {
$this->dieStatus( $status );
}
// Check permissions and errors
$error = $emailUser->canSend();
if ( !$error->isGood() ) {
$this->dieStatus( $error );
}
$retval = $emailUser->sendEmailUnsafe(
$targetUser,
$params['subject'],
$params['text'],
$params['ccme'],
$this->getLanguage()->getCode()
);
if ( !$retval instanceof Status ) {
// This is probably the reason
$retval = Status::newFatal( 'hookaborted' );
}
$result = array_filter( [
'result' => $retval->isGood() ? 'Success' : ( $retval->isOK() ? 'Warnings' : 'Failure' ),
'warnings' => $this->getErrorFormatter()->arrayFromStatus( $retval, 'warning' ),
'errors' => $this->getErrorFormatter()->arrayFromStatus( $retval, 'error' ),
] );
$this->getResult()->addValue( null, $this->getModuleName(), $result );
}
public function mustBePosted() {
return true;
}
public function isWriteMode() {
return true;
}
public function getAllowedParams() {
return [
'target' => [
ParamValidator::PARAM_TYPE => 'string',
ParamValidator::PARAM_REQUIRED => true
],
'subject' => [
ParamValidator::PARAM_TYPE => 'string',
ParamValidator::PARAM_REQUIRED => true
],
'text' => [
ParamValidator::PARAM_TYPE => 'text',
ParamValidator::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/Special:MyLanguage/API:Email';
}
}
/** @deprecated class alias since 1.43 */
class_alias( ApiEmailUser::class, 'ApiEmailUser' );

File Metadata

Mime Type
text/x-php
Expires
Sat, May 16, 16:48 (10 h, 53 m)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
cd/02/997c61d9cfcdea0eda5f5515e079
Default Alt Text
ApiEmailUser.php (3 KB)

Event Timeline