MediaWiki  master
UserMailer.php
Go to the documentation of this file.
1 <?php
30 class UserMailer {
31  private static $mErrorString;
32 
43  protected static function sendWithPear( $mailer, $dest, $headers, $body ) {
44  $mailResult = $mailer->send( $dest, $headers, $body );
45 
46  // Based on the result return an error string,
47  if ( PEAR::isError( $mailResult ) ) {
48  wfDebug( "PEAR::Mail failed: " . $mailResult->getMessage() . "\n" );
49  return Status::newFatal( 'pear-mail-error', $mailResult->getMessage() );
50  } else {
51  return Status::newGood();
52  }
53  }
54 
67  private static function arrayToHeaderString( $headers, $endl = PHP_EOL ) {
68  $strings = [];
69  foreach ( $headers as $name => $value ) {
70  // Prevent header injection by stripping newlines from value
71  $value = self::sanitizeHeaderValue( $value );
72  $strings[] = "$name: $value";
73  }
74  return implode( $endl, $strings );
75  }
76 
82  private static function makeMsgId() {
83  global $wgSMTP, $wgServer;
84 
85  $domainId = WikiMap::getCurrentWikiDbDomain()->getId();
86  $msgid = uniqid( $domainId . ".", true );
87  if ( is_array( $wgSMTP ) && isset( $wgSMTP['IDHost'] ) && $wgSMTP['IDHost'] ) {
88  $domain = $wgSMTP['IDHost'];
89  } else {
90  $url = wfParseUrl( $wgServer );
91  $domain = $url['host'];
92  }
93  return "<$msgid@$domain>";
94  }
95 
115  public static function send( $to, $from, $subject, $body, $options = [] ) {
116  global $wgAllowHTMLEmail;
117 
118  if ( !isset( $options['contentType'] ) ) {
119  $options['contentType'] = 'text/plain; charset=UTF-8';
120  }
121 
122  if ( !is_array( $to ) ) {
123  $to = [ $to ];
124  }
125 
126  // mail body must have some content
127  $minBodyLen = 10;
128  // arbitrary but longer than Array or Object to detect casting error
129 
130  // body must either be a string or an array with text and body
131  if (
132  !(
133  !is_array( $body ) &&
134  strlen( $body ) >= $minBodyLen
135  )
136  &&
137  !(
138  is_array( $body ) &&
139  isset( $body['text'] ) &&
140  isset( $body['html'] ) &&
141  strlen( $body['text'] ) >= $minBodyLen &&
142  strlen( $body['html'] ) >= $minBodyLen
143  )
144  ) {
145  // if it is neither we have a problem
146  return Status::newFatal( 'user-mail-no-body' );
147  }
148 
149  if ( !$wgAllowHTMLEmail && is_array( $body ) ) {
150  // HTML not wanted. Dump it.
151  $body = $body['text'];
152  }
153 
154  wfDebug( __METHOD__ . ': sending mail to ' . implode( ', ', $to ) . "\n" );
155 
156  // Make sure we have at least one address
157  $has_address = false;
158  foreach ( $to as $u ) {
159  if ( $u->address ) {
160  $has_address = true;
161  break;
162  }
163  }
164  if ( !$has_address ) {
165  return Status::newFatal( 'user-mail-no-addy' );
166  }
167 
168  // give a chance to UserMailerTransformContents subscribers who need to deal with each
169  // target differently to split up the address list
170  if ( count( $to ) > 1 ) {
171  $oldTo = $to;
172  Hooks::run( 'UserMailerSplitTo', [ &$to ] );
173  if ( $oldTo != $to ) {
174  $splitTo = array_diff( $oldTo, $to );
175  $to = array_diff( $oldTo, $splitTo ); // ignore new addresses added in the hook
176  // first send to non-split address list, then to split addresses one by one
178  if ( $to ) {
179  $status->merge( self::sendInternal(
180  $to, $from, $subject, $body, $options ) );
181  }
182  foreach ( $splitTo as $newTo ) {
183  $status->merge( self::sendInternal(
184  [ $newTo ], $from, $subject, $body, $options ) );
185  }
186  return $status;
187  }
188  }
189 
190  return self::sendInternal( $to, $from, $subject, $body, $options );
191  }
192 
199  private static function isMailMimeUsable() {
200  static $usable = null;
201  if ( $usable === null ) {
202  $usable = class_exists( 'Mail_mime' );
203  }
204  return $usable;
205  }
206 
213  private static function isMailUsable() {
214  static $usable = null;
215  if ( $usable === null ) {
216  $usable = class_exists( 'Mail' );
217  }
218 
219  return $usable;
220  }
221 
238  protected static function sendInternal(
239  array $to,
240  MailAddress $from,
241  $subject,
242  $body,
243  $options = []
244  ) {
246  $mime = null;
247 
248  $replyto = $options['replyTo'] ?? null;
249  $contentType = $options['contentType'] ?? 'text/plain; charset=UTF-8';
250  $headers = $options['headers'] ?? [];
251 
252  // Allow transformation of content, such as encrypting/signing
253  $error = false;
254  if ( !Hooks::run( 'UserMailerTransformContent', [ $to, $from, &$body, &$error ] ) ) {
255  if ( $error ) {
256  return Status::newFatal( 'php-mail-error', $error );
257  } else {
258  return Status::newFatal( 'php-mail-error-unknown' );
259  }
260  }
261 
291  $headers['From'] = $from->toString();
292  $returnPath = $from->address;
293  $extraParams = $wgAdditionalMailParams;
294 
295  // Hook to generate custom VERP address for 'Return-Path'
296  Hooks::run( 'UserMailerChangeReturnPath', [ $to, &$returnPath ] );
297  // Add the envelope sender address using the -f command line option when PHP mail() is used.
298  // Will default to the $from->address when the UserMailerChangeReturnPath hook fails and the
299  // generated VERP address when the hook runs effectively.
300 
301  // PHP runs this through escapeshellcmd(). However that's not sufficient
302  // escaping (e.g. due to spaces). MediaWiki's email sanitizer should generally
303  // be good enough, but just in case, put in double quotes, and remove any
304  // double quotes present (" is not allowed in emails, so should have no
305  // effect, although this might cause apostrophees to be double escaped)
306  $returnPathCLI = '"' . str_replace( '"', '', $returnPath ) . '"';
307  $extraParams .= ' -f ' . $returnPathCLI;
308 
309  $headers['Return-Path'] = $returnPath;
310 
311  if ( $replyto ) {
312  $headers['Reply-To'] = $replyto->toString();
313  }
314 
315  $headers['Date'] = MWTimestamp::getLocalInstance()->format( 'r' );
316  $headers['Message-ID'] = self::makeMsgId();
317  $headers['X-Mailer'] = 'MediaWiki mailer';
318  $headers['List-Unsubscribe'] = '<' . SpecialPage::getTitleFor( 'Preferences' )
319  ->getFullURL( '', false, PROTO_CANONICAL ) . '>';
320 
321  // Line endings need to be different on Unix and Windows due to
322  // the bug described at https://core.trac.wordpress.org/ticket/2603
323  $endl = PHP_EOL;
324 
325  if ( is_array( $body ) ) {
326  // we are sending a multipart message
327  wfDebug( "Assembling multipart mime email\n" );
328  if ( !self::isMailMimeUsable() ) {
329  wfDebug( "PEAR Mail_Mime package is not installed. Falling back to text email.\n" );
330  // remove the html body for text email fall back
331  $body = $body['text'];
332  } else {
333  // pear/mail_mime is already loaded by this point
334  if ( wfIsWindows() ) {
335  $body['text'] = str_replace( "\n", "\r\n", $body['text'] );
336  $body['html'] = str_replace( "\n", "\r\n", $body['html'] );
337  }
338  $mime = new Mail_mime( [
339  'eol' => $endl,
340  'text_charset' => 'UTF-8',
341  'html_charset' => 'UTF-8'
342  ] );
343  $mime->setTXTBody( $body['text'] );
344  $mime->setHTMLBody( $body['html'] );
345  $body = $mime->get(); // must call get() before headers()
346  $headers = $mime->headers( $headers );
347  }
348  }
349  if ( $mime === null ) {
350  // sending text only, either deliberately or as a fallback
351  if ( wfIsWindows() ) {
352  $body = str_replace( "\n", "\r\n", $body );
353  }
354  $headers['MIME-Version'] = '1.0';
355  $headers['Content-type'] = $contentType;
356  $headers['Content-transfer-encoding'] = '8bit';
357  }
358 
359  // allow transformation of MIME-encoded message
360  if ( !Hooks::run( 'UserMailerTransformMessage',
361  [ $to, $from, &$subject, &$headers, &$body, &$error ] )
362  ) {
363  if ( $error ) {
364  return Status::newFatal( 'php-mail-error', $error );
365  } else {
366  return Status::newFatal( 'php-mail-error-unknown' );
367  }
368  }
369 
370  $ret = Hooks::run( 'AlternateUserMailer', [ $headers, $to, $from, $subject, $body ] );
371  if ( $ret === false ) {
372  // the hook implementation will return false to skip regular mail sending
373  return Status::newGood();
374  } elseif ( $ret !== true ) {
375  // the hook implementation will return a string to pass an error message
376  return Status::newFatal( 'php-mail-error', $ret );
377  }
378 
379  if ( is_array( $wgSMTP ) ) {
380  // Check if pear/mail is already loaded (via composer)
381  if ( !self::isMailUsable() ) {
382  throw new MWException( 'PEAR mail package is not installed' );
383  }
384 
385  Wikimedia\suppressWarnings();
386 
387  // Create the mail object using the Mail::factory method
388  $mail_object = Mail::factory( 'smtp', $wgSMTP );
389  if ( PEAR::isError( $mail_object ) ) {
390  wfDebug( "PEAR::Mail factory failed: " . $mail_object->getMessage() . "\n" );
391  Wikimedia\restoreWarnings();
392  return Status::newFatal( 'pear-mail-error', $mail_object->getMessage() );
393  }
394 
395  wfDebug( "Sending mail via PEAR::Mail\n" );
396 
397  $headers['Subject'] = self::quotedPrintable( $subject );
398 
399  // When sending only to one recipient, shows it its email using To:
400  if ( count( $to ) == 1 ) {
401  $headers['To'] = $to[0]->toString();
402  }
403 
404  // Split jobs since SMTP servers tends to limit the maximum
405  // number of possible recipients.
406  $chunks = array_chunk( $to, $wgEnotifMaxRecips );
407  foreach ( $chunks as $chunk ) {
408  $status = self::sendWithPear( $mail_object, $chunk, $headers, $body );
409  // FIXME : some chunks might be sent while others are not!
410  if ( !$status->isOK() ) {
411  Wikimedia\restoreWarnings();
412  return $status;
413  }
414  }
415  Wikimedia\restoreWarnings();
416  return Status::newGood();
417  } else {
418  // PHP mail()
419  if ( count( $to ) > 1 ) {
420  $headers['To'] = 'undisclosed-recipients:;';
421  }
422  $headers = self::arrayToHeaderString( $headers, $endl );
423 
424  wfDebug( "Sending mail via internal mail() function\n" );
425 
426  self::$mErrorString = '';
427  $html_errors = ini_get( 'html_errors' );
428  ini_set( 'html_errors', '0' );
429  set_error_handler( 'UserMailer::errorHandler' );
430 
431  try {
432  foreach ( $to as $recip ) {
433  $sent = mail(
434  $recip->toString(),
435  self::quotedPrintable( $subject ),
436  $body,
437  $headers,
438  $extraParams
439  );
440  }
441  } catch ( Exception $e ) {
442  restore_error_handler();
443  throw $e;
444  }
445 
446  restore_error_handler();
447  ini_set( 'html_errors', $html_errors );
448 
449  if ( self::$mErrorString ) {
450  wfDebug( "Error sending mail: " . self::$mErrorString . "\n" );
451  return Status::newFatal( 'php-mail-error', self::$mErrorString );
452  } elseif ( !$sent ) {
453  // mail function only tells if there's an error
454  wfDebug( "Unknown error sending mail\n" );
455  return Status::newFatal( 'php-mail-error-unknown' );
456  } else {
457  return Status::newGood();
458  }
459  }
460  }
461 
468  private static function errorHandler( $code, $string ) {
469  self::$mErrorString = preg_replace( '/^mail\(\)(\s*\[.*?\])?: /', '', $string );
470  }
471 
477  public static function sanitizeHeaderValue( $val ) {
478  return strtr( $val, [ "\r" => '', "\n" => '' ] );
479  }
480 
486  public static function rfc822Phrase( $phrase ) {
487  // Remove line breaks
488  $phrase = self::sanitizeHeaderValue( $phrase );
489  // Remove quotes
490  $phrase = str_replace( '"', '', $phrase );
491  return '"' . $phrase . '"';
492  }
493 
507  public static function quotedPrintable( $string, $charset = '' ) {
508  // Probably incomplete; see RFC 2045
509  if ( empty( $charset ) ) {
510  $charset = 'UTF-8';
511  }
512  $charset = strtoupper( $charset );
513  $charset = str_replace( 'ISO-8859', 'ISO8859', $charset ); // ?
514 
515  $illegal = '\x00-\x08\x0b\x0c\x0e-\x1f\x7f-\xff=';
516  $replace = $illegal . '\t ?_';
517  if ( !preg_match( "/[$illegal]/", $string ) ) {
518  return $string;
519  }
520  $out = "=?$charset?Q?";
521  $out .= preg_replace_callback( "/([$replace])/",
522  function ( $matches ) {
523  return sprintf( "=%02X", ord( $matches[1] ) );
524  },
525  $string
526  );
527  $out .= '?=';
528  return $out;
529  }
530 }
address of the mail
Collection of static functions for sending mail.
Definition: UserMailer.php:30
static getLocalInstance( $ts=false)
Get a timestamp instance in the server local timezone ($wgLocaltimezone)
static send( $to, $from, $subject, $body, $options=[])
This function will perform a direct (authenticated) login to a SMTP Server to use for mail relaying i...
Definition: UserMailer.php:115
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses & $ret
Definition: hooks.txt:1972
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2147
wfParseUrl( $url)
parse_url() work-alike, but non-broken.
$wgAdditionalMailParams
Additional email parameters, will be passed as the last argument to mail() call.
$value
static sendWithPear( $mailer, $dest, $headers, $body)
Send mail using a PEAR mailer.
Definition: UserMailer.php:43
wfIsWindows()
Check if the operating system is Windows.
$wgSMTP
SMTP Mode.
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output $out
Definition: hooks.txt:767
static newFatal( $message)
Factory function for fatal errors.
Definition: StatusValue.php:68
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action, or null $user:User who performed the tagging when the tagging is subsequent to the action, or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, whether it is OK to use $contentModel on $title. Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy:boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'ContentSecurityPolicyDefaultSource':Modify the allowed CSP load sources. This affects all directives except for the script directive. If you want to add a script source, see ContentSecurityPolicyScriptSource hook. & $defaultSrc:Array of Content-Security-Policy allowed sources $policyConfig:Current configuration for the Content-Security-Policy header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyDirectives':Modify the content security policy directives. Use this only if ContentSecurityPolicyDefaultSource and ContentSecurityPolicyScriptSource do not meet your needs. & $directives:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyScriptSource':Modify the allowed CSP script sources. Note that you also have to use ContentSecurityPolicyDefaultSource if you want non-script sources to be loaded from whatever you add. & $scriptSrc:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DeleteUnknownPreferences':Called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about. This hook is used by extensions that have dynamically-named preferences that should not be deleted in the usual cleanup process. For example, the Gadgets extension creates preferences prefixed with 'gadget-', and so anything with that prefix is excluded from the deletion. &where:An array that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted from the user_properties table. $db:The IDatabase object, useful for accessing $db->buildLike() etc. 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
Definition: hooks.txt:1244
Stores a single person&#39;s name and email address.
Definition: MailAddress.php:32
static newGood( $value=null)
Factory function for good results.
Definition: StatusValue.php:81
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped & $options
Definition: hooks.txt:1972
static arrayToHeaderString( $headers, $endl=PHP_EOL)
Creates a single string from an associative array.
Definition: UserMailer.php:67
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:767
toString()
Return formatted and quoted address to insert into SMTP headers.
Definition: MailAddress.php:74
static getTitleFor( $name, $subpage=false, $fragment='')
Get a localised Title object for a specified special page name If you don&#39;t need a full Title object...
Definition: SpecialPage.php:83
static makeMsgId()
Create a value suitable for the MessageId Header.
Definition: UserMailer.php:82
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable & $code
Definition: hooks.txt:767
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
static getCurrentWikiDbDomain()
Definition: WikiMap.php:293
static sendInternal(array $to, MailAddress $from, $subject, $body, $options=[])
Helper function fo UserMailer::send() which does the actual sending.
Definition: UserMailer.php:238
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
const PROTO_CANONICAL
Definition: Defines.php:203
$wgEnotifMaxRecips
Maximum number of users to mail at once when using impersonal mail.
static rfc822Phrase( $phrase)
Converts a string into a valid RFC 822 "phrase", such as is used for the sender name.
Definition: UserMailer.php:486
static sanitizeHeaderValue( $val)
Strips bad characters from a header value to prevent PHP mail header injection attacks.
Definition: UserMailer.php:477
$wgAllowHTMLEmail
For parts of the system that have been updated to provide HTML email content, send both text and HTML...
static isMailUsable()
Whether the PEAR Mail library is usable.
Definition: UserMailer.php:213
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
$wgServer
URL of the server.
static isMailMimeUsable()
Whether the PEAR Mail_mime library is usable.
Definition: UserMailer.php:199
static errorHandler( $code, $string)
Set the mail error message in self::$mErrorString.
Definition: UserMailer.php:468
static $mErrorString
Definition: UserMailer.php:31
static quotedPrintable( $string, $charset='')
Converts a string into quoted-printable format.
Definition: UserMailer.php:507
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:200
$matches