MediaWiki  master
MailAddress Class Reference

Stores a single person's name and email address. More...

Public Member Functions

 __construct ( $address, $name=null, $realName=null)
 
 __toString ()
 
 toString ()
 Return formatted and quoted address to insert into SMTP headers. More...
 

Static Public Member Functions

static newFromUser (User $user)
 Create a new MailAddress object for the given user. More...
 

Public Attributes

string $address
 
string $name
 
string $realName
 

Detailed Description

Stores a single person's name and email address.

These are passed in via the constructor, and will be returned in SMTP header format when requested.

Definition at line 32 of file MailAddress.php.

Constructor & Destructor Documentation

◆ __construct()

MailAddress::__construct (   $address,
  $name = null,
  $realName = null 
)
Parameters
string$addressString with an email address
string | null$nameHuman-readable name if a string address is given
string | null$realNameHuman-readable real name if a string address is given

Definition at line 53 of file MailAddress.php.

Member Function Documentation

◆ __toString()

MailAddress::__toString ( )

Definition at line 97 of file MailAddress.php.

References toString().

◆ newFromUser()

static MailAddress::newFromUser ( User  $user)
static

Create a new MailAddress object for the given user.

Since
1.24
Parameters
User$user
Returns
MailAddress

Definition at line 66 of file MailAddress.php.

References User\getEmail(), User\getName(), and User\getRealName().

Referenced by EmailNotification\compose(), EmailNotification\composeCommonMailtext(), User\sendMail(), EmailNotification\sendPersonalised(), and SpecialEmailUser\submit().

◆ toString()

MailAddress::toString ( )

Return formatted and quoted address to insert into SMTP headers.

Returns
string

Definition at line 74 of file MailAddress.php.

References $address, $wgEnotifUseRealName, UserMailer\quotedPrintable(), and wfIsWindows().

Referenced by __toString(), and UserMailer\sendInternal().

Member Data Documentation

◆ $address

string MailAddress::$address

Definition at line 46 of file MailAddress.php.

Referenced by toString().

◆ $name

string MailAddress::$name

Definition at line 36 of file MailAddress.php.

◆ $realName

string MailAddress::$realName

Definition at line 41 of file MailAddress.php.


The documentation for this class was generated from the following file: