Address
in package
FinalYes
Tags
Table of Contents
Constants
- FROM_STRING_PATTERN = '~(?<displayName>[^<]*)<(?<addrSpec>.*)>[^>]*~'
- A regex that matches a structure like 'Name <email@address.com>'.
Properties
- $address : string
- $encoder : IdnAddressEncoder
- $name : string
- $validator : EmailValidator
Methods
- __construct() : mixed
- create() : self
- createArray() : array<string|int, Address>
- getAddress() : string
- getEncodedAddress() : string
- getEncodedName() : string
- getName() : string
- toString() : string
Constants
FROM_STRING_PATTERN
A regex that matches a structure like 'Name <email@address.com>'.
private
mixed
FROM_STRING_PATTERN
= '~(?<displayName>[^<]*)<(?<addrSpec>.*)>[^>]*~'
It matches anything between the first < and last > as email address. This allows to use a single string to construct an Address, which can be convenient to use in config, and allows to have more readable config. This does not try to cover all edge cases for address.
Properties
$address
private
string
$address
$encoder
private
static IdnAddressEncoder
$encoder
$name
private
string
$name
$validator
private
static EmailValidator
$validator
Methods
__construct()
public
__construct(string $address[, string $name = '' ]) : mixed
Parameters
- $address : string
- $name : string = ''
create()
public
static create(self|string $address) : self
Parameters
- $address : self|string
Return values
selfcreateArray()
public
static createArray(array<string|int, Address|string> $addresses) : array<string|int, Address>
Parameters
- $addresses : array<string|int, Address|string>
Return values
array<string|int, Address>getAddress()
public
getAddress() : string
Return values
stringgetEncodedAddress()
public
getEncodedAddress() : string
Return values
stringgetEncodedName()
public
getEncodedName() : string
Return values
stringgetName()
public
getName() : string
Return values
stringtoString()
public
toString() : string