1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
|
<?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();
}
}
|
