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 * Stores a single person's name and email address.
29 * These are passed in via the constructor, and will be returned in SMTP
30 * header format when requested.
49 * @param string $address String with an email address, or a User object
50 * @param string $name Human-readable name if a string address is given
51 * @param string $realName Human-readable real name if a string address is given
53 function __construct( $address, $name = null, $realName = null ) {
54 if ( is_object( $address ) && $address instanceof User
) {
55 // Old calling format, now deprecated
56 wfDeprecated( __METHOD__
. ' with a User object', '1.24' );
57 $this->address
= $address->getEmail();
58 $this->name
= $address->getName();
59 $this->realName
= $address->getRealName();
61 $this->address
= strval( $address );
62 $this->name
= strval( $name );
63 $this->realName
= strval( $realName );
68 * Create a new MailAddress object for the given user
74 public static function newFromUser( User
$user ) {
75 return new MailAddress( $user->getEmail(), $user->getName(), $user->getRealName() );
79 * Return formatted and quoted address to insert into SMTP headers
83 # PHP's mail() implementation under Windows is somewhat shite, and
84 # can't handle "Joe Bloggs <joe@bloggs.com>" format email addresses,
85 # so don't bother generating them
86 if ( $this->address
) {
87 if ( $this->name
!= '' && !wfIsWindows() ) {
88 global $wgEnotifUseRealName;
89 $name = ( $wgEnotifUseRealName && $this->realName
!== '' ) ?
$this->realName
: $this->name
;
90 $quoted = UserMailer
::quotedPrintable( $name );
91 // Must only be quoted if string does not use =? encoding (T191931)
92 if ( $quoted === $name ) {
93 $quoted = '"' . addslashes( $quoted ) . '"';
95 return "$quoted <{$this->address}>";
97 return $this->address
;
104 function __toString() {
105 return $this->toString();