MediaWiki  1.23.2
Go to the documentation of this file.
1 <?php
31 class ApiEmailUser extends ApiBase {
33  public function execute() {
34  $params = $this->extractRequestParams();
36  // Validate target
37  $targetUser = SpecialEmailUser::getTarget( $params['target'] );
38  if ( !( $targetUser instanceof User ) ) {
39  $this->dieUsageMsg( array( $targetUser ) );
40  }
42  // Check permissions and errors
44  if ( $error ) {
45  $this->dieUsageMsg( array( $error ) );
46  }
48  $data = array(
49  'Target' => $targetUser->getName(),
50  'Text' => $params['text'],
51  'Subject' => $params['subject'],
52  'CCMe' => $params['ccme'],
53  );
54  $retval = SpecialEmailUser::submit( $data, $this->getContext() );
56  if ( $retval instanceof Status ) {
57  // SpecialEmailUser sometimes returns a status
58  // sometimes it doesn't.
59  if ( $retval->isGood() ) {
60  $retval = true;
61  } else {
62  $retval = $retval->getErrorsArray();
63  }
64  }
66  if ( $retval === true ) {
67  $result = array( 'result' => 'Success' );
68  } else {
69  $result = array(
70  'result' => 'Failure',
71  'message' => $retval
72  );
73  }
75  $this->getResult()->addValue( null, $this->getModuleName(), $result );
76  }
78  public function mustBePosted() {
79  return true;
80  }
82  public function isWriteMode() {
83  return true;
84  }
86  public function getAllowedParams() {
87  return array(
88  'target' => array(
89  ApiBase::PARAM_TYPE => 'string',
91  ),
92  'subject' => null,
93  'text' => array(
94  ApiBase::PARAM_TYPE => 'string',
96  ),
97  'token' => array(
98  ApiBase::PARAM_TYPE => 'string',
100  ),
101  'ccme' => false,
102  );
103  }
105  public function getParamDescription() {
106  return array(
107  'target' => 'User to send email to',
108  'subject' => 'Subject header',
109  'text' => 'Mail body',
110  'token' => 'A token previously acquired via prop=info',
111  'ccme' => 'Send a copy of this mail to me',
112  );
113  }
115  public function getResultProperties() {
116  return array(
117  '' => array(
118  'result' => array(
120  'Success',
121  'Failure'
122  ),
123  ),
124  'message' => array(
125  ApiBase::PROP_TYPE => 'string',
126  ApiBase::PROP_NULLABLE => true
127  )
128  )
129  );
130  }
132  public function getDescription() {
133  return 'Email a user.';
134  }
136  public function getPossibleErrors() {
137  return array_merge( parent::getPossibleErrors(), array(
138  array( 'usermaildisabled' ),
139  ) );
140  }
142  public function needsToken() {
143  return true;
144  }
146  public function getTokenSalt() {
147  return '';
148  }
150  public function getExamples() {
151  return array(
152  'api.php?action=emailuser&target=WikiSysop&text=Content'
153  => 'Send an email to the User "WikiSysop" with the text "Content"',
154  );
155  }
157  public function getHelpUrls() {
158  return '';
159  }
160 }
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. $reader:XMLReader object $logInfo:Array of information Return false to stop further processing of the tag 'ImportHandlePageXMLTag':When parsing a XML tag in a page. $reader:XMLReader object $pageInfo:Array of information Return false to stop further processing of the tag 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information Return false to stop further processing of the tag 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. $reader:XMLReader object Return false to stop further processing of the tag 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. $reader:XMLReader object $revisionInfo:Array of information Return false to stop further processing of the tag 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. $title:Title object for the current page $request:WebRequest $ignoreRedirect:boolean to skip redirect check $target:Title/string of redirect target $article:Article object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) $article:article(object) being checked 'IsTrustedProxy':Override the result of wfIsTrustedProxy() $ip:IP being check $result:Change this value to override the result of wfIsTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of User::isValidEmailAddr(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetMagic':DEPRECATED, use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetSpecialPageAliases':DEPRECATED, use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Associative array mapping language codes to prefixed links of the form "language:title". & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LinkBegin':Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1528
Get the RequestContext object.
Definition: ContextSource.php:40
skin txt MediaWiki includes four core it has been set as the default in MediaWiki since the replacing Monobook it had been been the default skin since before being replaced by Vector largely rewritten in while keeping its appearance Several legacy skins were removed in the as the burden of supporting them became too heavy to bear Those in etc for skin dependent CSS etc for skin dependent JavaScript These can also be customised on a per user by etc This feature has led to a wide variety of user styles becoming that gallery is a good place to ending in php
Definition: skin.txt:62
Definition: ApiBase.php:62
static getPermissionsError( $user, $editToken)
Check whether a user is allowed to send email.
Definition: SpecialEmailuser.php:212
Returns possible properties in the result, grouped by the value of the prop parameter that shows them...
Definition: ApiEmailUser.php:115
dieUsageMsg( $error)
Output the error message related to a certain array.
Definition: ApiBase.php:1929
Definition: ApiBase.php:50
Get the result object.
Definition: ApiBase.php:205
Indicates whether this module must be called with a POST request.
Definition: ApiEmailUser.php:78
Definition: styleTest.css.php:40
Get the User object.
Definition: ContextSource.php:132
This abstract class implements many basic API functions, and is the base of all API classes.
Definition: ApiBase.php:42
Generic operation result class Has warning/error list, boolean status and arbitrary value.
Definition: Status.php:40
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
Definition: ApiEmailUser.php:86
static getTarget( $target)
Validate target User.
Definition: SpecialEmailuser.php:180
the array() calling protocol came about after MediaWiki 1.4rc1.
List of Api Query prop modules.
Returns an array of parameter descriptions.
Definition: ApiEmailUser.php:105
Definition: ApiBase.php:74
extractRequestParams( $parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition: ApiBase.php:687
API Module to facilitate sending of emails to users.
Definition: ApiEmailUser.php:31
Evaluates the parameters, performs the requested query, and sets up the result.
Definition: ApiEmailUser.php:33
Returns a list of all possible errors returned by the module.
Definition: ApiEmailUser.php:136
Definition: ApiBase.php:76
Returns the token salt if there is one, '' if the module doesn't require a salt, else false if the mo...
Definition: ApiEmailUser.php:146
Returns usage examples for this module.
Definition: ApiEmailUser.php:150
static submit(array $data, IContextSource $context)
Really send a mail.
Definition: SpecialEmailuser.php:303
Get the name of the module being executed by this instance.
Definition: ApiBase.php:148
Returns the description string for this module.
Definition: ApiEmailUser.php:132
Indicates whether this module requires write mode.
Definition: ApiEmailUser.php:82
Definition: ApiEmailUser.php:157
usually copyright or history_copyright This message must be in HTML not wikitext $subpages will be ignored and the rest of subPageSubtitle() will run. 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink' whether MediaWiki currently thinks this is a CSS JS page Hooks may change this value to override the return value of Title::isCssOrJsPage(). 'TitleIsAlwaysKnown' whether MediaWiki currently thinks this page is known isMovable() always returns false. $title whether MediaWiki currently thinks this page is movable Hooks may change this value to override the return value of Title::isMovable(). 'TitleIsWikitextPage' whether MediaWiki currently thinks this is a wikitext page Hooks may change this value to override the return value of Title::isWikitextPage() 'TitleMove' use UploadVerification and UploadVerifyFile instead where the first element is the message key and the remaining elements are used as parameters to the message based on mime etc Preferred in most cases over UploadVerification object with all info about the upload string as detected by MediaWiki Handlers will typically only apply for specific mime types object & $error
Definition: hooks.txt:2573
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition: User.php:59
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account incomplete not yet checked for validity & $retval
Definition: hooks.txt:237
Returns whether this module requires a token to execute It is used to show possible errors in action=...
Definition: ApiEmailUser.php:142