ccd423225f
In PHP 8, but not in PHP 7.4, every class with a __toString() function implicitly implements the Stringable interface. Therefore, the behavior of checks like "instanceof Stringable" differs between these PHP versions when such classes are involved. Make every such class implement the interface so that the behavior will be consistent. The PHP 7.4 fallback for the Stringable interface is provided by symfony/polyfill-php80. Change-Id: I3f0330c2555c7d3bf99b654ed3c0b0303e257ea1
107 lines
3 KiB
PHP
107 lines
3 KiB
PHP
<?php
|
|
/**
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
*
|
|
* @file
|
|
* @author Brooke Vibber
|
|
* @author <mail@tgries.de>
|
|
* @author Tim Starling
|
|
* @author Luke Welling lwelling@wikimedia.org
|
|
*/
|
|
|
|
use MediaWiki\Mail\UserEmailContact;
|
|
|
|
/**
|
|
* Represent and format a single name and email address pair for SMTP.
|
|
*
|
|
* Used by Emailer, e.g. via EmailUser or EmailNotification.
|
|
*
|
|
* @newable
|
|
* @since 1.6.0
|
|
* @ingroup Mail
|
|
*/
|
|
class MailAddress implements Stringable {
|
|
|
|
public string $name;
|
|
public string $realName;
|
|
public string $address;
|
|
|
|
/**
|
|
* @stable to call
|
|
* @since 1.6.0
|
|
* @param string $address String with an email address
|
|
* @param string|null $name Human-readable name if a string address is given
|
|
* @param string|null $realName Human-readable real name if a string address is given
|
|
*/
|
|
public function __construct( $address, $name = null, $realName = null ) {
|
|
$this->address = strval( $address );
|
|
$this->name = strval( $name );
|
|
$this->realName = strval( $realName );
|
|
}
|
|
|
|
/**
|
|
* @since 1.24
|
|
* @param UserEmailContact $user
|
|
* @return MailAddress
|
|
*/
|
|
public static function newFromUser( UserEmailContact $user ) {
|
|
return new MailAddress( $user->getEmail(), $user->getUser()->getName(), $user->getRealName() );
|
|
}
|
|
|
|
/**
|
|
* @since 1.40
|
|
* @param self $other
|
|
* @return bool
|
|
*/
|
|
public function equals( self $other ): bool {
|
|
return $this->address === $other->address &&
|
|
$this->name === $other->name &&
|
|
$this->realName === $other->realName;
|
|
}
|
|
|
|
/**
|
|
* Format and quote address for insertion in SMTP headers
|
|
*
|
|
* @since 1.6.0
|
|
* @return string
|
|
*/
|
|
public function toString() {
|
|
if ( !$this->address ) {
|
|
return '';
|
|
}
|
|
|
|
# PHP's mail() implementation under Windows is somewhat shite, and
|
|
# can't handle "Joe Bloggs <joe@bloggs.com>" format email addresses,
|
|
# so don't bother generating them
|
|
if ( $this->name === '' || wfIsWindows() ) {
|
|
return $this->address;
|
|
}
|
|
|
|
global $wgEnotifUseRealName;
|
|
$name = ( $wgEnotifUseRealName && $this->realName !== '' ) ? $this->realName : $this->name;
|
|
$quoted = UserMailer::quotedPrintable( $name );
|
|
// Must only be quoted if string does not use =? encoding (T191931)
|
|
if ( $quoted === $name ) {
|
|
$quoted = '"' . addslashes( $quoted ) . '"';
|
|
}
|
|
|
|
return "$quoted <{$this->address}>";
|
|
}
|
|
|
|
public function __toString() {
|
|
return $this->toString();
|
|
}
|
|
}
|