Represent and format a single name and email address pair for SMTP. More...

Inherits Stringable.

Collaboration diagram for MediaWiki\Mail\MailAddress:

Public Member Functions
	__construct (public string $address, ?string $name=null, ?string $realName=null,)

	__toString ()

	equals (self $other)

	toString ()
	Format and quote address for insertion in SMTP headers.

Static Public Member Functions
static	newFromUser (UserEmailContact $user)

Public Attributes
string	$name

string	$realName

Detailed Description

Represent and format a single name and email address pair for SMTP.

Used by Emailer, e.g. via EmailUser.

Stability: newable

Since: 1.6.0

Definition at line 24 of file MailAddress.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Mail\MailAddress::__construct	(	public string	$address,
		?string	$name = null,
		?string	$realName = null )

Stability: stable: to call

Parameters

string	$address	String with an email address
string \| null	$name	Human-readable name if a string address is given
string \| null	$realName	Human-readable real name if a string address is given

Definition at line 35 of file MailAddress.php.

References MediaWiki\Mail\MailAddress\$name, and MediaWiki\Mail\MailAddress\$realName.

Member Function Documentation

◆ __toString()

MediaWiki\Mail\MailAddress::__toString ( )

Definition at line 85 of file MailAddress.php.

◆ equals()

MediaWiki\Mail\MailAddress::equals ( self $other )

Since: 1.40

Definition at line 54 of file MailAddress.php.

◆ newFromUser()

static MediaWiki\Mail\MailAddress::newFromUser ( UserEmailContact $user )

static

Since: 1.24

Definition at line 47 of file MailAddress.php.

◆ toString()

MediaWiki\Mail\MailAddress::toString ( )

Format and quote address for insertion in SMTP headers.

Definition at line 63 of file MailAddress.php.

Referenced by MediaWiki\Mail\UserMailer\sendInternal().

Member Data Documentation

◆ $name

string MediaWiki\Mail\MailAddress::$name

Definition at line 26 of file MailAddress.php.

Referenced by MediaWiki\Mail\MailAddress\__construct().

◆ $realName

string MediaWiki\Mail\MailAddress::$realName

Definition at line 27 of file MailAddress.php.