3 * Classes used to send e-mails
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
21 * @author <brion@pobox.com>
22 * @author <mail@tgries.de>
23 * @author Tim Starling
24 * @author Luke Welling lwelling@wikimedia.org
28 * Collection of static functions for sending mail
31 private static $mErrorString;
34 * Send mail using a PEAR mailer
36 * @param UserMailer $mailer
38 * @param string $headers
43 protected static function sendWithPear( $mailer, $dest, $headers, $body ) {
44 $mailResult = $mailer->send( $dest, $headers, $body );
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() );
51 return Status
::newGood();
56 * Creates a single string from an associative array
58 * @param array $headers Associative Array: keys are header field names,
59 * values are ... values.
60 * @param string $endl The end of line character. Defaults to "\n"
62 * Note RFC2822 says newlines must be CRLF (\r\n)
63 * but php mail naively "corrects" it and requires \n for the "correction" to work
67 static function arrayToHeaderString( $headers, $endl = "\n" ) {
69 foreach ( $headers as $name => $value ) {
70 // Prevent header injection by stripping newlines from value
71 $value = self
::sanitizeHeaderValue( $value );
72 $strings[] = "$name: $value";
74 return implode( $endl, $strings );
78 * Create a value suitable for the MessageId Header
82 static function makeMsgId() {
83 global $wgSMTP, $wgServer;
85 $msgid = uniqid( wfWikiID() . ".", true ); /* true required for cygwin */
86 if ( is_array( $wgSMTP ) && isset( $wgSMTP['IDHost'] ) && $wgSMTP['IDHost'] ) {
87 $domain = $wgSMTP['IDHost'];
89 $url = wfParseUrl( $wgServer );
90 $domain = $url['host'];
92 return "<$msgid@$domain>";
96 * This function will perform a direct (authenticated) login to
97 * a SMTP Server to use for mail relaying if 'wgSMTP' specifies an
98 * array of parameters. It requires PEAR:Mail to do that.
99 * Otherwise it just uses the standard PHP 'mail' function.
101 * @param MailAddress|MailAddress[] $to Recipient's email (or an array of them)
102 * @param MailAddress $from Sender's email
103 * @param string $subject Email's subject.
104 * @param string $body Email's text or Array of two strings to be the text and html bodies
105 * @param array $options:
106 * 'replyTo' MailAddress
107 * 'contentType' string default 'text/plain; charset=UTF-8'
108 * 'headers' array Extra headers to set
110 * Previous versions of this function had $replyto as the 5th argument and $contentType
111 * as the 6th. These are still supported for backwards compatability, but deprecated.
113 * @throws MWException
117 public static function send( $to, $from, $subject, $body, $options = array() ) {
118 global $wgSMTP, $wgEnotifMaxRecips, $wgAdditionalMailParams, $wgAllowHTMLEmail;
119 $contentType = 'text/plain; charset=UTF-8';
121 if ( is_array( $options ) ) {
122 $replyto = isset( $options['replyTo'] ) ?
$options['replyTo'] : null;
123 $contentType = isset( $options['contentType'] ) ?
$options['contentType'] : $contentType;
124 $headers = isset( $options['headers'] ) ?
$options['headers'] : $headers;
127 wfDeprecated( __METHOD__
. ' with $replyto as 5th parameter', '1.26' );
129 if ( func_num_args() === 6 ) {
130 $contentType = func_get_arg( 5 );
135 if ( !is_array( $to ) ) {
139 // mail body must have some content
141 // arbitrary but longer than Array or Object to detect casting error
143 // body must either be a string or an array with text and body
146 !is_array( $body ) &&
147 strlen( $body ) >= $minBodyLen
152 isset( $body['text'] ) &&
153 isset( $body['html'] ) &&
154 strlen( $body['text'] ) >= $minBodyLen &&
155 strlen( $body['html'] ) >= $minBodyLen
158 // if it is neither we have a problem
159 return Status
::newFatal( 'user-mail-no-body' );
162 if ( !$wgAllowHTMLEmail && is_array( $body ) ) {
163 // HTML not wanted. Dump it.
164 $body = $body['text'];
167 wfDebug( __METHOD__
. ': sending mail to ' . implode( ', ', $to ) . "\n" );
169 // Make sure we have at least one address
170 $has_address = false;
171 foreach ( $to as $u ) {
177 if ( !$has_address ) {
178 return Status
::newFatal( 'user-mail-no-addy' );
182 * Forge email headers
183 * -------------------
187 * DO NOT add To: or Subject: headers at this step. They need to be
188 * handled differently depending upon the mailer we are going to use.
191 * PHP mail() first argument is the mail receiver. The argument is
192 * used as a recipient destination and as a To header.
194 * PEAR mailer has a recipient argument which is only used to
195 * send the mail. If no To header is given, PEAR will set it to
196 * to 'undisclosed-recipients:'.
198 * NOTE: To: is for presentation, the actual recipient is specified
199 * by the mailer using the Rcpt-To: header.
202 * PHP mail() second argument to pass the subject, passing a Subject
203 * as an additional header will result in a duplicate header.
205 * PEAR mailer should be passed a Subject header.
210 $headers['From'] = $from->toString();
211 $returnPath = $from->address
;
212 $extraParams = $wgAdditionalMailParams;
214 // Hook to generate custom VERP address for 'Return-Path'
215 Hooks
::run( 'UserMailerChangeReturnPath', array( $to, &$returnPath ) );
216 // Add the envelope sender address using the -f command line option when PHP mail() is used.
217 // Will default to the $from->address when the UserMailerChangeReturnPath hook fails and the
218 // generated VERP address when the hook runs effectively.
219 $extraParams .= ' -f ' . $returnPath;
221 $headers['Return-Path'] = $returnPath;
224 $headers['Reply-To'] = $replyto->toString();
227 $headers['Date'] = MWTimestamp
::getLocalInstance()->format( 'r' );
228 $headers['Message-ID'] = self
::makeMsgId();
229 $headers['X-Mailer'] = 'MediaWiki mailer';
230 $headers['List-Unsubscribe'] = '<' . SpecialPage
::getTitleFor( 'Preferences' )
231 ->getFullURL( '', false, PROTO_CANONICAL
) . '>';
233 // Line endings need to be different on Unix and Windows due to
234 // the bug described at http://trac.wordpress.org/ticket/2603
235 if ( wfIsWindows() ) {
241 if ( is_array( $body ) ) {
242 // we are sending a multipart message
243 wfDebug( "Assembling multipart mime email\n" );
244 if ( !stream_resolve_include_path( 'Mail/mime.php' ) ) {
245 wfDebug( "PEAR Mail_Mime package is not installed. Falling back to text email.\n" );
246 // remove the html body for text email fall back
247 $body = $body['text'];
249 // Check if pear/mail_mime is already loaded (via composer)
250 if ( !class_exists( 'Mail_mime' ) ) {
251 require_once 'Mail/mime.php';
253 if ( wfIsWindows() ) {
254 $body['text'] = str_replace( "\n", "\r\n", $body['text'] );
255 $body['html'] = str_replace( "\n", "\r\n", $body['html'] );
257 $mime = new Mail_mime( array(
259 'text_charset' => 'UTF-8',
260 'html_charset' => 'UTF-8'
262 $mime->setTXTBody( $body['text'] );
263 $mime->setHTMLBody( $body['html'] );
264 $body = $mime->get(); // must call get() before headers()
265 $headers = $mime->headers( $headers );
268 if ( $mime === null ) {
269 // sending text only, either deliberately or as a fallback
270 if ( wfIsWindows() ) {
271 $body = str_replace( "\n", "\r\n", $body );
273 $headers['MIME-Version'] = '1.0';
274 $headers['Content-type'] = ( is_null( $contentType ) ?
275 'text/plain; charset=UTF-8' : $contentType );
276 $headers['Content-transfer-encoding'] = '8bit';
279 $ret = Hooks
::run( 'AlternateUserMailer', array( $headers, $to, $from, $subject, $body ) );
280 if ( $ret === false ) {
281 // the hook implementation will return false to skip regular mail sending
282 return Status
::newGood();
283 } elseif ( $ret !== true ) {
284 // the hook implementation will return a string to pass an error message
285 return Status
::newFatal( 'php-mail-error', $ret );
288 if ( is_array( $wgSMTP ) ) {
289 // Check if pear/mail is already loaded (via composer)
290 if ( !class_exists( 'Mail' ) ) {
292 if ( !stream_resolve_include_path( 'Mail.php' ) ) {
293 throw new MWException( 'PEAR mail package is not installed' );
295 require_once 'Mail.php';
298 MediaWiki\
suppressWarnings();
300 // Create the mail object using the Mail::factory method
301 $mail_object =& Mail
::factory( 'smtp', $wgSMTP );
302 if ( PEAR
::isError( $mail_object ) ) {
303 wfDebug( "PEAR::Mail factory failed: " . $mail_object->getMessage() . "\n" );
304 MediaWiki\restoreWarnings
();
305 return Status
::newFatal( 'pear-mail-error', $mail_object->getMessage() );
308 wfDebug( "Sending mail via PEAR::Mail\n" );
310 $headers['Subject'] = self
::quotedPrintable( $subject );
312 // When sending only to one recipient, shows it its email using To:
313 if ( count( $to ) == 1 ) {
314 $headers['To'] = $to[0]->toString();
317 // Split jobs since SMTP servers tends to limit the maximum
318 // number of possible recipients.
319 $chunks = array_chunk( $to, $wgEnotifMaxRecips );
320 foreach ( $chunks as $chunk ) {
321 $status = self
::sendWithPear( $mail_object, $chunk, $headers, $body );
322 // FIXME : some chunks might be sent while others are not!
323 if ( !$status->isOK() ) {
324 MediaWiki\restoreWarnings
();
328 MediaWiki\restoreWarnings
();
329 return Status
::newGood();
332 if ( count( $to ) > 1 ) {
333 $headers['To'] = 'undisclosed-recipients:;';
335 $headers = self
::arrayToHeaderString( $headers, $endl );
337 wfDebug( "Sending mail via internal mail() function\n" );
339 self
::$mErrorString = '';
340 $html_errors = ini_get( 'html_errors' );
341 ini_set( 'html_errors', '0' );
342 set_error_handler( 'UserMailer::errorHandler' );
345 $safeMode = wfIniGetBool( 'safe_mode' );
347 foreach ( $to as $recip ) {
349 $sent = mail( $recip, self
::quotedPrintable( $subject ), $body, $headers );
353 self
::quotedPrintable( $subject ),
360 } catch ( Exception
$e ) {
361 restore_error_handler();
365 restore_error_handler();
366 ini_set( 'html_errors', $html_errors );
368 if ( self
::$mErrorString ) {
369 wfDebug( "Error sending mail: " . self
::$mErrorString . "\n" );
370 return Status
::newFatal( 'php-mail-error', self
::$mErrorString );
371 } elseif ( !$sent ) {
372 // mail function only tells if there's an error
373 wfDebug( "Unknown error sending mail\n" );
374 return Status
::newFatal( 'php-mail-error-unknown' );
376 return Status
::newGood();
382 * Set the mail error message in self::$mErrorString
384 * @param int $code Error number
385 * @param string $string Error message
387 static function errorHandler( $code, $string ) {
388 self
::$mErrorString = preg_replace( '/^mail\(\)(\s*\[.*?\])?: /', '', $string );
392 * Strips bad characters from a header value to prevent PHP mail header injection attacks
393 * @param string $val String to be santizied
396 public static function sanitizeHeaderValue( $val ) {
397 return strtr( $val, array( "\r" => '', "\n" => '' ) );
401 * Converts a string into a valid RFC 822 "phrase", such as is used for the sender name
402 * @param string $phrase
405 public static function rfc822Phrase( $phrase ) {
406 // Remove line breaks
407 $phrase = self
::sanitizeHeaderValue( $phrase );
409 $phrase = str_replace( '"', '', $phrase );
410 return '"' . $phrase . '"';
414 * Converts a string into quoted-printable format
417 * From PHP5.3 there is a built in function quoted_printable_encode()
418 * This method does not duplicate that.
419 * This method is doing Q encoding inside encoded-words as defined by RFC 2047
420 * This is for email headers.
421 * The built in quoted_printable_encode() is for email bodies
422 * @param string $string
423 * @param string $charset
426 public static function quotedPrintable( $string, $charset = '' ) {
427 // Probably incomplete; see RFC 2045
428 if ( empty( $charset ) ) {
431 $charset = strtoupper( $charset );
432 $charset = str_replace( 'ISO-8859', 'ISO8859', $charset ); // ?
434 $illegal = '\x00-\x08\x0b\x0c\x0e-\x1f\x7f-\xff=';
435 $replace = $illegal . '\t ?_';
436 if ( !preg_match( "/[$illegal]/", $string ) ) {
439 $out = "=?$charset?Q?";
440 $out .= preg_replace_callback( "/([$replace])/",
441 array( __CLASS__
, 'quotedPrintableCallback' ), $string );
446 protected static function quotedPrintableCallback( $matches ) {
447 return sprintf( "=%02X", ord( $matches[1] ) );