1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
|
<?php
/**
*
*
* Created on June 1, 2008
*
* 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
*/
/**
* API Module to facilitate sending of emails to users
* @ingroup API
*/
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';
}
}
|
