Documentation

Address
in package

FinalYes

RFC 5322 address - a single mailbox (optional display name + addr-spec).

Not a full RFC 5322 grammar: no groups, no obs-* forms - malformed or unusual input degrades to a bare address rather than throwing.

Tags
category

Pop

author

Nick Sagona, III nick@popphp.org

copyright

Copyright (c) 2009-2026 Nick Sagona, III

license

https://www.popphp.org/license New BSD License

version
3.0.0

Table of Contents

Properties

$address  : string
The addr-spec (e.g. "john@example.com"), kept as an opaque string
$name  : string|null
Display name, already RFC 2047-decoded

Methods

__construct()  : mixed
__toString()  : string
getAddress()  : string
getName()  : string|null
parse()  : Address
Parse a single address (no comma-splitting - see AddressList for multiple addresses). Never throws - malformed input (unbalanced or absent angle brackets) degrades to treating the whole string as a bare address.
render()  : string
setAddress()  : Address
setName()  : Address
needsQuoting()  : bool
renderName()  : string|null

Properties

$address

The addr-spec (e.g. "john@example.com"), kept as an opaque string

protected string $address

$name

Display name, already RFC 2047-decoded

protected string|null $name = null

Methods

__construct()

public __construct(string $address[, string|null $name = null ]) : mixed
Parameters
$address : string
$name : string|null = null

__toString()

public __toString() : string
Return values
string

getAddress()

public getAddress() : string
Return values
string

getName()

public getName() : string|null
Return values
string|null

parse()

Parse a single address (no comma-splitting - see AddressList for multiple addresses). Never throws - malformed input (unbalanced or absent angle brackets) degrades to treating the whole string as a bare address.

public static parse(string $text) : Address
Parameters
$text : string
Return values
Address

render()

public render() : string
Return values
string

setAddress()

public setAddress(string $address) : Address
Parameters
$address : string
Return values
Address

setName()

public setName(string|null $name) : Address
Parameters
$name : string|null
Return values
Address

needsQuoting()

protected static needsQuoting(string $name) : bool
Parameters
$name : string
Return values
bool

renderName()

protected static renderName(array<string|int, Token$tokens) : string|null
Parameters
$tokens : array<string|int, Token>
Return values
string|null

        
On this page

Search results