4 * Created on June 1, 2008
5 * API for MediaWiki 1.8+
7 * Copyright (C) 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");
34 class ApiEmailUser
extends ApiBase
{
36 public function __construct($main, $action) {
37 parent
:: __construct($main, $action);
40 public function execute() {
43 // Check whether email is enabled
44 if ( !EmailUserForm
::userEmailEnabled() )
45 $this->dieUsageMsg( array( 'usermaildisabled' ) );
47 $this->getMain()->requestWriteMode();
48 $params = $this->extractRequestParams();
50 // Check required parameters
51 if ( !isset( $params['target'] ) )
52 $this->dieUsageMsg( array( 'missingparam', 'target' ) );
54 $targetUser = EmailUserForm
::validateEmailTarget( $params['target'] );
55 if( isset( $params['check'] ) )
56 if($targetUser instanceof User
) {
57 $result = array( 'result' => 'Enabled' );
58 $this->getResult()->addValue( null, $this->getModuleName(), $result );
62 $result = array( 'result' => 'Disabled' );
63 $this->getResult()->addValue( null, $this->getModuleName(), $result );
65 } //$this->dieUsageMsg( array( 'usermailenabled' ) ) : $this->dieUsageMsg( array( 'usermaildisabled' ) );
66 if ( !( $targetUser instanceof User
) )
67 $this->dieUsageMsg( array( $targetUser ) );
69 //Check more parameters
70 if ( !isset( $params['text'] ) )
71 $this->dieUsageMsg( array( 'missingparam', 'text' ) );
72 if ( !isset( $params['token'] ) )
73 $this->dieUsageMsg( array( 'missingparam', 'token' ) );
77 $error = EmailUserForm
::getPermissionsError( $wgUser, $params['token'] );
79 $this->dieUsageMsg( array( $error ) );
82 $form = new EmailUserForm( $targetUser, $params['text'], $params['subject'], $params['ccme'] );
83 $retval = $form->doSubmit();
84 if ( is_null( $retval ) )
85 $result = array( 'result' => 'Success' );
87 $result = array( 'result' => 'Failure',
88 'message' => $retval->getMessage() );
90 $this->getResult()->addValue( null, $this->getModuleName(), $result );
93 public function mustBePosted() { return true; }
95 public function getAllowedParams() {
106 public function getParamDescription() {
108 'target' => 'User to send email to',
109 'subject' => 'Subject header',
110 'text' => 'Mail body',
111 'token' => 'A token previously acquired via prop=info',
112 'ccme' => 'Send a copy of this mail to me',
113 'check' => 'Check if the user has email enabled',
117 public function getDescription() {
123 protected function getExamples() {
125 'api.php?action=emailuser&target=WikiSysop&text=Content',
126 'api.php?action=emailuser&target=WikiSysop&check=yes',
130 public function getVersion() {
131 return __CLASS__
. ': $Id$';