4 * Created on June 1, 2008
5 * API for MediaWiki 1.8+
7 * Copyright © 2008 Bryan Tong Minh <Bryan.TongMinh@Gmail.com>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
22 * http://www.gnu.org/copyleft/gpl.html
25 if ( !defined( 'MEDIAWIKI' ) ) {
26 // Eclipse helper - will be ignored in production
27 require_once( "ApiBase.php" );
31 * API Module to facilitate sending of emails to users
34 class ApiEmailUser
extends ApiBase
{
36 public function __construct( $main, $action ) {
37 parent
::__construct( $main, $action );
40 public function execute() {
43 $params = $this->extractRequestParams();
44 // Check required parameters
45 if ( !isset( $params['target'] ) ) {
46 $this->dieUsageMsg( array( 'missingparam', 'target' ) );
48 if ( !isset( $params['text'] ) ) {
49 $this->dieUsageMsg( array( 'missingparam', 'text' ) );
53 $targetUser = SpecialEmailuser
::getTarget( $params['target'] );
54 if ( !( $targetUser instanceof User
) ) {
55 $this->dieUsageMsg( array( $targetUser ) );
58 // Check permissions and errors
59 $error = SpecialEmailuser
::getPermissionsError( $wgUser, $params['token'] );
61 $this->dieUsageMsg( array( $error ) );
65 'Target' => $targetUser->getName(),
66 'Text' => $params['text'],
67 'Subject' => $params['subject'],
68 'CCMe' => $params['ccme'],
70 $retval = SpecialEmailuser
::submit( $data );
71 if ( $retval === true ) {
72 $result = array( 'result' => 'Success' );
75 'result' => 'Failure',
80 $this->getResult()->addValue( null, $this->getModuleName(), $result );
83 public function mustBePosted() {
87 public function isWriteMode() {
91 public function getAllowedParams() {
101 public function getParamDescription() {
103 'target' => 'User to send email to',
104 'subject' => 'Subject header',
105 'text' => 'Mail body',
106 'token' => 'A token previously acquired via prop=info',
107 'ccme' => 'Send a copy of this mail to me',
111 public function getDescription() {
112 return 'Email a user.';
115 public function getPossibleErrors() {
116 return array_merge( parent
::getPossibleErrors(), array(
117 array( 'usermaildisabled' ),
118 array( 'missingparam', 'target' ),
119 array( 'missingparam', 'text' ),
123 public function getTokenSalt() {
127 protected function getExamples() {
129 'api.php?action=emailuser&target=WikiSysop&text=Content'
133 public function getVersion() {
134 return __CLASS__
. ': $Id$';